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 system users and
  66     groups, based on the file format and location specified in
  67     <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  68     </para>
  69
  70     <para>If invoked with no arguments, it applies all directives from
  71     all files found. If one or more filenames are passed on the
  72     command line, only the directives in these files are applied. If
  73     only the basename of a file is specified, all directories as
  74     specified in
  75     <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  76     are searched for a matching file. If the string
  77     <filename>-</filename> is specified as filename, entries from the
  78     standard input of the process are read.</para>
  79   </refsect1>
  80
  81   <refsect1>
  82     <title>Options</title>
  83
  84     <para>The following options are understood:</para>
  85
  86     <variablelist>
  87       <varlistentry>
  88         <term><option>--root=<replaceable>root</replaceable></option></term>
  89         <listitem><para>Takes a directory path as an argument. All
  90         paths will be prefixed with the given alternate
  91         <replaceable>root</replaceable> path, including config search
  92         paths. </para></listitem>
  93       </varlistentry>
  94
  95       <xi:include href="standard-options.xml" xpointer="help" />
  96       <xi:include href="standard-options.xml" xpointer="version" />
  97     </variablelist>
  98
  99   </refsect1>
 100
 101   <refsect1>
 102     <title>Exit status</title>
 103
 104     <para>On success, 0 is returned, a non-zero failure code
 105     otherwise.</para>
 106   </refsect1>
 107
 108   <refsect1>
 109     <title>See Also</title>
 110     <para>
 111       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 112       <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 113     </para>
 114   </refsect1>
 115
 116 </refentry>