X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.xml;h=6aa4f7052706b1f0fd75a0aa2358997312b9cc7b;hp=ba775c5c91197c902639ad46f2f86e34b55ffd1e;hb=248e6030e007b6ee7b31ada6e42053cb1ebfc80d;hpb=f3e219a238c716ffa06fab7b0618197c090dfd5a diff --git a/man/systemd.xml b/man/systemd.xml index ba775c5c9..6aa4f7052 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -117,7 +117,7 @@ Extract D-Bus interface introspection data. This is - mostly useful at build at install time + mostly useful at install time to generate data suitable for the D-Bus interfaces repository. Optionally the interface @@ -135,18 +135,26 @@ default.target. - - - Tell systemd to run in - a particular mode. Argument is one of - , - . Normally it - should not be necessary to pass this - option, as systemd automatically - detects the mode it is started - in. This call is hence of little use - except for - debugging. + + + + Tell systemd to run a + system instance (resp. session + instance), even if the process ID is + 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. 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 + . @@ -164,9 +172,27 @@ Ask for confirmation when spawning processes. This switch has no effect when run as session instance. - + - Show terse service status information while booting. This switch has no effect when run as session 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 + instance. Takes a boolean argument + which may be omitted which is + interpreted as + . @@ -224,18 +250,29 @@ systemd provides a dependency system between various entities called "units". Units encapsulate various objects that are relevant for system boot-up - and maintainance. The majority of units are configured + and maintenance. The majority of units are configured in unit configuration files, whose syntax and basic set of options is described in systemd.unit5, however some are created automatically from other configuration or dynamically from system state. Units - may be active (meaning started, bound, plugged in, ... - depending on the unit type), or inactive (meaning - stopped, unbound, unplugged, ...), as well is in the - process of being activated or deactivated, - i.e. between the two states. The following unit types - are available: + may be 'active' (meaning started, bound, plugged in, + ... depending on the unit type, see below), or + 'inactive' (meaning stopped, unbound, unplugged, ...), + 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 + '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 + state is entered the cause will be logged, for later + reference. Note that the various unit types may have a + number of additional substates, which are mapped to + the five generalized unit states described + here. + + The following unit types are available: Service units, which control @@ -278,7 +315,7 @@ systemd units, which later may be restored by activating the saved snapshot unit. For more information see - systemd.automount5. + systemd.snapshot5. Timer units are useful for triggering activation of other units based on @@ -291,7 +328,7 @@ systemd. They are described in systemd.swap5. Path units may be used - activate other services when file system + to activate other services when file system objects change or are modified. See systemd.path5. @@ -302,8 +339,37 @@ list you may find in systemd.special7. + systemd knows various kinds of dependencies, + including positive and negative requirement + dependencies (i.e. Requires= and + Conflicts=) as well as ordering + dependencies (After= and + Before=). NB: ordering and + requirement dependencies are orthogonal. If only a + requirement dependency exists between two units + (e.g. foo.service requires + bar.service), but no ordering + dependency (e.g. foo.service + after bar.service) and both are + requested to start, they will be started in + parallel. It is a common pattern that both requirement + and ordering dependencies are placed between two + units. Also note that the majority of dependencies are + implicitly created and maintained by systemd. In most + cases it should be unnecessary to declare additional + dependencies manually, however it is possible to do + this. + + Application programs and units (via + dependencies) may requests 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 + dependencies of the units they have been scheduled + for. + On boot systemd activates the target unit - default.target whose job it is to + default.target whose job is to activate on-boot services and other on-boot units by pulling them in via dependencies. Usually the unit name is just an alias (symlink) for either @@ -318,7 +384,7 @@ systemd.special7 for details about these target units. - Processes systemd spawns ared placed in + Processes systemd spawns are placed in individual Linux control groups named after the unit which they belong to in the private systemd hierarchy. (see /cgroup/systemd/), or in tools + /sys/fs/cgroup/systemd/), or in tools such as ps1 (ps xawf -eo pid,user,cgroup,args @@ -340,9 +406,9 @@ simply read as an alternative (though limited) configuration file format. The SysV /dev/initctl interface is - provided, and comaptibility implementations of the - various SysV client tools available. In addition to - that various established Unix functionality such as + provided, and compatibility implementations of the + various SysV client tools are available. In addition to + that, various established Unix functionality such as /etc/fstab or the utmp database are supported. @@ -380,6 +446,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. @@ -406,9 +477,12 @@ --variable=systemdsystemconfdir returns the path of the system configuration directory. Packages - should alter the content of these directories - only with the - systemd-install1 + should alter the content of these + directories only with the + enable and + disable commands of + the + systemctl1 tool. @@ -427,11 +501,14 @@ unit files in the directory returned by pkg-config systemd --variable=systemdsessionunitdir. Global - configuration is done in the - directory reported by - pkg-config systemd + configuration is done in the directory + reported by pkg-config + systemd --variable=systemdsessionconfdir. The - systemd-install1 + enable and + disable commands of + the + systemctl1 tool can handle both global (i.e. for all users) and private (for one user) enabling/disabling of @@ -466,7 +543,7 @@ when figuring out whether a service shall be enabled. Note that a service unit with a native unit configuration - file can be started by activating it + file cannot be started by activating it in the SysV runlevel link farm. @@ -757,18 +834,6 @@ units. - - systemd.log_target= - systemd.log_level= - systemd.log_color= - systemd.log_location= - - Controls log output, - with the same effect as the - $SYSTEMD_LOG_TARGET, $SYSTEMD_LOG_LEVEL, $SYSTEMD_LOG_COLOR, $SYSTEMD_LOG_LOCATION - environment variables described above. - - systemd.dump_core= @@ -804,6 +869,16 @@ -1. + + systemd.confirm_spawn= + + Takes a boolean + argument. If + asks for confirmation when spawning + processes. Defaults to + . + + systemd.show_status= @@ -814,6 +889,32 @@ . + + 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 + case it defaults to + . + + + + systemd.log_target= + systemd.log_level= + systemd.log_color= + systemd.log_location= + + Controls log output, + with the same effect as the + $SYSTEMD_LOG_TARGET, $SYSTEMD_LOG_LEVEL, $SYSTEMD_LOG_COLOR, $SYSTEMD_LOG_LOCATION + environment variables described above. + + @@ -847,6 +948,17 @@ abstract namespace. + + @/org/freedesktop/systemd1/shutdown + + Used internally by the + shutdown8 + tool to implement delayed + shutdowns. This is an AF_UNIX datagram + socket in the Linux abstract + namespace. + + @/org/freedesktop/systemd1/private @@ -881,7 +993,6 @@ systemctl1, systemadm1, - systemd-install1, systemd-notify1, daemon7, sd-daemon7,