man/systemd-sysusers.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2014 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-sysusers"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27         <refentryinfo>
  28                 <title>systemd-sysusers</title>
  29                 <productname>systemd</productname>
  30
  31                 <authorgroup>
  32                         <author>
  33                                 <contrib>Developer</contrib>
  34                                 <firstname>Lennart</firstname>
  35                                 <surname>Poettering</surname>
  36                                 <email>lennart@poettering.net</email>
  37                         </author>
  38                 </authorgroup>
  39         </refentryinfo>
  40
  41         <refmeta>
  42                 <refentrytitle>systemd-sysusers</refentrytitle>
  43                 <manvolnum>8</manvolnum>
  44         </refmeta>
  45
  46         <refnamediv>
  47                 <refname>systemd-sysusers</refname>
  48                 <refname>systemd-sysusers.service</refname>
  49                 <refpurpose>Allocate system users and groups</refpurpose>
  50         </refnamediv>
  51
  52         <refsynopsisdiv>
  53                 <cmdsynopsis>
  54                         <command>systemd-sysusers</command>
  55                         <arg choice="opt" rep="repeat">OPTIONS</arg>
  56                         <arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg>
  57                 </cmdsynopsis>
  58
  59                 <para><filename>systemd-sysusers.service</filename></para>
  60         </refsynopsisdiv>
  61
  62         <refsect1>
  63                 <title>Description</title>
  64
  65                 <para><command>systemd-sysusers</command> creates
  66                 system users and groups, based on the file format and
  67                 location specified in
  68                 <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  69                 </para>
  70
  71                 <para>If invoked with no arguments, it applies all
  72                 directives from all files found. If one or more
  73                 filenames are passed on the command line, only the
  74                 directives in these files are applied. If only the
  75                 basename of a file is specified, all directories as
  76                 specified in
  77                 <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  78                 are searched for a matching file. If the string
  79                 <filename>-</filename> is specified as filenames
  80                 entries from the standard input of the process are
  81                 read.</para>
  82         </refsect1>
  83
  84         <refsect1>
  85                 <title>Options</title>
  86
  87                 <para>The following options are understood:</para>
  88
  89                 <variablelist>
  90                         <varlistentry>
  91                                 <term><option>--root=<replaceable>root</replaceable></option></term>
  92                                 <listitem><para>Takes a directory path
  93                                 as an argument. All paths will be
  94                                 prefixed with the given alternate <replaceable>root</replaceable>
  95                                 path, including config search paths.
  96                                 </para></listitem>
  97                         </varlistentry>
  98
  99                         <xi:include href="standard-options.xml" xpointer="help" />
 100                         <xi:include href="standard-options.xml" xpointer="version" />
 101                 </variablelist>
 102
 103         </refsect1>
 104
 105         <refsect1>
 106                 <title>Exit status</title>
 107
 108                 <para>On success, 0 is returned, a non-zero failure
 109                 code otherwise.</para>
 110         </refsect1>
 111
 112         <refsect1>
 113                 <title>See Also</title>
 114                 <para>
 115                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 116                         <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 117                 </para>
 118         </refsect1>
 119
 120 </refentry>