diff options
author | Jakub Hrozek <jhrozek@redhat.com> | 2009-05-10 23:02:21 +0200 |
---|---|---|
committer | Simo Sorce <ssorce@redhat.com> | 2009-05-14 11:41:10 -0400 |
commit | ca2fa90f8e7a9399c7c44781f1a032fe10f98cdc (patch) | |
tree | ae2ba67c79ac782d9c9e1250f7657dc88fdd43f3 /server/man | |
parent | 50c10e1f61a1bef93a7f768ad6edb28989f1761b (diff) | |
download | sssd-ca2fa90f8e7a9399c7c44781f1a032fe10f98cdc.tar.gz sssd-ca2fa90f8e7a9399c7c44781f1a032fe10f98cdc.tar.bz2 sssd-ca2fa90f8e7a9399c7c44781f1a032fe10f98cdc.zip |
Manpage generation
Provides a set of make rules for generating UNIX manual pages from
DocBook 4.5 source as well as sample manpage for sss_useradd.
Automatic generation of manual pages during "make" process is
tunable with config parameter "--with-manpages". To rebuild the man
pages separately, use the "make doc" target. Before building, the
manpages are validated using a DTD schema.
Diffstat (limited to 'server/man')
-rw-r--r-- | server/man/include/param_help.xml | 10 | ||||
-rw-r--r-- | server/man/include/upstream.xml | 4 | ||||
-rw-r--r-- | server/man/sss_useradd.8.xml | 138 |
3 files changed, 152 insertions, 0 deletions
diff --git a/server/man/include/param_help.xml b/server/man/include/param_help.xml new file mode 100644 index 00000000..a2478bf2 --- /dev/null +++ b/server/man/include/param_help.xml @@ -0,0 +1,10 @@ +<varlistentry> + <term> + <option>-h</option>,<option>--help</option> + </term> + <listitem> + <para> + Display help message and exit. + </para> + </listitem> +</varlistentry> diff --git a/server/man/include/upstream.xml b/server/man/include/upstream.xml new file mode 100644 index 00000000..b6f633cc --- /dev/null +++ b/server/man/include/upstream.xml @@ -0,0 +1,4 @@ +<refentryinfo> + <productname>SSSD</productname> + <orgname>The SSSD upstream - http://fedorahosted.org/sssd</orgname> +</refentryinfo> diff --git a/server/man/sss_useradd.8.xml b/server/man/sss_useradd.8.xml new file mode 100644 index 00000000..98bd7272 --- /dev/null +++ b/server/man/sss_useradd.8.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.5//EN" +"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<reference> +<title>SSSD Manual pages</title> +<refentry> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" /> + + <refmeta> + <refentrytitle>sss_useradd</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv id='name'> + <refname>sss_useradd</refname> + <refpurpose>create a new user</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>sss_useradd</command> + <arg choice='opt'> + <replaceable>options</replaceable> + </arg> + <arg choice='plain'><replaceable>LOGIN</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>sss_useradd</command> command creates a new user account using + the values specified on the command line plus the default values from + the system. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist remap='IP'> + <varlistentry> + <term> + <option>-u</option>,<option>--uid</option> + <replaceable>UID</replaceable> + </term> + <listitem> + <para> + Set the UID of the user to the value of <replaceable>UID</replaceable>. + If not given, it is chosen automatically. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-g</option>,<option>--gid</option> + <replaceable>GID</replaceable> + </term> + <listitem> + <para> + Set the GID or group membership of the user to the value + of <replaceable>GID</replaceable>. If not given, it is + chosen automatically. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-c</option>,<option>--gecos</option> + <replaceable>COMMENT</replaceable> + </term> + <listitem> + <para> + Any text string describing the user. Often used as + the field for the user's full name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-h</option>,<option>--home</option> + <replaceable>HOME_DIR</replaceable> + </term> + <listitem> + <para> + The home directory of the user account. + The default is to append the <replaceable>LOGIN</replaceable> name + to <filename>/home</filename> and use that as the login directory name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-s</option>,<option>--shell</option> + <replaceable>SHELL</replaceable> + </term> + <listitem> + <para> + The user's login shell. The default is currently <filename>/bin/bash</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-G</option>,<option>--groups</option> + <replaceable>GROUPS</replaceable> + </term> + <listitem> + <para> + A list of existing groups this user is also a member of. + </para> + </listitem> + </varlistentry> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" /> + </variablelist> + </refsect1> + + <refsect1 id='see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>groupadd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>groupdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>groupmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>userdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>usermod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> +</refentry> +</reference> |