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