From 19887cd06a3af2f045e763986eda19e208bd3f85 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Sat, 6 Jul 2013 22:22:05 -0400 Subject: [PATCH 1/1] man: document machinectl and systemd-machined --- Makefile-man.am | 14 +- man/loginctl.xml | 9 +- man/machinectl.xml | 301 +++++++++++++++++++++++++++++++ man/systemctl.xml | 19 +- man/systemd-logind.service.xml | 10 +- man/systemd-machined.service.xml | 76 ++++++++ src/machine/machinectl.c | 2 +- 7 files changed, 410 insertions(+), 21 deletions(-) create mode 100644 man/machinectl.xml create mode 100644 man/systemd-machined.service.xml diff --git a/Makefile-man.am b/Makefile-man.am index ba34d1e3d..fef69be58 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -654,6 +654,7 @@ endif if ENABLE_LOGIND MANPAGES += \ + man/loginctl.1 \ man/logind.conf.5 \ man/systemd-logind.service.8 MANPAGES_ALIAS += \ @@ -664,6 +665,18 @@ man/systemd-logind.html: man/systemd-logind.service.html endif +if ENABLE_MACHINED +MANPAGES += \ + man/machinectl.1 \ + man/systemd-machined.service.8 +MANPAGES_ALIAS += \ + man/systemd-machined.8 +man/systemd-machined.8: man/systemd-machined.service.8 +man/systemd-machined.html: man/systemd-machined.service.html + $(html-alias) + +endif + if ENABLE_QUOTACHECK MANPAGES += \ man/systemd-quotacheck.service.8 @@ -790,7 +803,6 @@ endif if HAVE_PAM MANPAGES += \ - man/loginctl.1 \ man/pam_systemd.8 \ man/sd-login.3 \ man/sd_get_seats.3 \ diff --git a/man/loginctl.xml b/man/loginctl.xml index b9db47598..e129d1b13 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -21,7 +21,7 @@ along with systemd; If not, see . --> - + loginctl @@ -49,7 +49,10 @@ - loginctl OPTIONS COMMAND NAME + loginctl + OPTIONS + COMMAND + NAME @@ -217,7 +220,7 @@ itself. If no argument is specified, properties of the manager will be shown. If a session ID is specified, - properties of the session is shown. By + properties of the session are shown. By default, empty properties are suppressed. Use to show those too. To select specific diff --git a/man/machinectl.xml b/man/machinectl.xml new file mode 100644 index 000000000..2606180d1 --- /dev/null +++ b/man/machinectl.xml @@ -0,0 +1,301 @@ + + + + + + + + + machinectl + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + machinectl + 1 + + + + machinectl + Control the systemd machine manager + + + + + machinectl + OPTIONS + COMMAND + NAME + + + + + Description + + machinectl may be used to + introspect and control the state of the + systemd1 + virtual machine and container registration manager systemd-machined.service8. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Prints a short version + string and exits. + + + + + + + When showing + session/user properties, limit + display to certain properties as + specified as argument. If not + specified, all set properties are + shown. The argument should be a + property name, such as + Name. If + specified more than once, all + properties with the specified names + are shown. + + + + + + + When showing + unit/job/manager properties, show all + properties regardless whether they are + set or not. + + + + + + + Do not ellipsize cgroup + members. + + + + + + + Do not pipe output into a + pager. + + + + + + Do not query the user + for authentication for privileged + operations. + + + + + + When used with + kill-session, + choose which processes to kill. Must + be one of , or + to select whether + to kill only the leader process of the + session or all processes of the + session. If omitted, defaults to + . + + + + + + + When used with + kill-session or + kill-user, choose + which signal to send to selected + processes. Must be one of the well + known signal specifiers, such as + SIGTERM, + SIGINT or + SIGSTOP. If + omitted, defaults to + SIGTERM. + + + + + + + Execute operation + remotely. Specify a hostname, or + username and hostname separated by @, + to connect to. This will use SSH to + talk to the remote machine manager + instance. + + + + + + + Acquire privileges via + PolicyKit before executing the + operation. + + + + The following commands are understood: + + + + list + + List currently running + virtual machines and containers. + + + + + status [ID...] + + Show terse runtime + status information about one or more + virtual machines and containers. This + function is intended to generate + human-readable output. If you are + looking for computer-parsable output, + use show instead. + + + + + show [ID...] + + Show properties of one + or more registered virtual machines or + containers or the manager itself. If + no argument is specified, properties + of the manager will be shown. If a an + ID is specified, properties of this + virtual machine or container are + shown. By default, empty properties + are suppressed. Use + to show those + too. To select specific properties to + show, use + . This + command is intended to be used + whenever computer-parsable output is + required. Use + status if you are + looking for formatted human-readable + output. + + + + terminate [ID...] + + Terminates a virtual + machine or container. This kills all + processes of the virtual machine or + container and deallocates all + resources attached to that + instance. + + + + kill [ID...] + + Send a signal to one + or more processes of the virtual + machine or container. This means + processes as seen by the host, not the + processes inside the virtual machine + or container. + Use to + select which process to kill. Use + to select + the signal to send. + + + + + + + Exit status + + On success, 0 is returned, a non-zero failure + code otherwise. + + + + Environment + + + + $SYSTEMD_PAGER + Pager to use when + is not given; + overrides $PAGER. Setting + this to an empty string or the value + cat is equivalent to passing + . + + + + + + See Also + + systemd-machined.service8, + systemd-logind.service8 + + + + diff --git a/man/systemctl.xml b/man/systemctl.xml index 632a26ded..07e7363ab 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -819,9 +819,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Show manual pages for one or more units, if - available. If a PID is passed the manual pages for the unit - the process of the PID belongs to is - shown. + available. If a PID is given the manual pages for the unit + the process belongs to are shown. @@ -859,13 +858,13 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service created the systemd configuration is reloaded (in a way that is equivalent to daemon-reload) to ensure the changes are taken into account immediately. Note that - this does not have the effect that any of the units enabled - are also started at the same time. If this is desired a - separate start command must be invoked - for the unit. Also note that in case of instance enablement, - symlinks named same as instances are created in install - location, however they all point to the same template unit - file. + this does not have the effect of also + starting starting any of the units beeing enabled. If this + is desired a separate start command must + be invoked for the unit. Also note that in case of instance + enablement, symlinks named same as instances are created in + install location, however they all point to the same + template unit file. This command will print the actions executed. This output may be suppressed by passing . diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml index 09bcfac43..c0c3d1a89 100644 --- a/man/systemd-logind.service.xml +++ b/man/systemd-logind.service.xml @@ -56,16 +56,14 @@ Description - systemd-logind is a system + systemd-logind is a system service that manages user logins. It is responsible for: - Keeping track of users and sessions, their - processes and their idle state - - Creating control groups for - user processes + Keeping track of users and + sessions, their processes and their idle + state Providing PolicyKit-based access for users to operations such as system diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml new file mode 100644 index 000000000..3094315ec --- /dev/null +++ b/man/systemd-machined.service.xml @@ -0,0 +1,76 @@ + + + + + + + + + systemd-machined.service + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-machined.service + 8 + + + + systemd-machined.service + systemd-machined + Virtual machine and container registartion manager + + + + systemd-machined.service + /usr/lib/systemd/systemd-machined + + + + Description + + systemd-machined is a + system service that keeps track of virtual machines + and containers, and processes belonging to + them. + + See systemd-nspawn1 for some examples how to + start a container the systemd way. + + + + See Also + + systemd1, + machinectl1. + + + + diff --git a/src/machine/machinectl.c b/src/machine/machinectl.c index 5d107f360..34bbe3610 100644 --- a/src/machine/machinectl.c +++ b/src/machine/machinectl.c @@ -514,7 +514,7 @@ static int help(void) { "Commands:\n" " list List running VMs and containers\n" " status [NAME...] Show VM/container status\n" - " show[NAME...] Show properties of one or more VMs/containers\n" + " show [NAME...] Show properties of one or more VMs/containers\n" " terminate [NAME...] Terminate one or more VMs/containers\n" " kill [NAME...] Send signal to processes of a VM/container\n", program_invocation_short_name); -- 2.30.2