nspawn: reorder --help text, and add section
The list is so long, let's add a bit of structure and order things a bit.
This commit is contained in:
Lennart Poettering
parent
2c9b7a7e62
commit
2514865391
|
|
@ -238,11 +238,13 @@ static int help(void) {
|
|||
if (r < 0)
|
||||
return log_oom();
|
||||
|
||||
printf("%s [OPTIONS...] [PATH] [ARGUMENTS...]\n\n"
|
||||
printf("%1$s [OPTIONS...] [PATH] [ARGUMENTS...]\n\n"
|
||||
"Spawn a command or OS in a light-weight container.\n\n"
|
||||
" -h --help Show this help\n"
|
||||
" --version Print version string\n"
|
||||
" -q --quiet Do not show status information\n"
|
||||
" --settings=BOOLEAN Load additional settings from .nspawn file\n\n"
|
||||
"%3$sImage:%4$s\n"
|
||||
" -D --directory=PATH Root directory for the container\n"
|
||||
" --template=PATH Initialize root directory from template directory,\n"
|
||||
" if missing\n"
|
||||
|
|
@ -250,22 +252,35 @@ static int help(void) {
|
|||
" remove it after exit\n"
|
||||
" -i --image=PATH File system device or disk image for the container\n"
|
||||
" --oci-bundle=PATH OCI bundle directory\n"
|
||||
" --read-only Mount the root directory read-only\n"
|
||||
" --volatile[=MODE] Run the system in volatile mode\n"
|
||||
" --root-hash=HASH Specify verity root hash\n"
|
||||
" --pivot-root=PATH[:PATH]\n"
|
||||
" Pivot root to given directory in the container\n\n"
|
||||
"%3$sExecution:%4$s\n"
|
||||
" -a --as-pid2 Maintain a stub init as PID1, invoke binary as PID2\n"
|
||||
" -b --boot Boot up full system (i.e. invoke init)\n"
|
||||
" --chdir=PATH Set working directory in the container\n"
|
||||
" --pivot-root=PATH[:PATH]\n"
|
||||
" Pivot root to given directory in the container\n"
|
||||
" -u --user=USER Run the command under specified user or uid\n"
|
||||
" -E --setenv=NAME=VALUE Pass an environment variable to PID 1\n"
|
||||
" -u --user=USER Run the command under specified user or UID\n"
|
||||
" --kill-signal=SIGNAL Select signal to use for shutting down PID 1\n"
|
||||
" --notify-ready=BOOLEAN Receive notifications from the child init process\n\n"
|
||||
"%3$sSystem Identity:%4$s\n"
|
||||
" -M --machine=NAME Set the machine name for the container\n"
|
||||
" --hostname=NAME Override the hostname for the container\n"
|
||||
" --uuid=UUID Set a specific machine UUID for the container\n"
|
||||
" --uuid=UUID Set a specific machine UUID for the container\n\n"
|
||||
"%3$sProperties:%4$s\n"
|
||||
" -S --slice=SLICE Place the container in the specified slice\n"
|
||||
" --property=NAME=VALUE Set scope unit property\n"
|
||||
" --register=BOOLEAN Register container as machine\n"
|
||||
" --keep-unit Do not register a scope for the machine, reuse\n"
|
||||
" the service unit nspawn is running in\n\n"
|
||||
"%3$sUser Namespacing:%4$s\n"
|
||||
" -U --private-users=pick Run within user namespace, autoselect UID/GID range\n"
|
||||
" --private-users[=UIDBASE[:NUIDS]]\n"
|
||||
" Similar, but with user configured UID/GID range\n"
|
||||
" --private-users-chown Adjust OS tree ownership to private UID/GID range\n"
|
||||
" --private-users-chown Adjust OS tree ownership to private UID/GID range\n\n"
|
||||
"%3$sNetworking:%4$s\n"
|
||||
" --private-network Disable network in container\n"
|
||||
" --network-interface=INTERFACE\n"
|
||||
" Assign an existing network interface to the\n"
|
||||
|
|
@ -290,29 +305,31 @@ static int help(void) {
|
|||
" Set network namespace to the one represented by\n"
|
||||
" the specified kernel namespace file node\n"
|
||||
" -p --port=[PROTOCOL:]HOSTPORT[:CONTAINERPORT]\n"
|
||||
" Expose a container IP port on the host\n"
|
||||
" -Z --selinux-context=SECLABEL\n"
|
||||
" Set the SELinux security context to be used by\n"
|
||||
" processes in the container\n"
|
||||
" -L --selinux-apifs-context=SECLABEL\n"
|
||||
" Set the SELinux security context to be used by\n"
|
||||
" API/tmpfs file systems in the container\n"
|
||||
" Expose a container IP port on the host\n\n"
|
||||
"%3$sSecurity:%4$s\n"
|
||||
" --capability=CAP In addition to the default, retain specified\n"
|
||||
" capability\n"
|
||||
" --drop-capability=CAP Drop the specified capability from the default set\n"
|
||||
" --system-call-filter=LIST|~LIST\n"
|
||||
" Permit/prohibit specific system calls\n"
|
||||
" -Z --selinux-context=SECLABEL\n"
|
||||
" Set the SELinux security context to be used by\n"
|
||||
" processes in the container\n"
|
||||
" -L --selinux-apifs-context=SECLABEL\n"
|
||||
" Set the SELinux security context to be used by\n"
|
||||
" API/tmpfs file systems in the container\n\n"
|
||||
"%3$sResources:%4$s\n"
|
||||
" --rlimit=NAME=LIMIT Set a resource limit for the payload\n"
|
||||
" --oom-score-adjust=VALUE\n"
|
||||
" Adjust the OOM score value for the payload\n"
|
||||
" --cpu-affinity=CPUS Adjust the CPU affinity of the container\n"
|
||||
" --kill-signal=SIGNAL Select signal to use for shutting down PID 1\n"
|
||||
" --link-journal=MODE Link up guest journal, one of no, auto, guest, \n"
|
||||
" host, try-guest, try-host\n"
|
||||
" -j Equivalent to --link-journal=try-guest\n"
|
||||
" --cpu-affinity=CPUS Adjust the CPU affinity of the container\n\n"
|
||||
"%3$sIntegration:%4$s\n"
|
||||
" --resolv-conf=MODE Select mode of /etc/resolv.conf initialization\n"
|
||||
" --timezone=MODE Select mode of /etc/localtime initialization\n"
|
||||
" --read-only Mount the root directory read-only\n"
|
||||
" --link-journal=MODE Link up guest journal, one of no, auto, guest, \n"
|
||||
" host, try-guest, try-host\n"
|
||||
" -j Equivalent to --link-journal=try-guest\n\n"
|
||||
"%3$sMounts:%4$s\n"
|
||||
" --bind=PATH[:PATH[:OPTIONS]]\n"
|
||||
" Bind mount a file or directory from the host into\n"
|
||||
" the container\n"
|
||||
|
|
@ -325,21 +342,15 @@ static int help(void) {
|
|||
" Create an overlay mount from the host to \n"
|
||||
" the container\n"
|
||||
" --overlay-ro=PATH[:PATH...]:PATH\n"
|
||||
" Similar, but creates a read-only overlay mount\n"
|
||||
" -E --setenv=NAME=VALUE Pass an environment variable to PID 1\n"
|
||||
" --register=BOOLEAN Register container as machine\n"
|
||||
" --keep-unit Do not register a scope for the machine, reuse\n"
|
||||
" the service unit nspawn is running in\n"
|
||||
" --volatile[=MODE] Run the system in volatile mode\n"
|
||||
" --settings=BOOLEAN Load additional settings from .nspawn file\n"
|
||||
" --notify-ready=BOOLEAN Receive notifications from the child init process\n"
|
||||
" Similar, but creates a read-only overlay mount\n\n"
|
||||
"%3$sInput/Output:%4$s\n"
|
||||
" --console=MODE Select how stdin/stdout/stderr and /dev/console are\n"
|
||||
" set up for the container.\n"
|
||||
" -P --pipe Equivalent to --console=pipe\n"
|
||||
"\nSee the %s for details.\n"
|
||||
"\nSee the %2$s for details.\n"
|
||||
, program_invocation_short_name
|
||||
, link
|
||||
);
|
||||
, ansi_underline(), ansi_normal());
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue