diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/kernel-install.xml | 166 | ||||
| -rw-r--r-- | man/logind.conf.xml | 25 | ||||
| -rw-r--r-- | man/systemctl.xml | 118 | ||||
| -rw-r--r-- | man/systemd-activate.xml | 171 | ||||
| -rw-r--r-- | man/systemd-nspawn.xml | 48 | ||||
| -rw-r--r-- | man/systemd-system.conf.xml | 19 |
6 files changed, 519 insertions, 28 deletions
diff --git a/man/kernel-install.xml b/man/kernel-install.xml new file mode 100644 index 0000000000..93dc0ae4fd --- /dev/null +++ b/man/kernel-install.xml @@ -0,0 +1,166 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!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 2013 Harald Hoyer + +systemd is free software; you can redistribute it and/or modify it +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 +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public License +along with systemd; If not, see <http://www.gnu.org/licenses/>. +--> + +<refentry id="kernel-install"> + + <refentryinfo> + <title>kernel-install</title> + <productname>systemd</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Harald</firstname> + <surname>Hoyer</surname> + <email>harald@redhat.com</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>kernel-install</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>kernel-install</refname> + <refpurpose>Add and remove kernel and initramfs images to and from /boot</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>kernel-install</command> <arg choice="req">COMMAND</arg> <arg choice="req">KERNEL VERSION</arg> <arg choice="req">KERNEL IMAGE</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + <command>kernel-install</command> is used to install and remove kernel and + initramfs images to and from <filename>/boot</filename>. + </para> + + <para>kernel-install will execute the files located in the directory <filename>/usr/lib/kernel/install.d/</filename> + and the local administration directory <filename>/etc/kernel/install.d/</filename>. + All files are collectively sorted and executed in lexical order, regardless of the directories in + which they live. However, files with identical file names replace each other. + Files in <filename>/etc/kernel/install.d/</filename> take precedence over files with the same name + in <filename>/usr/lib/kernel/install.d/</filename>. This can be used to override a system-supplied + executables with a local file if needed; a symbolic link in <filename>/etc/kernel/install.d/</filename> + with the same name as an executable in <filename>/usr/lib/kernel/install.d/</filename>, + pointing to /dev/null, disables the executable entirely. Executables must have the + extension .install; other extensions are ignored.</para> + + </refsect1> + + <refsect1> + <title>Commands</title> + <para>The following commands are understood:</para> + <variablelist> + <varlistentry> + <term>add <KERNEL VERSION> <KERNEL IMAGE></term> + <listitem> + <para>calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename> + and <filename>/etc/kernel/install.d/*.install</filename> with the arguments + "add <KERNEL VERSION> <filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/</filename>"</para> + + <para>kernel-install copies <KERNEL IMAGE> to + <filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/linux</filename>.</para> + + <para>kernel-install also creates a boot loader entry according to the boot loader specification + in <filename>/boot/loader/entries/<OS-ID>-<KERNEL VERSION>-<MACHINE-ID>.conf</filename>. + If the file <filename>initrd</filename> is found next to the <filename>linux</filename> file, + the initrd will be added to the configuration.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>remove <KERNEL VERSION> <KERNEL IMAGE></term> + <listitem><para>calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename> + and <filename>/etc/kernel/install.d/*.install</filename> with the arguments: + "remove <KERNEL VERSION> <filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/</filename>" + </para> + <para>kernel-install removes the entire directory <filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/</filename> + and the file <filename>/boot/loader/entries/<OS-ID>-<KERNEL VERSION>-<MACHINE-ID>.conf</filename></para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1> + <title>Exit status</title> + <para>If every executable returns with 0, 0 is returned, a non-zero failure code otherwise.</para> + </refsect1> + + <refsect1> + <title>Files</title> + <variablelist> + <varlistentry> + <term> + <filename>/usr/lib/kernel/install.d/*.install</filename> + <filename>/etc/kernel/install.d/*.install</filename> + </term> + <listitem> + <para>Drop-in files, which are executed by kernel-install.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <filename>/etc/kernel/cmdline</filename> + <filename>/proc/cmdline</filename> + </term> + <listitem> + <para>The contents of the file <filename>/etc/kernel/cmdline</filename> specifies the kernel command line to use. + If that file does not exist, <filename>/proc/cmdline</filename> is used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <filename>/etc/machine-id</filename> + </term> + <listitem> + <para>The contents of the file specifies the machine identifaction <MACHINE-ID>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <filename>/etc/os-release</filename> + </term> + <listitem> + <para>The contents of the file specifies the the operating system id <OS-ID>.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink> + </para> + </refsect1> + +</refentry> diff --git a/man/logind.conf.xml b/man/logind.conf.xml index 96e5936e5e..362a4f6108 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -207,10 +207,17 @@ <listitem><para>These settings control the default control group hierarchies - users logging in are added to. When - logging in users will get private - control groups in all hierarchies - listed in + users logging in are added to, in + addition to the + <literal>name=systemd</literal> named + hierarchy. These settings take space + separated lists of controller + names. Pass the empty string to ensure + that logind does not touch any + hierarchies but systemd's own. When + logging in user sessions will get + private control groups in all + hierarchies listed in <varname>Controllers=</varname> and be reset to the root control group in all hierarchies listed in @@ -218,7 +225,15 @@ defaults to the empty list, <varname>ResetControllers=</varname> defaults to - <literal>cpu</literal>.</para></listitem> + <literal>cpu</literal>. Note that for + all controllers that are not listed in + either <varname>Controllers=</varname> + nor + <varname>ResetControllers=</varname> + newly created sessions will be part of + the control groups of the system + service that created the + session.</para></listitem> </varlistentry> <varlistentry> diff --git a/man/systemctl.xml b/man/systemctl.xml index 39229a0075..5656564f54 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -117,10 +117,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <term><option>--property=</option></term> <listitem> - <para>When showing unit/job/manager properties, limit - display to certain properties as specified as argument. If - not specified all set properties are shown. The argument - should be a comma-seperated list of property names, such as + <para>When showing unit/job/manager properties with the + <command>show</command> command, limit display to certain + properties as specified as argument. If not specified all + set properties are shown. The argument should be a + comma-seperated list of property names, such as <literal>MainPID</literal>. If specified more than once all properties with the specified names are shown.</para> </listitem> @@ -206,7 +207,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. sleep state. Any user may take these locks and privileged users may override these locks. If any locks are taken, shutdown and sleep state requests will normally fail - (regardless if privileged or not) and list of active locks + (regardless if privileged or not) and a list of active locks is printed. However if <option>--ignore-inhibitors</option> is specified the locks are ignored and not printed, and the operation attempted anyway, possibly requiring additional @@ -392,14 +393,22 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <term><option>--runtime</option></term> <listitem> - <para>When used with - <command>enable</command>/<command>disable</command>/<command>is-enabled</command> + <para>When used with <command>enable</command>, + <command>disable</command>, <command>is-enabled</command> (and related commands), make changes only temporarily, so - that they are dropped on the next reboot. This will have the + that they are lost on the next reboot. This will have the effect that changes are not made in subdirectories of <filename>/etc</filename> but in <filename>/run</filename>, with identical immediate effects, however, since the latter is lost on reboot, the changes are lost too.</para> + + <para>Similar, when used with + <command>set-cgroup-attr</command>, + <command>unset-cgroup-attr</command>, + <command>set-cgroup</command> and + <command>unset-cgroup</command>, make changes only + temporarily, so that they are lost on the next + reboot.</para> </listitem> </varlistentry> @@ -631,6 +640,98 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. human-readable output.</para> </listitem> </varlistentry> + + <varlistentry> + <term><command>get-cgroup-attr <replaceable>NAME</replaceable> <replaceable>ATTRIBUTE</replaceable>...</command></term> + + <listitem> + <para>Retrieve the specified control group attributes of the + specified unit. Takes a unit name and one or more attribute + names such as <literal>cpu.shares</literal>. This will + output the current values of the specified attributes, + separated by new-lines. For attributes that take list of + items the output will be new-line separated, too. This + operation will always try to retrieve the data in question + from the kernel first, and if that is not available use the + configured values instead. Instead of low-level control + group attribute names high-level pretty names may be used, + as used for unit execution environment configuration, see + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details. For example, passing + <literal>memory.limit_in_bytes</literal> and + <literal>MemoryLimit</literal> is equivalent.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>set-cgroup-attr <replaceable>NAME</replaceable> <replaceable>ATTRIBUTE</replaceable> <replaceable>VALUE</replaceable>...</command></term> + + <listitem> + <para>Set the specified control group attribute of the + specified unit to the specified value. Takes a unit + name and an attribute name such as + <literal>cpu.shares</literal>, plus one or more values + (multiple values may only be used for attributes that take + multiple values). This operation will immediately update the + kernel attribute for this unit and persistently store this + setting for later reboots (unless <option>--runtime</option> + is passed, in which case the setting is not saved + persistently and only valid until the next reboot.) Instead + of low-level control group attribute names high-level pretty + names may be used, as used for unit execution environment + configuration, see + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details. For example, passing + <literal>memory.limit_in_bytes</literal> and + <literal>MemoryLimit</literal> is equivalent. This operation + will implicitly create a control group for the unit in the + controller the attribute belongs to, if needed. For + attributes that take multiple values, this operation will + append the specified values to the previously set values + list (use <command>unset-cgroup-attr</command> to reset the + list explicitly). For attributes that take a single value + only the list will be reset implicitly.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>unset-cgroup-attr <replaceable>NAME</replaceable> <replaceable>ATTRIBUTE</replaceable>...</command></term> + + <listitem><para>Unset the specified control group attributes + of the specified unit. Takes a unit name and one or more + attribut names such as <literal>cpu.shares</literal>. This + operation might or might not have an immediate effect on the + current kernel attribute value. This will remove any + persistently stored configuration values for this attribute + (as set with <command>set-cgroup-attr</command> before), + unless <option>--runtime</option> is passed, in which case the + configuration is reset only until the next reboot. Again, + high-level control group attributes may be used instead of the + low-level kernel ones. For attributes which take multiple + values, all currently set values are reset.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>set-cgroup <replaceable>NAME</replaceable> <replaceable>CGROUP</replaceable>...</command></term> + <term><command>unset-cgroup <replaceable>NAME</replaceable> <replaceable>CGROUP</replaceable>...</command></term> + + <listitem><para>Add or remove a unit to/from a specific + control group hierarchy and/or control group path. Takes a + unit name, plus a control group specification in the syntax + <replaceable>CONTROLLER</replaceable>:<replaceable>PATH</replaceable> + or <replaceable>CONTROLLER</replaceable>. In the latter syntax + (where the path is ommitted) the default unit control group + path is implied. Examples: <literal>cpu</literal> or + <literal>cpu:/foo/bar</literal>. If a unit is removed from a + control group hierarchy all its processes will be moved to the + root group of the hierarchy and all control group attributes + will be reset. These operations are immediately reflected in + the kernel hierarchy, and stored persistently to disk (unless + <option>--runtime</option> is passed).</para> + </listitem> + </varlistentry> + <varlistentry> <term><command>help <replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...</command></term> @@ -641,6 +742,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. shown.</para> </listitem> </varlistentry> + <varlistentry> <term><command>reset-failed [<replaceable>NAME</replaceable>...]</command></term> diff --git a/man/systemd-activate.xml b/man/systemd-activate.xml new file mode 100644 index 0000000000..6949731f64 --- /dev/null +++ b/man/systemd-activate.xml @@ -0,0 +1,171 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!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 2013 Zbigniew Jędrzejewski-Szmek + +systemd is free software; you can redistribute it and/or modify it +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 +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public License +along with systemd; If not, see <http://www.gnu.org/licenses/>. +--> + +<refentry id="systemd-journal-gatewayd.service"> + + <refentryinfo> + <title>systemd-activate</title> + <productname>systemd</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Zbigniew</firstname> + <surname>Jędrzejewski-Szmek</surname> + <email>zbyszek@in.waw.pl</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-activate</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-activate</refname> + <refpurpose>Test socket activation of daemons</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>/usr/lib/systemd/systemd-activate</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="plain"><replaceable>daemon</replaceable></arg> + <arg choice="opt" rep="repeat">OPTIONS</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>systemd-activate</command> can be used to + launch a socket activated daemon from the command-line for + testing purposes. It can also be used to launch single instances + of the daemon per connection (inetd-style). + </para> + + <para>The daemon to launch and its options should be specifed + after options intended for <command>systemd-activate</command>. + </para> + + <para>If the <option>-a</option> option is given, file descriptor + of the connection will be used as the standard input and output of + the launched process. Otherwise, standard input and output will be + inherited, and sockets will be passed through file descriptors 3 + and higher. Sockets passed through <varname>$LISTEN_FDS</varname> + to <command>systemd-activate</command> will be passed through to + the dameon, in the original positions. Other sockets specified + with <option>--listen</option> will use consecutive descriptors. + </para> + </refsect1> + + <refsect1> + <title>Options</title> + <variablelist> + <varlistentry> + <term><option>--help</option></term> + <term><option>-h</option></term> + + <listitem><para>Prints a short help + text and exits.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--version</option></term> + + <listitem><para>Prints a short version + string and exits.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-l</option></term> + <term><option>--listen=<replaceable>address</replaceable></option></term> + + <listitem><para>Listen on this <replaceable>address</replaceable>. + Takes a string like <literal>2000</literal> or + <literal>127.0.0.1:2001</literal>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-a</option></term> + <term><option>--accept</option></term> + + <listitem><para>Launch a separate instance of daemon per + connection and pass the connection socket as standard input + and standard output.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Environment variables</title> + <variablelist class='environment-variables'> + <varlistentry> + <term><varname>$LISTEN_FDS</varname></term> + <term><varname>$LISTEN_PID</varname></term> + + <listitem><para>See + <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</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>Same as in + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Example 1</title> + + <programlisting>$ /usr/lib/systemd/systemd-activate -l 2000 -a cat</programlisting> + + <para>This runs an echo server on port 2000.</para> + </refsect1> + + <refsect1> + <title>Example 2</title> + + <programlisting>$ /usr/lib/systemd/systemd-activate -l 19531 /usr/lib/systemd/systemd-journal-gatewayd</programlisting> + + <para>This runs a socket activated instance of + <citerefentry><refentrytitle>systemd-journal-gatewayd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 5cba40bcd4..8adcd946b0 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -51,7 +51,14 @@ <cmdsynopsis> <command>systemd-nspawn</command> <arg choice="opt" rep="repeat">OPTIONS</arg> - <arg choice="opt">COMMAND</arg> + <arg choice="opt"><replaceable>COMMAND</replaceable> + <arg choice="opt" rep="repeat">ARGS</arg> + </arg> + </cmdsynopsis> + <cmdsynopsis> + <command>systemd-nspawn</command> + <arg choice="plain">-b</arg> + <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">ARGS</arg> </cmdsynopsis> </refsynopsisdiv> @@ -131,10 +138,16 @@ <refsect1> <title>Options</title> - <para>If no arguments are passed the container is set - up and a shell started in it, otherwise the passed - command and arguments are executed in it. The - following options are understood:</para> + <para>If option <option>-b</option> is specified, the + arguments are used as arguments for the init + binary. Otherwise, <replaceable>COMMAND</replaceable> + specifies the program to launch in the container, and + the remaining arguments are used as arguments for this + program. If <option>-b</option> is not used and no + arguments are specifed, a shell is launched in the + container.</para> + + <para>The following options are understood:</para> <variablelist> <varlistentry> @@ -170,7 +183,10 @@ <listitem><para>Automatically search for an init binary and invoke it instead of a shell or a user supplied - program.</para></listitem> + program. If this option is used, arguments + specified on the command line are used + as arguments for the init binary. + </para></listitem> </varlistentry> <varlistentry> @@ -298,6 +314,26 @@ <listitem><para>Equivalent to <option>--link-journal=guest</option>.</para></listitem> </varlistentry> + + <varlistentry> + <term><option>--bind=</option></term> + <term><option>--bind-ro=</option></term> + + <listitem><para>Bind mount a file or + directory from the host into the + container. Either takes a path + argument -- in which case the + specified path will be mounted from + the host to the same path in the + container --, or a colon-separated + pair of paths -- in which case the + first specified path is the source in + the host, and the second path is the + destination in the container. The + <option>--bind-ro=</option> option + creates read-only bind + mount.</para></listitem> + </varlistentry> </variablelist> </refsect1> diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 12979d81b6..eaa770b4b1 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -107,15 +107,16 @@ <term><varname>DefaultControllers=cpu</varname></term> <listitem><para>Configures in which - cgroup controller hierarchies to - create per-service cgroups - automatically, in addition to the - name=systemd named hierarchy. Defaults - to 'cpu'. Takes a space separated list - of controller names. Pass an empty - string to ensure that systemd does not - touch any hierarchies but its - own.</para> + control group hierarchies to create + per-service cgroups automatically, in + addition to the + <literal>name=systemd</literal> named + hierarchy. Defaults to + <literal>cpu</literal>. Takes a space + separated list of controller + names. Pass the empty string to ensure + that systemd does not touch any + hierarchies but its own.</para> <para>Note that the default value of 'cpu' will make realtime scheduling |