diff options
author | Lennart Poettering <lennart@poettering.net> | 2010-07-07 01:38:56 +0200 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2010-07-07 01:38:56 +0200 |
commit | f3e219a238c716ffa06fab7b0618197c090dfd5a (patch) | |
tree | 5b19461dcf2b0dbc6ca5906e3c9946240d61b8db | |
parent | 487393e9f11e4a06d91df03232914bd8c4b3368e (diff) |
update man pages for recent changes
-rw-r--r-- | Makefile.am | 3 | ||||
-rw-r--r-- | man/sd-daemon.xml | 2 | ||||
-rw-r--r-- | man/systemd.automount.xml | 2 | ||||
-rw-r--r-- | man/systemd.conf.xml | 112 | ||||
-rw-r--r-- | man/systemd.device.xml | 2 | ||||
-rw-r--r-- | man/systemd.exec.xml | 2 | ||||
-rw-r--r-- | man/systemd.mount.xml | 2 | ||||
-rw-r--r-- | man/systemd.path.xml | 2 | ||||
-rw-r--r-- | man/systemd.service.xml | 2 | ||||
-rw-r--r-- | man/systemd.snapshot.xml | 2 | ||||
-rw-r--r-- | man/systemd.socket.xml | 2 | ||||
-rw-r--r-- | man/systemd.swap.xml | 2 | ||||
-rw-r--r-- | man/systemd.target.xml | 2 | ||||
-rw-r--r-- | man/systemd.timer.xml | 2 | ||||
-rw-r--r-- | man/systemd.xml | 171 |
15 files changed, 263 insertions, 47 deletions
diff --git a/Makefile.am b/Makefile.am index cdb5be314e..0215f2325d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -341,7 +341,8 @@ MANPAGES = \ man/telinit.8 \ man/halt.8 \ man/shutdown.8 \ - man/pam_systemd.8 + man/pam_systemd.8 \ + man/systemd.conf.5 MANPAGES_ALIAS = \ man/reboot.8 \ diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index d961513329..e3ac68eed3 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -61,7 +61,7 @@ <filename>sd-daemon.h</filename> provide a reference implementation of various APIs for new-style daemons, as implemented by the - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> init system.</para> <para>See diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index d1e04f6138..754d1e37f3 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -155,7 +155,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.conf.xml b/man/systemd.conf.xml new file mode 100644 index 0000000000..95a2e5261b --- /dev/null +++ b/man/systemd.conf.xml @@ -0,0 +1,112 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<!-- + This file is part of systemd. + + 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 + (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. + + You should have received a copy of the GNU General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. +--> + +<refentry id="systemd.conf"> + <refentryinfo> + <title>systemd.conf</title> + <productname>systemd</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Lennart</firstname> + <surname>Poettering</surname> + <email>lennart@poettering.net</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd.conf</refentrytitle> + <manvolnum>5</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd.conf</refname> + <refpurpose>systemd manager configuration file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>system.conf</filename></para> + <para><filename>session.conf</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>When run as system instance systemd reads the + configuration file <filename>system.conf</filename>, + otherwise <filename>session.conf</filename>. These + configuration files contain a few settings controlling + basic manager operations.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>All options are configured in the + <literal>[Manager]</literal> section:</para> + + <variablelist> + + <varlistentry> + <term><varname>LogLevel=</varname></term> + <term><varname>LogTarget=</varname></term> + <term><varname>LogColor=</varname></term> + <term><varname>LogLocation=</varname></term> + <term><varname>DumpCore=yes</varname></term> + <term><varname>CrashShell=no</varname></term> + <term><varname>ShowStatus=yes</varname></term> + <term><varname>CrashChVT=1</varname></term> + + <listitem><para>Configures various + parameters of basic manager + operation. These options may be + overriden by the respective command + line arguments. See + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> + for details about these command line + arguments.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>CPUAffinity=</varname></term> + + <listitem><para>Configures the initial + CPU affinity for the init + process. Takes a space-seperated list + of CPU indexes.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/systemd.device.xml b/man/systemd.device.xml index c5306430fb..ea1416fd73 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -139,7 +139,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 6502d87b4a..68495dcaf7 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -734,7 +734,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 45173b55fd..70170bb865 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -237,7 +237,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.path.xml b/man/systemd.path.xml index d910d2c5c8..d5495c7cc3 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -174,7 +174,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 008ebd752e..bceb5aa110 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -538,7 +538,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> diff --git a/man/systemd.snapshot.xml b/man/systemd.snapshot.xml index 5287ad2a56..a3e23225c6 100644 --- a/man/systemd.snapshot.xml +++ b/man/systemd.snapshot.xml @@ -78,7 +78,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> </para> diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 6154b304e8..32102fab88 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -509,7 +509,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 18f96d008f..38574ab4c8 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -134,7 +134,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.target.xml b/man/systemd.target.xml index 6f3bc182dc..5c26427596 100644 --- a/man/systemd.target.xml +++ b/man/systemd.target.xml @@ -97,7 +97,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 557a45e0fe..518ae2a9f1 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -182,7 +182,7 @@ <refsect1> <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> diff --git a/man/systemd.xml b/man/systemd.xml index b4a7e3ec93..ba775c5c91 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -73,6 +73,13 @@ are mostly equivalent when invoked from normal login sessions. See <citerefentry><refentrytitle>telinit</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more information.</para> + + <para>When run as system instance, systemd interprets + the configuration file + <filename>system.conf</filename>, otherwise + <filename>session.conf</filename>. See + <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for more information.</para> </refsect1> <refsect1> @@ -89,6 +96,37 @@ text and exits.</para></listitem> </varlistentry> <varlistentry> + <term><option>--test</option></term> + + <listitem><para>Determine startup + sequence, dump it and exit. This is an + option useful for debugging + only.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>--dump-configuration-items</option></term> + + <listitem><para>Dump understood unit + configuration items. This outputs a + terse but complete list of + configuration items understood in unit + definition files.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>--introspect=</option></term> + + <listitem><para>Extract D-Bus + interface introspection data. This is + mostly useful at build at install time + to generate data suitable for the + D-Bus interfaces + repository. Optionally the interface + name for the introspection data may be + specified. If omitted, the + introspection data for all interfaces + is dumped.</para></listitem> + </varlistentry> + <varlistentry> <term><option>--unit=</option></term> <listitem><para>Set default unit to @@ -111,40 +149,35 @@ debugging.</para></listitem> </varlistentry> <varlistentry> - <term><option>--test</option></term> + <term><option>--dump-core</option></term> - <listitem><para>Determine startup - sequence, dump it and exit. This is an - option useful for debugging - only.</para></listitem> + <listitem><para>Dump core on crash. This switch has no effect when run as session instance.</para></listitem> </varlistentry> <varlistentry> - <term><option>--dump-configuration-items</option></term> + <term><option>--crash-shell</option></term> - <listitem><para>Dump understood unit - configuration items. This outputs a - terse but complete list of - configuration items understood in unit - definition files.</para></listitem> + <listitem><para>Run shell on crash. This switch has no effect when run as session instance.</para></listitem> </varlistentry> <varlistentry> <term><option>--confirm-spawn</option></term> - <listitem><para>Ask for confirmation when spawning processes.</para></listitem> + <listitem><para>Ask for confirmation when spawning processes. This switch has no effect when run as session instance.</para></listitem> </varlistentry> <varlistentry> - <term><option>--introspect=</option></term> + <term><option>--show-status</option></term> - <listitem><para>Extract D-Bus - interface introspection data. This is - mostly useful at build at install time - to generate data suitable for the - D-Bus interfaces - repository. Optionally the interface - name for the introspection data may be - specified. If omitted, the - introspection data for all interfaces - is dumped.</para></listitem> + <listitem><para>Show terse service status information while booting. This switch has no effect when run as session instance.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>--log-target=</option></term> + + <listitem><para>Set log + target. Argument must be one of + <option>console</option>, + <option>syslog</option>, + <option>kmsg</option>, + <option>syslog-or-kmsg</option>, + <option>null</option>.</para></listitem> </varlistentry> <varlistentry> <term><option>--log-level=</option></term> @@ -163,17 +196,6 @@ <option>debug</option>.</para></listitem> </varlistentry> <varlistentry> - <term><option>--log-target=</option></term> - - <listitem><para>Set log - target. Argument must be one of - <option>console</option>, - <option>syslog</option>, - <option>kmsg</option>, - <option>syslog-or-kmsg</option>, - <option>null</option>.</para></listitem> - </varlistentry> - <varlistentry> <term><option>--log-color=</option></term> <listitem><para>Highlight important @@ -715,6 +737,87 @@ </refsect1> <refsect1> + <title>Kernel Command Line</title> + + <para>When run as system instance systemd parses a few kernel command line arguments:</para> + + <variablelist> + <varlistentry> + <term><varname>systemd.unit=</varname></term> + + <listitem><para>Overrides the unit to + activate on boot. Defaults to + <filename>default.target</filename>. This + may be used to temporarily boot into a + different boot unit, for example + <filename>rescue.target</filename> or + <filename>emergency.service</filename>. See + <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> + for details about these + units.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.log_target=</varname></term> + <term><varname>systemd.log_level=</varname></term> + <term><varname>systemd.log_color=</varname></term> + <term><varname>systemd.log_location=</varname></term> + + <listitem><para>Controls log output, + with the same effect as the + <varname>$SYSTEMD_LOG_TARGET</varname>, <varname>$SYSTEMD_LOG_LEVEL</varname>, <varname>$SYSTEMD_LOG_COLOR</varname>, <varname>$SYSTEMD_LOG_LOCATION</varname> + environment variables described above.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.dump_core=</varname></term> + + <listitem><para>Takes a boolean + argument. If <option>true</option> + systemd dumps core when it + crashes. Otherwise no core dump is + created. Defaults to + <option>true</option>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.crash_shell=</varname></term> + + <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 + <option>false</option>, for security + reasons, as the shell is not protected + by any password + authentication.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.crash_chvt=</varname></term> + + <listitem><para>Takes an integer + argument. If positive systemd + activates the specified virtual + terminal when it crashes. Defaults to + <literal>-1</literal>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.show_status=</varname></term> + + <listitem><para>Takes a boolean + argument. If <option>true</option> + shows terse service status updates on + the console during bootup. Defaults to + <option>true</option>.</para></listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> <title>Sockets and FIFOs</title> <variablelist> |