X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=982051778ed835b117c051aa97e3d8ff37bbffc5;hp=39229a0075724f36ea6767d58a64a23860510615;hb=9b9b3d36b8ffe5b41c1455bffd44a9d11efc8aee;hpb=b85bdddafb321fa870b9250a2ff17040d6996061 diff --git a/man/systemctl.xml b/man/systemctl.xml index 39229a007..982051778 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -92,36 +92,42 @@ along with systemd; If not, see . - The argument should be a unit type name such as - and , or a - unit load state such as and - . + The argument should be a comma-separated list of unit + types such as and + . - If the argument is a unit type, when listing units, - limit display to certain unit types. If not specified units + If one of the arguments is a unit type, when listing + units, limit display to certain unit types. Otherwise, units of all types will be shown. - If the argument is a unit load state, when listing - units, limit display to certain unit types. If not specified - units of in all load states will be shown. - - As a special case, if the argument is + As a special case, if one of the arguments is , a list of allowed values will be printed and the program will exit. + + + + + Argument should be a comma-separated list of unit LOAD + or SUB or ACTIVE states. When listing units show only those + with specified LOAD or SUB or ACTIVE state. + + + - When showing unit/job/manager properties, limit - display to certain properties as specified as argument. If - not specified all set properties are shown. The argument - should be a comma-seperated list of property names, such as - MainPID. If specified more than once all + When showing unit/job/manager properties with the + show command, limit display to certain + properties as specified as argument. If not specified, all + set properties are shown. The argument should be a + comma-separated list of property names, such as + MainPID. If specified more than once, all properties with the specified names are shown. @@ -131,23 +137,40 @@ along with systemd; If not, see . - When listing units, show all units, regardless of - their state, including inactive units. When showing + When listing units, show all loaded units, regardless + of their state, including inactive units. When showing unit/job/manager properties, show all properties regardless whether they are set or not. + To list all units installed on the system, use the + list-unit-files command instead. - + - When listing units, show only failed units. Do not - confuse with . + Show reverse dependencies between units with + list-dependencies, i.e. units with + dependencies of type Wants= or + Requires= on the given unit. + + + + + + Show which units are started after or before + with list-dependencies, respectively. + + + + + + @@ -163,13 +186,21 @@ along with systemd; If not, see . If the requested operation conflicts with a pending - unfinished job, fail the command. If this is not specified + unfinished job, fail the command. If this is not specified, the requested operation will replace the pending job, if necessary. Do not confuse with . + + + + + When showing sockets, show the type of the socket. + + + @@ -185,8 +216,8 @@ along with systemd; If not, see . - When enqueuing a new job ignore all its dependencies - and execute it immediately. If passed no required units of + When enqueuing a new job, ignore all its dependencies + and execute it immediately. If passed, no required units of the unit passed will be pulled in, and no ordering dependencies will be honored. This is mostly a debugging and rescue tool for the administrator and should not be used by @@ -206,9 +237,9 @@ along with systemd; If not, see . sleep state. Any user may take these locks and privileged users may override these locks. If any locks are taken, shutdown and sleep state requests will normally fail - (regardless if privileged or not) and list of active locks - is printed. However if - is specified the locks are ignored and not printed, and the + (regardless if privileged or not) and a list of active locks + is printed. However, if + is specified, the locks are ignored and not printed, and the operation attempted anyway, possibly requiring additional privileges. @@ -233,9 +264,9 @@ along with systemd; If not, see . Do not synchronously wait for the requested operation - to finish. If this is not specified the job will be + to finish. If this is not specified, the job will be verified, enqueued and systemctl will - wait until it is completed. By passing this argument it is + wait until it is completed. By passing this argument, it is only verified and enqueued. @@ -278,7 +309,7 @@ along with systemd; If not, see . - Don't send wall message before halt, power-off, + Do not send wall message before halt, power-off, reboot. @@ -313,10 +344,10 @@ along with systemd; If not, see . may require input of a password or passphrase string, for example to unlock system hard disks or cryptographic certificates. Unless this option is specified and the - command is invoked from a terminal + command is invoked from a terminal, 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 + 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 @@ -333,7 +364,7 @@ along with systemd; If not, see . processes to kill. Must be one of , or to select whether to kill only the main process of the unit, the - control process or all processes of the unit. If omitted + control process or all processes of the unit. If omitted, defaults to . @@ -346,8 +377,8 @@ along with systemd; If not, see . When used with kill, 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 + well known signal specifiers such as SIGTERM, SIGINT or + SIGSTOP. If omitted, defaults to . @@ -362,7 +393,7 @@ along with systemd; If not, see . When used with halt, poweroff, reboot or - kexec execute the selected operation + 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 @@ -392,14 +423,22 @@ along with systemd; If not, see . - When used with - enable/disable/is-enabled + When used with enable, + disable, is-enabled (and related commands), make changes only temporarily, so - that they are dropped on the next reboot. This will have the + that they are lost 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. + + Similar, when used with + set-cgroup-attr, + unset-cgroup-attr, + set-cgroup and + unset-cgroup, make changes only + temporarily, so that they are lost on the next + reboot. @@ -409,7 +448,7 @@ along with systemd; If not, see . Execute operation remotely. Specify a hostname, or - username and hostname separated by @, to connect to. This + username and hostname separated by @, to connect to. This will use SSH to talk to the remote systemd instance. @@ -430,7 +469,7 @@ along with systemd; If not, see . - When used with status controls the + 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. @@ -442,14 +481,23 @@ along with systemd; If not, see . - When used with status controls the + When used with status, controls the formatting of the journal entries that are shown. For the - available choices see + available choices, see journalctl1. Defaults to short. + + + + + When used with list-dependencies, + the output is printed as a list instead of a tree. + + + @@ -469,6 +517,44 @@ along with systemd; If not, see . This is the default command. + + + list-sockets + + + List socket units ordered by the listening address. Produces output + similar to + +LISTEN UNIT ACTIVATES +/dev/initctl systemd-initctl.socket systemd-initctl.service +... +[::]:22 sshd.socket sshd.service +kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service + +5 sockets listed. + + Note: because the addresses might contains spaces, this output + is not suitable for programmatic consumption. + + + See also the options , + , and . + + + + + set-log-level LEVEL + + + Change current log level of the + systemd daemon to + LEVEL (accepts the same values + as described in + systemd1). + + + + start NAME... @@ -498,7 +584,7 @@ along with systemd; If not, see . for the example case of Apache, this will reload Apache's httpd.conf in the web server, not the apache.service systemd unit - file. + file. This command should not be confused with the daemon-reload or load @@ -511,7 +597,7 @@ along with systemd; If not, see . Restart one or more units specified on the command - line. If the units are not running yet they will be + line. If the units are not running yet, they will be started. @@ -520,9 +606,9 @@ along with systemd; If not, see . Restart one or more units specified on the command - line if the units are running. Do nothing if units are not - running. Note that for compatibility with Red Hat init - scripts condrestart is equivalent to this + line if the units are running. This does nothing if units are not + running. Note that, for compatibility with Red Hat init + scripts, condrestart is equivalent to this command. @@ -531,7 +617,7 @@ along with systemd; If not, see . Reload one or more units if they support it. If not, - restart them instead. If the units are not running yet they + restart them instead. If the units are not running yet, they will be started. @@ -540,8 +626,8 @@ along with systemd; If not, see . Reload one or more units if they support it. If not, - restart them instead. Do nothing if the units are not - running. Note that for compatibility with SysV init scripts + restart them instead. This does nothing if the units are not + running. Note that, for compatibility with SysV init scripts, force-reload is equivalent to this command. @@ -583,7 +669,7 @@ along with systemd; If not, see . Check whether any of the specified units are active (i.e. running). Returns an exit code 0 if at least one is active, non-zero otherwise. Unless - is specified this will also print the current unit state to + is specified, this will also print the current unit state to STDOUT. @@ -591,9 +677,9 @@ along with systemd; If not, see . is-failed NAME... - Check whether any of the specified units are failed. - Returns an exit code 0 if at least one is failed, non-zero - otherwise. Unless is specified this + Check whether any of the specified units are in a "failed" state. + Returns an exit code 0 if at least one has failed, non-zero + otherwise. Unless is specified, this will also print the current unit state to STDOUT. @@ -606,7 +692,7 @@ along with systemd; If not, see . more units, followed by most recent log data from the journal. If no units are specified, show all units (subject to limitations specified with ). If a PID - is passed show information about the unit the process + is passed, show information about the unit the process belongs to. This function is intended to generate human-readable @@ -631,25 +717,117 @@ along with systemd; If not, see . human-readable output. + + + get-cgroup-attr NAME ATTRIBUTE... + + + Retrieve the specified control group attributes of the + specified unit. Takes a unit name and one or more attribute + names such as cpu.shares. This will + output the current values of the specified attributes, + separated by new-lines. For attributes that take a list of + items, the output will be newline-separated, too. This + operation will always try to retrieve the data in question + from the kernel first, and if that is not available, use the + configured values instead. Instead of low-level control + group attribute names, high-level pretty names may be used, + as used for unit execution environment configuration, see + systemd.exec5 + for details. For example, passing + memory.limit_in_bytes and + MemoryLimit is equivalent. + + + + + set-cgroup-attr NAME ATTRIBUTE VALUE... + + + Set the specified control group attribute of the + specified unit to the specified value. Takes a unit + name and an attribute name such as + cpu.shares, plus one or more values + (multiple values may only be used for attributes that take + multiple values). This operation will immediately update the + kernel attribute for this unit and persistently store this + setting for later reboots (unless + is passed, in which case the setting is not saved + persistently and only valid until the next reboot.) Instead + of low-level control group attribute names, high-level pretty + names may be used, as used for unit execution environment + configuration, see + systemd.exec5 + for details. For example, passing + memory.limit_in_bytes and + MemoryLimit is equivalent. This operation + will implicitly create a control group for the unit in the + controller the attribute belongs to, if needed. For + attributes that take multiple values, this operation will + append the specified values to the previously set values + list (use unset-cgroup-attr to reset the + list explicitly). For attributes that take a single value + only, the list will be reset implicitly. + + + + + unset-cgroup-attr NAME ATTRIBUTE... + + Unset the specified control group attributes + of the specified unit. Takes a unit name and one or more + attribut names such as cpu.shares. This + operation might or might not have an immediate effect on the + current kernel attribute value. This will remove any + persistently stored configuration values for this attribute + (as set with set-cgroup-attr before), + unless is passed, in which case the + configuration is reset only until the next reboot. Again, + high-level control group attributes may be used instead of the + low-level kernel ones. For attributes which take multiple + values, all currently set values are reset. + + + + + set-cgroup NAME CGROUP... + unset-cgroup NAME CGROUP... + + Add or remove a unit to/from a specific + control group hierarchy and/or control group path. Takes a + unit name, plus a control group specification in the syntax + CONTROLLER:PATH + or CONTROLLER. In the latter syntax + (where the path is omitted), the default unit control group + path is implied. Examples: cpu or + cpu:/foo/bar. If a unit is removed from a + control group hierarchy, all its processes will be moved to the + root group of the hierarchy and all control group attributes + will be reset. These operations are immediately reflected in + the kernel hierarchy, and stored persistently to disk (unless + is passed). + + + help NAME...|PID... 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. + reset-failed [NAME...] Reset the failed state of the - specified units, or if no unit name is passed of all + specified units, or if no unit name is passed, reset the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code, terminating abnormally or timing - out) it will automatically enter the + out), it will automatically enter the failed state and its exit code and status is recorded for introspection by the administrator until the service is restarted or reset with this command. @@ -672,16 +850,16 @@ along with systemd; If not, see . as specified on the command line. This will create a number of symlinks as encoded in the [Install] sections of the unit files. After the symlinks have been - created the systemd configuration is reloaded (in a way that + 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 any of the units being 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 the same as instances are created in + the 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 . @@ -691,12 +869,12 @@ along with systemd; If not, see . symlinks for the units. While this command is the recommended way to manipulate the unit configuration directory, the administrator is free to make additional - changes manually, by placing or removing symlinks in the + changes manually by placing or removing symlinks in the directory. This is particularly useful to create configurations that deviate from the suggested default - installation. In this case the administrator must make sure + installation. In this case, the administrator must make sure to invoke daemon-reload manually as - necessary, to ensure his changes are taken into account. + necessary to ensure the changes are taken into account. Enabling units should not be confused with starting @@ -712,9 +890,9 @@ along with systemd; If not, see . Depending on whether , or is - specified this enables the unit for the system, for the + specified, this enables the unit for the system, for the calling user only or for all future logins of all - users. Note that in the last case no systemd daemon + users. Note that in the last case, no systemd daemon configuration is reloaded. @@ -732,7 +910,7 @@ along with systemd; If not, see . enable. This call implicitly reloads the systemd daemon configuration after completing the disabling of the units. Note that this command does not implicitly - stop the units that are being disabled. If this is desired + stop the units that are being disabled. If this is desired, an additional stop command should be executed afterwards. @@ -754,7 +932,7 @@ along with systemd; If not, see . enabled (as with enable). Returns an exit code of 0 if at least one is enabled, non-zero otherwise. Prints the current enable status. To suppress - this output use . + this output, use . @@ -780,9 +958,9 @@ along with systemd; If not, see . policy files. This has the same effect as disable or enable, depending how the unit is listed in the preset files. For - more information on preset policy format see + more information on the preset policy format, see systemd.preset5. - For more information on the concept of presets please + For more information on the concept of presets, please consult the Preset document. @@ -823,7 +1001,25 @@ along with systemd; If not, see . 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. + is not installed directly in the unit search path. + + + + + get-default + + + Get the default target specified + via default.target link. + + + + + set-default NAME + + + Set the default target to boot into. Command links + default.target to the given unit. @@ -833,7 +1029,7 @@ along with systemd; If not, see . Load one or more units specified on the command line. This will simply load their configuration from disk, - but not start them. To start them you need to use the + but not start them. To start them, you need to use the start command which will implicitly load a unit that has not been loaded yet. Note that systemd garbage collects loaded units that are not active or @@ -861,7 +1057,7 @@ along with systemd; If not, see . Cancel one or more jobs specified on the command line - by their numeric job IDs. If no job id is specified, cancel + by their numeric job IDs. If no job ID is specified, cancel all pending jobs. @@ -880,10 +1076,10 @@ along with systemd; If not, see . Shows required and wanted units of the specified - unit. If no unit is specified + unit. If no unit is specified, default.target is implied. Target units are recursively expanded. When is - passed all other units are recursively expanded as + passed, all other units are recursively expanded as well. @@ -893,14 +1089,14 @@ along with systemd; If not, see . Create a snapshot. If a snapshot name is specified, the new snapshot will be named after it. If none is - specified an automatic snapshot name is generated. In either + specified, an automatic snapshot name is generated. In either case, the snapshot name used is printed to STDOUT, unless is specified. A snapshot refers to a saved state of the systemd manager. It is implemented itself as a unit that is generated dynamically with this command and has dependencies - on all units active at the time. At a later time the user + on all units active at the time. At a later time, the user may return to this state by using the isolate command on the snapshot unit. @@ -941,8 +1137,8 @@ along with systemd; If not, see . state again. This command is of little use except for debugging and package upgrades. Sometimes it might be helpful as a heavy-weight daemon-reload. - While the daemon is reexecuted all sockets systemd listens - on on behalf of user configuration will stay accessible. + While the daemon is reexecuted, all sockets systemd listening + on behalf of user configuration will stay accessible. @@ -970,9 +1166,9 @@ along with systemd; If not, see . Unset one or more systemd manager environment - variables. If only a variable name is specified it will be + variables. If only a variable name is specified, it will be removed regardless of its value. If a variable and a value - are specified the variable is only removed if it has the + are specified, the variable is only removed if it has the specified value. @@ -989,7 +1185,7 @@ along with systemd; If not, see . Enter rescue mode. This is mostly equivalent to - isolate rescue.target but also prints a + isolate rescue.target, but also prints a wall message to all users. @@ -998,7 +1194,7 @@ along with systemd; If not, see . Enter emergency mode. This is mostly equivalent to - isolate emergency.target but also prints + isolate emergency.target, but also prints a wall message to all users. @@ -1007,13 +1203,13 @@ along with systemd; If not, see . Shut down and halt the system. This is mostly equivalent to - start halt.target --irreversible but also + start halt.target --irreversible, but also prints a wall message to all users. If combined with - shutdown of all running services is + , 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. If is - specified twice the operation is immediately executed + specified twice, the operation is immediately executed without terminating any processes or unmounting any file systems. This may result in data loss. @@ -1023,13 +1219,13 @@ along with systemd; If not, see . Shut down and power-off the system. This is mostly - equivalent to start poweroff.target --irreversible + equivalent to start poweroff.target --irreversible, but also prints a wall message to all users. If combined with - shutdown of all running services is + , 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. If is - specified twice the operation is immediately executed + specified twice, the operation is immediately executed without terminating any processes or unmounting any file systems. This may result in data loss. @@ -1039,13 +1235,13 @@ along with systemd; If not, see . Shut down and reboot the system. This is mostly - equivalent to start reboot.target --irreversible + equivalent to start reboot.target --irreversible, but also prints a wall message to all users. If combined with - shutdown of all running services is + , 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. If is - specified twice the operation is immediately executed + specified twice, the operation is immediately executed without terminating any processes or unmounting any file systems. This may result in data loss. @@ -1055,9 +1251,9 @@ along with systemd; If not, see . Shut down and reboot the system via kexec. This is - mostly equivalent to start kexec.target --irreversible + mostly equivalent to start kexec.target --irreversible, but also prints a wall message to all users. If combined - with shutdown of all running + 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. @@ -1109,13 +1305,13 @@ along with systemd; If not, see . 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 + process) to the main system manager process. This call takes two + arguments: the directory that is to become the new root directory, and the path to the new system manager binary below it to execute as PID 1. If the latter is omitted or the empty string, a systemd binary will automatically be searched for and used as init. If the system manager path is omitted or - equal to the empty string the state of the initrd's system + equal to 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. @@ -1128,7 +1324,7 @@ along with systemd; If not, see . Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise.