From 7e2c6c74cf2f997cf51a7b898a9b98a070a66111 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Fri, 16 Feb 2024 16:09:46 +0100 Subject: [PATCH] vmspawn: rework --help In this context, "VM" doesn't need explaining. Make the texts more precise and try to make them fit in one line. Help output is much easier to read when it's not wrapped. --- src/vmspawn/vmspawn.c | 61 ++++++++++++++++++++----------------------- 1 file changed, 28 insertions(+), 33 deletions(-) diff --git a/src/vmspawn/vmspawn.c b/src/vmspawn/vmspawn.c index 5e582079c7c..07ea2abd3a8 100644 --- a/src/vmspawn/vmspawn.c +++ b/src/vmspawn/vmspawn.c @@ -112,52 +112,47 @@ static int help(void) { printf("%1$s [OPTIONS...] [ARGUMENTS...]\n\n" "%5$sSpawn a command or OS in a virtual machine.%6$s\n\n" - " -h --help Show this help\n" - " --version Print version string\n" - " -q --quiet Do not show status information\n" - " --no-pager Do not pipe output into a pager\n" + " -h --help Show this help\n" + " --version Print version string\n" + " -q --quiet Do not show status information\n" + " --no-pager Do not pipe output into a pager\n" "\n%3$sImage:%4$s\n" - " -D --directory=PATH Root directory for the container\n" - " -i --image=PATH Root file system disk image (or device node) for\n" - " the virtual machine\n" + " -D --directory=PATH Root directory for the VM\n" + " -i --image=FILE|DEVICE Root file system disk image or device for the VM\n" "\n%3$sHost Configuration:%4$s\n" - " --qemu-smp=SMP Configure guest's SMP settings\n" - " --qemu-mem=MEM Configure guest's RAM size\n" - " --qemu-kvm=BOOL Configure whether to use KVM or not\n" - " --qemu-vsock=BOOL Configure whether to use qemu with a vsock or not\n" - " --vsock-cid= Specify the CID to use for the qemu guest's vsock\n" - " --tpm=BOOL Configure whether to use a virtual TPM or not\n" - " --linux=PATH Specify the linux kernel for direct kernel boot\n" - " --initrd=PATH Specify the initrd for direct kernel boot\n" - " --qemu-gui Start QEMU in graphical mode\n" - " -n --network-tap Create a TAP device for networking with QEMU.\n" - " --network-user-mode Use user mode networking with QEMU.\n" - " --secure-boot=BOOL Configure whether to search for firmware which\n" - " supports Secure Boot\n" - " --firmware=PATH|list Select firmware definition file (or list available)\n" + " --qemu-smp=SMP Configure guest's SMP settings\n" + " --qemu-mem=MEM Configure guest's RAM size\n" + " --qemu-kvm=BOOL Enable use of KVM\n" + " --qemu-vsock=BOOL Override autodetection of VSock support in QEMU\n" + " --vsock-cid=CID Specify the CID to use for the qemu guest's VSock\n" + " --tpm=BOOL Enable use of a virtual TPM\n" + " --linux=PATH Specify the linux kernel for direct kernel boot\n" + " --initrd=PATH Specify the initrd for direct kernel boot\n" + " --qemu-gui Start QEMU in graphical mode\n" + " -n --network-tap Create a TAP device for networking with QEMU\n" + " --network-user-mode Use user mode networking with QEMU\n" + " --secure-boot=BOOL Enable searching for firmware supporting SecureBoot\n" + " --firmware=PATH|list Select firmware definition file (or list available)\n" "\n%3$sSystem Identity:%4$s\n" - " -M --machine=NAME Set the machine name for the virtual machine\n" + " -M --machine=NAME Set the machine name for the VM\n" "\n%3$sUser Namespacing:%4$s\n" " --private-users=UIDBASE[:NUIDS]\n" - " Configure the UID/GID range to map into the\n" - " virtiofsd namespace\n" + " Configure the UID/GID range to map into the\n" + " virtiofsd namespace\n" "\n%3$sMounts:%4$s\n" " --bind=SOURCE[:TARGET]\n" - " Mount a file or directory from the host into\n" - " the VM.\n" + " Mount a file or directory from the host into the VM\n" " --bind-ro=SOURCE[:TARGET]\n" - " Similar, but creates a read-only mount\n" + " Mount a file or directory, but read-only\n" "\n%3$sIntegration:%4$s\n" " --forward-journal=FILE|DIR\n" - " Forward the virtual machine's journal entries to\n" - " the host.\n" + " Forward the VM's journal to the host\n" "\n%3$sCredentials:%4$s\n" " --set-credential=ID:VALUE\n" - " Pass a credential with literal value to the\n" - " virtual machine\n" + " Pass a credential with literal value to the VM\n" " --load-credential=ID:PATH\n" - " Load credential to pass to the virtual machine from\n" - " file or AF_UNIX stream socket.\n" + " Load credential for the VM from file or AF_UNIX\n" + " stream socket.\n" "\nSee the %2$s for details.\n", program_invocation_short_name, link, -- 2.47.3