X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.xml;h=d3d722a23ecc98c895e8750b7bfc638eb4e0a6b6;hp=b35469c102082b3bd7d9489ca593244084fbc069;hb=d081dffbd3e57dc9da494a3384e333bf565d4175;hpb=69dd2852bb2c433b517d89792adb4461a4178aa1 diff --git a/man/systemd.xml b/man/systemd.xml index b35469c10..d3d722a23 100644 --- a/man/systemd.xml +++ b/man/systemd.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 . --> @@ -45,7 +45,7 @@ systemd init - systemd System and Session Manager + systemd System and Service Manager @@ -60,7 +60,7 @@ Description - systemd is a system and session manager for + systemd is a system and service manager for Linux operating systems. When run as first process on boot (as PID 1), it acts as init system that brings up and maintains userspace services. @@ -77,7 +77,7 @@ When run as system instance, systemd interprets the configuration file system.conf, otherwise - session.conf. See + user.conf. See systemd.conf5 for more information. @@ -136,53 +136,56 @@ - + Tell systemd to run a - system instance (resp. session + system instance (resp. user instance), even if the process ID is - not 1 (resp. is 1), i.e. systemd is not - (resp. is) run as init process. + not 1 (resp. is 1), i.e. systemd is + not (resp. is) run as init process. Normally it should not be necessary to pass these options, as systemd automatically detects the mode it is started in. These options are hence of - little use except for - debugging. + little use except for debugging. Note + that it is not supported booting and + maintaining a full system with systemd + running in + mode, but PID not 1. In practice, + passing explicitly is + only useful in conjunction with + . - Dump core on crash. This switch has no effect when run as session instance. + Dump core on + crash. This switch has no effect when + run as user + instance. - Run shell on crash. This switch has no effect when run as session instance. + Run shell on + crash. This switch has no effect when + run as user + instance. - Ask for confirmation when spawning processes. This switch has no effect when run as session instance. + Ask for confirmation + when spawning processes. This switch + has no effect when run as user + instance. Show terse service status information while booting. This - switch has no effect when run as - session instance. Takes a boolean - argument which may be omitted - which is interpreted as - . - - - - - Controls whether - output of SysV init scripts will be - directed to the console. This switch - has no effect when run as session + switch has no effect when run as user instance. Takes a boolean argument which may be omitted which is interpreted as @@ -194,8 +197,10 @@ Set log target. Argument must be one of , + , , , + , , . @@ -235,6 +240,36 @@ it defaults to . + + + + + Sets the default + output resp. error output for all + services and sockets, i.e. controls + the default for + + resp. + (see + systemd.exec5 + for details). Takes one of + , + , + , + , + , + , + , + , + . If the + argument is omitted + + defaults to + and + + to + . + @@ -256,7 +291,7 @@ as well as in the process of being activated or deactivated, i.e. between the two states (these states are called 'activating', 'deactivating'). A special - 'maintenance' state is available as well which is very + 'failed' state is available as well which is very similar to 'inactive' and is entered when the service failed in some way (process returned error code on exit, or crashed, or an operation timed out). If this @@ -317,9 +352,9 @@ systemd.timer5. Swap units are very similar to - mount units and encapsulated memory swap + mount units and encapsulate memory swap partitions or files of the operating - systemd. They are described in systemd.swap5. + system. They are described in systemd.swap5. Path units may be used to activate other services when file system @@ -330,7 +365,7 @@ Units are named as their configuration files. Some units have special semantics. A detailed - list you may find in + list is available in systemd.special7. systemd knows various kinds of dependencies, @@ -355,7 +390,7 @@ this. Application programs and units (via - dependencies) may requests state changes of units. In + dependencies) may request state changes of units. In systemd, these requests are encapsulated as 'jobs' and maintained in a job queue. Jobs may succeed or can fail, their execution is ordered based on the ordering @@ -388,7 +423,7 @@ track of processes. Control group information is maintained in the kernel, and is accessible via the file system hierarchy (beneath - /cgroup/systemd/), or in tools + /sys/fs/cgroup/systemd/), or in tools such as ps1 (ps xawf -eo pid,user,cgroup,args @@ -440,6 +475,11 @@ ideas behind systemd please refer to the Original Design Document. + + Note that some but not all interfaces provided + by systemd are covered by the Interface + Stability Promise. @@ -457,9 +497,9 @@ pkg-config systemd --variable=systemdsystemunitdir. Other directories checked are - /usr/local/share/systemd/system + /usr/local/lib/systemd/system and - /usr/share/systemd/system. User + /usr/lib/systemd/system. User configuration always takes precedence. pkg-config systemd @@ -478,10 +518,10 @@ - Session unit directories + User unit directories Similar rules apply - for the session unit + for the user unit directories. However, here the XDG Base Directory specification @@ -489,11 +529,11 @@ units. Applications should place their unit files in the directory returned by pkg-config systemd - --variable=systemdsessionunitdir. Global + --variable=systemduserunitdir. Global configuration is done in the directory reported by pkg-config systemd - --variable=systemdsessionconfdir. The + --variable=systemduserconfdir. The enable and disable commands of the @@ -554,12 +594,12 @@ to systemctl daemon-reexec. - systemd session managers will + systemd user managers will start the exit.target unit when this signal is received. This is mostly equivalent to - systemctl --session start + systemctl --user start exit.target. @@ -574,7 +614,7 @@ systemctl start ctl-alt-del.target. - systemd session managers + systemd user managers treat this signal the same way as SIGTERM. @@ -591,7 +631,7 @@ kbrequest.target. This signal is ignored by - systemd session + systemd user managers. @@ -700,6 +740,106 @@ systemctl start reboot.target. + + + SIGRTMIN+6 + + Reboots the machine via kexec, + starts the + kexec.target + unit. This is mostly equivalent to + systemctl start + kexec.target. + + + + SIGRTMIN+13 + + Immediately halts the machine. + + + + SIGRTMIN+14 + + Immediately powers off the machine. + + + + SIGRTMIN+15 + + Immediately reboots the machine. + + + + SIGRTMIN+16 + + Immediately reboots the machine with kexec. + + + + SIGRTMIN+20 + + Enables display of + status messages on the console, as + controlled via + systemd.show_status=1 + on the kernel command + line. + + + + SIGRTMIN+21 + + Disables display of + status messages on the console, as + controlled via + systemd.show_status=0 + on the kernel command + line. + + + + SIGRTMIN+22 + SIGRTMIN+23 + + Sets the log level to + debug + (resp. info on + SIGRTMIN+23), as + controlled via + systemd.log_level=debug + (resp. systemd.log_level=info + on SIGRTMIN+23) on + the kernel command + line. + + + + SIGRTMIN+26 + SIGRTMIN+27 + SIGRTMIN+28 + SIGRTMIN+29 + + Sets the log level to + journal-or-kmsg + (resp. console on + SIGRTMIN+27; + resp. kmsg on + SIGRTMIN+28; + resp. syslog-or-kmsg + on SIGRTMIN+29), as + controlled via + systemd.log_target=journal-or-kmsg + (resp. systemd.log_target=console + on SIGRTMIN+27; + resp. systemd.log_target=kmsg + on SIGRTMIN+28; + resp + systemd.log_target=syslog-or-kmsg + on SIGRTMIN+29) on + the kernel command + line. + @@ -746,7 +886,7 @@ $XDG_DATA_HOME $XDG_DATA_DIRS - The systemd session + The systemd user manager uses these variables in accordance to the XDG @@ -805,11 +945,21 @@ Kernel Command Line - When run as system instance systemd parses a few kernel command line arguments: + When run as system instance systemd parses a + number of kernel command line + argumentsIf run inside a Linux + container these arguments may be passed as command + line arguments to systemd itself, next to any of the + command line options listed in the Options section + above. If run outside of Linux containers, these + arguments are parsed from + /proc/cmdline + instead.: systemd.unit= + rd.systemd.unit= Overrides the unit to activate on boot. Defaults to @@ -819,8 +969,12 @@ rescue.target or emergency.service. See systemd.special7 - for details about these - units. + for details about these units. The + option prefixed with + rd. is honoured + only in the initial RAM disk (initrd), + while the one that isn't prefixed only + in the main system. @@ -840,8 +994,8 @@ Takes a boolean argument. If systemd spawns a shell when it - crashes. Otherwise no core dump is - created. Defaults to + crashes. Otherwise no shell is + spawned. Defaults to , for security reasons, as the shell is not protected by any password @@ -875,16 +1029,6 @@ argument. If shows terse service status updates on the console during bootup. Defaults to - . - - - - systemd.sysv_console= - - Takes a boolean - argument. If - output of SysV init scripts will be - directed to the console. Defaults to , unless is passed as kernel command line option in which @@ -904,7 +1048,122 @@ environment variables described above. + + systemd.default_standard_output= + systemd.default_standard_error= + Controls default + standard output/error output for + services, with the same effect as the + + resp. + command line arguments described + above. + + + + systemd.setenv= + + Takes a string + argument in the form + VARIABLE=VALUE. May be used to set + environment variables for the init + process and all its children at boot + time. May be used more than once to + set multiple variables. If the equal + sign and variable are missing unsets + an environment variable which might be + passed in from the initial ram + disk. + + + + quiet + + If passed turns off + status output at boot, much like + systemd.show_status=false + would. Note that this option is also + read by the kernel itself and disables + kernel log output to the + kernel. Passing this option hence + turns off the usual output from both + the system manager and the + kernel. + + + + emergency + + Boot into emergency + mode. This is equivalent to + systemd.unit=emergency.target + and provided for compatibility + reasons and to be easier to type. + + + + single + s + S + 1 + + Boot into rescue + mode. This is equivalent to + systemd.unit=rescue.target + and provided for compatibility reasons + and to be easier to + type. + + + + 2 + 3 + 4 + 5 + + Boot into the + specified legacy SysV runlevel. This + is equivalent to + systemd.unit=runlevel2.target, + systemd.unit=runlevel3.target, + systemd.unit=runlevel4.target, + resp. systemd.unit=runlevel5.target + and provided for compatibility reasons + and to be easier to + type. + + + + locale.LANG= + locale.LANGUAGE= + locale.LC_CTYPE= + locale.LC_NUMERIC= + locale.LC_TIME= + locale.LC_COLLATE= + locale.LC_MONETARY= + locale.LC_MESSAGES= + locale.LC_PAPER= + locale.LC_NAME= + locale.LC_ADDRESS= + locale.LC_TELEPHONE= + locale.LC_MEASUREMENT= + locale.LC_IDENTIFICATION= + + Set the system locale + to use. This overrides the settings in + /etc/locale.conf. For + more information see + locale.conf5 + and + locale7. + + + + For other kernel command line parameters + understood by components of the core OS, please refer + to + kernel-command-line7. @@ -912,42 +1171,37 @@ - @/org/freedesktop/systemd1/notify + /run/systemd/notify Daemon status - notification socket. This is an AF_UNIX - datagram socket in the Linux abstract - namespace, and is used to implement - the daemon notification logic as - implemented by + notification socket. This is an + AF_UNIX datagram socket and is used to + implement the daemon notification + logic as implemented by sd_notify3. - @/org/freedesktop/systemd1/logger + /run/systemd/shutdownd Used internally by the - systemd-logger.service - unit to connect STDOUT and/or STDERR - of spawned processes to - syslog3 - or the kernel log buffer. This is an - AF_UNIX stream socket in the Linux - abstract namespace. + shutdown8 + tool to implement delayed + shutdowns. This is an AF_UNIX datagram + socket. - @/org/freedesktop/systemd1/private + /run/systemd/private Used internally as communication channel between systemctl1 and the systemd process. This is an - AF_UNIX stream socket in the Linux - abstract namespace. This interface is - private to systemd and should not be - used in external + AF_UNIX stream socket. This interface + is private to systemd and should not + be used in external projects. @@ -976,7 +1230,8 @@ sd-daemon7, systemd.unit5, systemd.special5, - pkg-config1 + pkg-config1, + kernel-command-line7