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