X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=29481e718231e808c10687766285f5fe86b3709d;hp=b60731ad569c3bed4c2569d5ef22a30a2bb57399;hb=957eb8cab28dc83aa4b800d033031e53cd0a9e00;hpb=e1ea662c3393f479312436fc2d50ebd30f2466ef diff --git a/man/systemctl.xml b/man/systemctl.xml index b60731ad5..29481e718 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -8,16 +8,16 @@ Copyright 2010 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. systemd is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> @@ -197,6 +197,14 @@ enqueued. + + + + Do not print a legend, i.e. + the column headers and the footer with hints. + + + @@ -291,11 +299,13 @@ systemctl will query the user on the terminal for the necessary secrets. Use this option to - switch this behavior off. In this - case the password must be supplied by - some other means (for example - graphical password agents) or the - service might fail. + switch this behavior off. In this case + the password must be supplied by some + other means (for example graphical + password agents) or the service might + fail. This also disables querying the + user for authentication for privileged + operations. @@ -341,37 +351,49 @@ halt, poweroff, reboot or - kexec execute + kexec execute the selected operation without shutting down all units. However, all processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a drastic but relatively safe option to request an - immediate reboot. + immediate reboot. If + is specified + twice for these operations, they will + be executed immediately without + terminating any processes or umounting + any file systems. Warning: specifying + twice with + any of these operations might result + in data loss. - + When used with - disable, ensures - that only the symlinks created by - enable are removed, - not all symlinks pointing to the unit - file that shall be - disabled. + enable/disable/is-enabled (and + related commands), use alternative + root path when looking for unit + files. - + When used with - enable/ - disable/ - is-enabled, - use alternative root path for systemd - install. + enable/disable/is-enabled (and related commands), make + changes only temporarily, so that they + are dropped on the next reboot. This + will have the effect that changes are + not made in subdirectories of + /etc but in + /run, with + identical immediate effects, however, + since the latter is lost on reboot, + the changes are lost + too. @@ -394,6 +416,45 @@ PolicyKit before executing the operation. + + + + + + When used with + status controls the + number of journal lines to show, + counting from the most recent + ones. Takes a positive integer + argument. Defaults to + 10. + + + + + + + When used with + status continously + prints new journal entries as they are + appended to the + journal. + + + + + + + When used with + status controls the + formatting of the journal entries that + are shown. For the available choices + see + journalctl1. Defaults + to + short. + + The following commands are understood: @@ -538,14 +599,15 @@ Show terse runtime status information about one or more - units. This function is intended to - generate human-readable output. If you - are looking for computer-parsable - output, use show - instead. If a PID is passed - information about the unit the process - of the PID belongs to is - shown. + units, followed by its most recent log + data from the journal. This function + is intended to generate human-readable + output. If you are looking for + computer-parsable output, use + show instead. If a + PID is passed information about the + unit the process of the PID belongs to + is shown. show [NAME...|JOB...] @@ -590,6 +652,13 @@ command. + + list-unit-files + + List installed unit files. + + + enable [NAME...] @@ -674,14 +743,11 @@ configuration directory, and hence undoes the changes made by enable. Note - however that this by default removes + however that this removes all symlinks to the unit files (i.e. including manual additions), not just those actually created by - enable. If only the - symlinks that are suggested by default - shall be removed, pass - . This + enable. This call implicitly reloads the systemd daemon configuration after completing the disabling of the units. Note that this @@ -713,8 +779,85 @@ (as with enable). Returns an exit code of 0 if at least one is - enabled, non-zero - otherwise. + enabled, non-zero otherwise. Prints + the current enable status. To suppress + this output use + . + + + + reenable [NAME...] + + Reenable one or more + unit files, as specified on the + command line. This is a combination of + disable and + enable and is + useful to reset the symlinks a unit is + enabled with to the defaults + configured in the + [Install] section + of the unit file. + + + + + preset [NAME...] + + Reset one or more unit + files, as specified on the command + line, to the defaults configured in a + preset file. This has the same effect + as disable or + enable, depending + how the unit is listed in the preset + files. + + + + + mask [NAME...] + + Mask one or more unit + files, as specified on the command + line. This will link these units to + /dev/null, making + it impossible to start them. This is a stronger version + of disable, since + it prohibits all kinds of activation + of the unit, including manual + activation. Use this option with + care. + + + + + unmask [NAME...] + + Unmask one or more + unit files, as specified on the + command line. This will undo the + effect of + mask. + + + + + link [NAME...] + + Link a unit file that + is not in the unit file search paths + into the unit file search path. This + requires an absolute path to a unit + file. The effect of this can be undone + with disable. The + effect of this command is that a unit + file is available for + start and other + commands although it isn't installed + directly in the unit search + path. + @@ -924,14 +1067,19 @@ system. This is mostly equivalent to start halt.target but also prints a wall message to all - users. If - combined with - shutdown of all running services is - skipped, however all processes are killed - and all file systems are unmounted or + users. If combined with + shutdown of + all running services is skipped, + however all processes are killed and + all file systems are unmounted or mounted read-only, immediately - followed by the - system halt. + followed by the system halt. If + is specified + twice the the operation is immediately + executed without terminating any + processes or unmounting any file + systems. This may result in data + loss. poweroff @@ -940,32 +1088,40 @@ power-off the system. This is mostly equivalent to start poweroff.target but also - prints a wall message to all - users. If + prints a wall message to all users. If combined with shutdown of all running services is - skipped, however all processes are killed - and all file systems are unmounted or - mounted read-only, immediately - followed by the - powering off. + skipped, however all processes are + killed and all file systems are + unmounted or mounted read-only, + immediately followed by the powering + off. If is + specified twice the the operation is + immediately executed without + terminating any processes or + unmounting any file systems. This may + result in data loss. reboot - Shut down and - reboot the system. This is mostly - equivalent to start + Shut down and reboot + the system. This is mostly equivalent + to start reboot.target but also - prints a wall message to all - users. If + prints a wall message to all users. If combined with shutdown of all running services is - skipped, however all processes are killed - and all file systems are unmounted or - mounted read-only, immediately - followed by the - reboot. + skipped, however all processes are + killed and all file systems are + unmounted or mounted read-only, + immediately followed by the reboot. If + is specified + twice the the operation is immediately + executed without terminating any + processes or unmounting any file + systems. This may result in data + loss. kexec @@ -993,6 +1149,43 @@ option) and will fail otherwise. + + suspend + + Suspend the system. + + + hibernate + + Hibernate the system. + + + switch-root [ROOT] [INIT] + + Switches to a + different root directory and executes + a new system manager process below + it. This is intended for usage in + initial RAM disks ("initrd"), and will + transition from the initrd's system + manager process (a.k.a "init" process) + to the main system manager + process. Takes two arguments: the + directory to make the new root + directory, and the path to the new + system manager binary below it to + execute as PID 1. If the latter is + ommitted or the empty string, a + systemd binary will automatically be + searched for and used as init. If the + system manager path is ommitted or + equal the empty string the state of + the initrd's system manager process is + passed to the main system manager, + which allows later introspection of the + state of the services involved in the + initrd boot. + @@ -1025,7 +1218,8 @@ systemd1, systemadm1, - systemd-loginctl1, + journalctl1, + loginctl1, systemd.unit5, systemd.special7, wall1