chiark / gitweb /
update TODO
[elogind.git] / man / systemd.xml
index edd824d31d4ff41fd95ac31290d81576f7004f5c..c6c06e57e9fd1ebcc5938ecd2e8eae2199196a53 100644 (file)
@@ -45,7 +45,7 @@
         <refnamediv>
                 <refname>systemd</refname>
                 <refname>init</refname>
-                <refpurpose>systemd System and Session Manager</refpurpose>
+                <refpurpose>systemd System and Service Manager</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -60,7 +60,7 @@
         <refsect1>
                 <title>Description</title>
 
-                <para>systemd is a system and session manager for
+                <para>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.</para>
@@ -77,7 +77,7 @@
                 <para>When run as system instance, systemd interprets
                 the configuration file
                 <filename>system.conf</filename>, otherwise
-                <filename>session.conf</filename>. See
+                <filename>user.conf</filename>. See
                 <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 for more information.</para>
         </refsect1>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--system</option></term>
-                                <term><option>--session</option></term>
+                                <term><option>--user</option></term>
 
                                 <listitem><para>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.</para></listitem>
+                                little use except for debugging. Note
+                                that it is not supported booting and
+                                maintaining a full system with systemd
+                                running in <option>--system</option>
+                                mode, but PID not 1. In practice,
+                                passing <option>--system</option> explicitly is
+                                only useful in conjunction with
+                                <option>--test</option>.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--dump-core</option></term>
 
-                                <listitem><para>Dump core on crash. This switch has no effect when run as session instance.</para></listitem>
+                                <listitem><para>Dump core on
+                                crash. This switch has no effect when
+                                run as user
+                                instance.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--crash-shell</option></term>
 
-                                <listitem><para>Run shell on crash. This switch has no effect when run as session instance.</para></listitem>
+                                <listitem><para>Run shell on
+                                crash. This switch has no effect when
+                                run as user
+                                instance.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--confirm-spawn</option></term>
 
-                                <listitem><para>Ask for confirmation when spawning processes. This switch has no effect when run as session instance.</para></listitem>
+                                <listitem><para>Ask for confirmation
+                                when spawning processes. This switch
+                                has no effect when run as user
+                                instance.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--show-status=</option></term>
 
                                 <listitem><para>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
+                                switch has no effect when run as user
+                                instance. Takes a boolean argument
+                                which may be omitted which is
+                                interpreted as
                                 <option>true</option>.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <listitem><para>Controls whether
                                 output of SysV init scripts will be
                                 directed to the console. This switch
-                                has no effect when run as session
+                                has no effect when run as user
                                 instance. Takes a boolean argument
                                 which may be omitted which is
                                 interpreted as
                 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
                         <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 
                         <listitem><para>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 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
+                        system. They are described in <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 
                         <listitem><para>Path units may be used
                         to activate other services when file system
 
                 <para>Units are named as their configuration
                 files. Some units have special semantics. A detailed
-                list you may find in
+                list is available in
                 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
 
                 <para>systemd knows various kinds of dependencies,
                 this.</para>
 
                 <para>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
                 ideas behind systemd please refer to the <ulink
                 url="http://0pointer.de/blog/projects/systemd.html">Original
                 Design Document</ulink>.</para>
+
+                <para>Note that some but not all interfaces provided
+                by systemd are covered by the <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/InterfaceStabilityPromise">Interface
+                Stability Promise</ulink>.</para>
         </refsect1>
 
         <refsect1>
 
                 <variablelist>
                         <varlistentry>
-                                <term>Session unit directories</term>
+                                <term>User unit directories</term>
 
                                 <listitem><para>Similar rules apply
-                                for the session unit
+                                for the user unit
                                 directories. However, here the <ulink
                                 url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
                                 Base Directory specification</ulink>
                                 units. Applications should place their
                                 unit files in the directory returned
                                 by <command>pkg-config systemd
-                                --variable=systemdsessionunitdir</command>. Global
+                                --variable=systemduserunitdir</command>. Global
                                 configuration is done in the directory
                                 reported by <command>pkg-config
                                 systemd
-                                --variable=systemdsessionconfdir</command>. The
+                                --variable=systemduserconfdir</command>. The
                                 <command>enable</command> and
                                 <command>disable</command> commands of
                                 the
                                 to <command>systemctl
                                 daemon-reexec</command>.</para>
 
-                                <para>systemd session managers will
+                                <para>systemd user managers will
                                 start the
                                 <filename>exit.target</filename> unit
                                 when this signal is received. This is
                                 mostly equivalent to
-                                <command>systemctl --session start
+                                <command>systemctl --user start
                                 exit.target</command>.</para></listitem>
                         </varlistentry>
 
                                 <command>systemctl start
                                 ctl-alt-del.target</command>.</para>
 
-                                <para>systemd session managers
+                                <para>systemd user managers
                                 treat this signal the same way as
                                 SIGTERM.</para></listitem>
                         </varlistentry>
                                 kbrequest.target</command>.</para>
 
                                 <para>This signal is ignored by
-                                systemd session
+                                systemd user
                                 managers.</para></listitem>
                         </varlistentry>
 
                                 <term><varname>$XDG_DATA_HOME</varname></term>
                                 <term><varname>$XDG_DATA_DIRS</varname></term>
 
-                                <listitem><para>The systemd session
+                                <listitem><para>The systemd user
                                 manager uses these variables in
                                 accordance to the <ulink
                                 url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
                                 <listitem><para>Takes a boolean
                                 argument. If <option>true</option>
                                 systemd spawns a shell when it
-                                crashes. Otherwise no core dump is
-                                created. Defaults to
+                                crashes. Otherwise no shell is
+                                spawned. Defaults to
                                 <option>false</option>, for security
                                 reasons, as the shell is not protected
                                 by any password