[systemd-commits] 3 commits - man/daemon.xml man/runlevel.xml man/sd_booted.xml man/sd_listen_fds.xml man/sd_notify.xml man/systemctl.xml man/systemd-install.xml man/systemd-notify.xml man/systemd.unit.xml man/systemd.xml
Lennart Poettering
lennart at kemper.freedesktop.org
Thu Jun 24 08:25:38 PDT 2010
man/daemon.xml | 6 +-
man/runlevel.xml | 2
man/sd_booted.xml | 2
man/sd_listen_fds.xml | 2
man/sd_notify.xml | 2
man/systemctl.xml | 2
man/systemd-install.xml | 8 ++
man/systemd-notify.xml | 33 ++++++++++++
man/systemd.unit.xml | 129 ++++++++++++++++++++++++++++++++++++------------
man/systemd.xml | 10 +--
10 files changed, 150 insertions(+), 46 deletions(-)
New commits:
commit 436c44a5d64ef136ead64e9b03c8c05cc573a61b
Author: Kay Sievers <kay.sievers at vrfy.org>
Date: Thu Jun 24 17:25:16 2010 +0200
man: spelling fixes
diff --git a/man/daemon.xml b/man/daemon.xml
index 650e0fa..1cddf38 100644
--- a/man/daemon.xml
+++ b/man/daemon.xml
@@ -65,7 +65,7 @@
starts, it should execute the following steps
as part of the initialization. Note that these
steps are unnecessary for new-style daemons,
- and should only be implemented if compatbility
+ and should only be implemented if compatibility
with SysV is essential.</para>
<orderedlist>
@@ -213,7 +213,7 @@
<listitem><para>As much as possible,
rely on systemd's functionality to
- limit the accces of the daemon to
+ limit the access of the daemon to
files, services and other
resources. i.e. rely on systemd's
resource limit control instead of
@@ -250,7 +250,7 @@
scheme pointed out below. Like D-Bus
activation this enables on-demand
starting of services as well as it
- allows improved parallization of
+ allows improved parallelization of
service start-up. Also, for state-less
protocols (such as syslog, DNS) a
daemon implementing socket-based
diff --git a/man/runlevel.xml b/man/runlevel.xml
index 04959b1..879b5e1 100644
--- a/man/runlevel.xml
+++ b/man/runlevel.xml
@@ -64,7 +64,7 @@
determined N is printed instead. If neither can be
determined the word "unknown" is printed.</para>
- <para>Unless overriden in the environment this will
+ <para>Unless overridden in the environment this will
check the utmp database for recent runlevel
changes.</para>
</refsect1>
diff --git a/man/sd_booted.xml b/man/sd_booted.xml
index 8d5606d..4d74733 100644
--- a/man/sd_booted.xml
+++ b/man/sd_booted.xml
@@ -70,7 +70,7 @@
<para>On failure, this call returns a negative
errno-style error code. If the system was booted up
with systemd as init system this call returns a
- postive return value, zero otherwise.</para>
+ positive return value, zero otherwise.</para>
</refsect1>
<refsect1>
diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml
index 54874fd..734e237 100644
--- a/man/sd_listen_fds.xml
+++ b/man/sd_listen_fds.xml
@@ -90,7 +90,7 @@
<citerefentry><refentrytitle>sd_is_socket_inet</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_is_socket_unix</refentrytitle><manvolnum>3</manvolnum></citerefentry>
are provided. In order to maximize flexibility it is
- recommened to make these checks as loose as possible
+ recommended to make these checks as loose as possible
without allowing incorrect setups. i.e. often the
actual port number a socket is bound to matters little
for the service to work, hence it should not be
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 6a68955..8e6ee61 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -153,7 +153,7 @@
</varlistentry>
</variablelist>
- <para>It is recommened to prefix variable names that
+ <para>It is recommended to prefix variable names that
are not shown in the list above with
<varname>X_</varname> to avoid namespace
clashes.</para>
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 696a506..2ffc87d 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -102,7 +102,7 @@
<term><option>--replace</option></term>
<listitem><para>If the requested
- operation conflicts with an exisiting
+ operation conflicts with an existing
unfinished operation, replace the
existing operation by the requested
operation. If this is not specified
diff --git a/man/systemd-install.xml b/man/systemd-install.xml
index 8afa7d9..63832aa 100644
--- a/man/systemd-install.xml
+++ b/man/systemd-install.xml
@@ -149,7 +149,7 @@
<listitem><para>Checks whether any of
the units specified are
installed. This will check for the
- existance of a number of symlinks as
+ existence of a number of symlinks as
encoded in the [Install] section of a
unit file.</para></listitem>
</varlistentry>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index af89d31..7e657c6 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -64,7 +64,7 @@
<para>A unit configuration file encodes information
about a service, a socket, a device, a mount point, an
- automount point, a swap file or patition, a start-up
+ automount point, a swap file or partition, a start-up
target, a file system path or a timer controlled and
supervised by <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The syntax is inspired by XDG
<filename>.desktop</filename> files, which are in turn
diff --git a/man/systemd.xml b/man/systemd.xml
index 4608283..8f58b66 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -137,7 +137,7 @@
<listitem><para>Extract D-Bus
interface introspection data. This is
- mostly useful at build ot install time
+ mostly useful at build at install time
to generate data suitable for the
D-Bus interfaces
repository. Optionally the interface
@@ -459,7 +459,7 @@
<term><varname>$SYSTEMD_LOG_LEVEL</varname></term>
<listitem><para>systemd reads the
log level from this environment
- variable. This can be overriden with
+ variable. This can be overridden with
<option>--log-level=</option>.</para></listitem>
</varlistentry>
@@ -467,7 +467,7 @@
<term><varname>$SYSTEMD_LOG_TARGET</varname></term>
<listitem><para>systemd reads the
log target from this environment
- variable. This can be overriden with
+ variable. This can be overridden with
<option>--log-target=</option>.</para></listitem>
</varlistentry>
@@ -475,7 +475,7 @@
<term><varname>$SYSTEMD_LOG_COLOR</varname></term>
<listitem><para>Controls whether
systemd highlights important log
- messages. This can be overriden with
+ messages. This can be overridden with
<option>--log-color=</option>.</para></listitem>
</varlistentry>
@@ -484,7 +484,7 @@
<listitem><para>Controls whether
systemd prints the code location along
with log messages. This can be
- overriden with
+ overridden with
<option>--log-location=</option>.</para></listitem>
</varlistentry>
commit 771610b04d5dc320a40f2270c50b176bd1f8facc
Author: Lennart Poettering <lennart at poettering.net>
Date: Thu Jun 24 17:22:52 2010 +0200
man: additional documentation
diff --git a/man/systemd-install.xml b/man/systemd-install.xml
index bb52230..8afa7d9 100644
--- a/man/systemd-install.xml
+++ b/man/systemd-install.xml
@@ -66,6 +66,12 @@
<para><command>systemd-install</command> enables or
disables systemd units, or checks whether they are
enabled.</para>
+
+ <para>This command is useful to apply or undo the
+ installation instructions encoded in the [Install]
+ section of unit files. See
+ <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ for more information.</para>
</refsect1>
<refsect1>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 7c2320e..af89d31 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -55,67 +55,132 @@
<para><filename>systemd.automount</filename></para>
<para><filename>systemd.swap</filename></para>
<para><filename>systemd.target</filename></para>
+ <para><filename>systemd.path</filename></para>
+ <para><filename>systemd.timer</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>A unit configuration file encodes information
- about a service, a socket, a mount point, an automount
- point, a swap file or patition, or a start-up target
- controlled and supervised by systemd. The syntax is
- inspired by XDG <filename>.desktop</filename> files,
- which are in turn inspired by Windows
- <filename>.ini</filename> files.</para>
+ about a service, a socket, a device, a mount point, an
+ automount point, a swap file or patition, a start-up
+ target, a file system path or a timer controlled and
+ supervised by <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The syntax is inspired by XDG
+ <filename>.desktop</filename> files, which are in turn
+ inspired by Microsoft Windows <filename>.ini</filename>
+ files.</para>
<para>This man pages lists the common configuration
- options of the various unit types.</para>
+ options of the all unit types. These options need to
+ be configured either in the [Unit] resp. [Install]
+ section of the unit files.</para>
</refsect1>
<refsect1>
<title>Options</title>
+ <para>Unit file may include a [Unit] section, which
+ carries generic information about the unit that is not
+ dependent on the type of unit:</para>
+
<variablelist>
<varlistentry>
<term><varname>Names=</varname></term>
- <listitem>
- <para>Additional names for this unit. The names
- listed here mus have the same suffix (i.e. type)
- as the identifier name. This option may be
- specified more than once.</para>
+
+ <listitem><para>Additional names for
+ this unit. The names listed here must
+ have the same suffix (i.e. type) as
+ the unit file name. This option may be
+ specified more than once, in which
+ case all listed names are used. Note
+ that this option is different from the
+ <varname>Alias=</varname> option from
+ the [Install] section mentioned
+ below. See below for details</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Requires=</varname></term>
- <listitem>
- <para>Dependencies on other
- units. If this units get
- activated the units listed
- here will be activated as
- well. If one of the other
- units gets deactivated or its
- activation fails, this unit
- will be deactivated. This
- option may be specified more
- than once.</para>
+
+ <listitem><para>Requirement
+ dependencies on other units. If this
+ units get activated the units listed
+ here will be activated as well. If one
+ of the other units gets deactivated or
+ its activation fails, this unit will
+ be deactivated. This option may be
+ specified more than once, in which
+ case requirement dependencies for all
+ listed names are created.</para>
</listitem>
</varlistentry>
</variablelist>
+
+ <para>Unit file may include a [Install] section, which
+ carries installation information for the unit. This
+ section is not interpreted by
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ during runtime. It is used exclusively by the
+ <citerefentry><refentrytitle>systemd-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ during installation of a unit:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>Alias=</varname></term>
+
+ <listitem><para>Additional names this
+ unit shall be installed under. The
+ names listed here must have the same
+ suffix (i.e. type) as the unit file
+ name. This option may be specified
+ more than once, in which case all
+ listed names are used. At installation
+ time
+ <command>systemd-install</command>
+ will create symlinks from these names
+ to the unit file name. Note that this
+ is different from the
+ <varname>Names=</varname> option from
+ the [Unit] section mentioned above:
+ The names from
+ <varname>Names=</varname> apply
+ unconditionally if the unit is
+ loaded. The names from
+ <varname>Alias=</varname> apply only
+ if the unit is actually installed with
+ the <command>systemd-install</command>
+ tool. Also, if systemd searches for a
+ unit, it will discover symlinked alias
+ names, but not names configured only
+ with <varname>Names=</varname>. It is
+ a common pattern to list a name in both
+ options. In this case, a unit will be
+ active under all names if installed,
+ but also if not installed but
+ requested
+ explicitly.</para></listitem>
+ </varlistentry>
+ </variablelist>
+
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
commit c61fbdfcb9bcd405c5a0a9b5f7050a58a871db6e
Author: Lennart Poettering <lennart at poettering.net>
Date: Thu Jun 24 16:13:56 2010 +0200
man: extend systemd-notify man page a bit
diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml
index 46f3f1a..5286418 100644
--- a/man/systemd-notify.xml
+++ b/man/systemd-notify.xml
@@ -73,6 +73,11 @@
environment variables to send as part of the status
update.</para>
+ <para>Note that systemd will refuse reception of
+ status updates from this command unless
+ <varname>NotifyAccess=all</varname> is set for the
+ service unit this command is called from.</para>
+
</refsect1>
<refsect1>
@@ -154,6 +159,34 @@
</refsect1>
<refsect1>
+ <title>Example</title>
+
+ <example>
+ <title>Start-up Notification and Status Updates</title>
+
+ <para>A simple shell daemon that sends
+ start-up notifications after having set up its
+ communication channel. During runtime it sends
+ further status updates to the init
+ system:</para>
+
+ <programlisting>#!/bin/bash
+
+mkfifo /tmp/waldo
+systemd-notify --ready --status="Waiting for data..."
+
+while : ; do
+ read a < /tmp/waldo
+ systemd-notify --status="Processing $a"
+
+ # Do something with $a ...
+
+ systemd-notify --status="Waiting for data..."
+done</programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
More information about the systemd-commits
mailing list