diff options
author | Jakub Hrozek <jhrozek@redhat.com> | 2009-05-28 22:46:35 +0200 |
---|---|---|
committer | Simo Sorce <ssorce@redhat.com> | 2009-06-01 11:07:38 -0400 |
commit | e1659895d7e7a1c161d7b6117c898e0ee3b62190 (patch) | |
tree | 7d38b5546f5ea7964b4772e31c397c8b73fbf318 /server | |
parent | e3a277bd60661365844287a74a8c1505995ea7e9 (diff) | |
download | sssd-e1659895d7e7a1c161d7b6117c898e0ee3b62190.tar.gz sssd-e1659895d7e7a1c161d7b6117c898e0ee3b62190.tar.xz sssd-e1659895d7e7a1c161d7b6117c898e0ee3b62190.zip |
Add more manpages
Diffstat (limited to 'server')
-rw-r--r-- | server/Makefile.am | 4 | ||||
-rw-r--r-- | server/man/sss_groupadd.8.xml | 78 | ||||
-rw-r--r-- | server/man/sss_groupdel.8.xml | 67 | ||||
-rw-r--r-- | server/man/sss_groupmod.8.xml | 92 | ||||
-rw-r--r-- | server/man/sss_useradd.8.xml | 19 | ||||
-rw-r--r-- | server/man/sss_userdel.8.xml | 67 | ||||
-rw-r--r-- | server/man/sss_usermod.8.xml | 147 | ||||
-rw-r--r-- | server/man/sssd.8.xml | 125 |
8 files changed, 591 insertions, 8 deletions
diff --git a/server/Makefile.am b/server/Makefile.am index 2caf4f2ca..31173a0ea 100644 --- a/server/Makefile.am +++ b/server/Makefile.am @@ -399,7 +399,9 @@ DOCBOOK_XSLT = http://docbook.sourceforge.net/release/xsl/current/manpages/docbo XMLLINT_FLAGS = --catalogs --postvalid --nonet --xinclude --noout XSLTPROC_FLAGS = --catalogs --xinclude --nonet -dist_man_MANS = man/sss_useradd.8 +dist_man_MANS = man/sss_useradd.8 man/sss_userdel.8 man/sss_usermod.8 \ + man/sss_groupadd.8 man/sss_groupdel.8 man/sss_groupmod.8 \ + man/sssd.8 SUFFIXES = .1.xml .1 .3.xml .3 .5.xml .5 .8.xml .8 .1.xml.1: diff --git a/server/man/sss_groupadd.8.xml b/server/man/sss_groupadd.8.xml new file mode 100644 index 000000000..919662040 --- /dev/null +++ b/server/man/sss_groupadd.8.xml @@ -0,0 +1,78 @@ +<?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_groupadd</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv id='name'> + <refname>sss_groupadd</refname> + <refpurpose>create a new group</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>sss_groupadd</command> + <arg choice='opt'> + <replaceable>options</replaceable> + </arg> + <arg choice='plain'><replaceable>GROUP</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>sss_groupadd</command> creates a new group. These groups are compatible + with POSIX groups, with the additional feature that they can contain other groups + as members. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist remap='IP'> + <varlistentry> + <term> + <option>-g</option>,<option>--gid</option> + <replaceable>GID</replaceable> + </term> + <listitem> + <para> + Set the GID of the group to the value of <replaceable>GID</replaceable>. + If not given, it is chosen automatically. + </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>sss_groupdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> +</refentry> +</reference> diff --git a/server/man/sss_groupdel.8.xml b/server/man/sss_groupdel.8.xml new file mode 100644 index 000000000..83a05d964 --- /dev/null +++ b/server/man/sss_groupdel.8.xml @@ -0,0 +1,67 @@ +<?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_groupdel</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv id='name'> + <refname>sss_groupdel</refname> + <refpurpose>create a new group</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>sss_groupdel</command> + <arg choice='opt'> + <replaceable>options</replaceable> + </arg> + <arg choice='plain'><replaceable>GROUP</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>sss_groupdel</command> deletes a group + identified by its name <replaceable>GROUP</replaceable> + from the system. Deleting a non-existent group is a no-op and + will not be reported as an error. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist remap='IP'> + <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>sss_groupadd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> +</refentry> +</reference> diff --git a/server/man/sss_groupmod.8.xml b/server/man/sss_groupmod.8.xml new file mode 100644 index 000000000..9a73f7db5 --- /dev/null +++ b/server/man/sss_groupmod.8.xml @@ -0,0 +1,92 @@ +<?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_groupmod</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv id='name'> + <refname>sss_groupmod</refname> + <refpurpose>modify a group</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>sss_groupmod</command> + <arg choice='opt'> + <replaceable>options</replaceable> + </arg> + <arg choice='plain'><replaceable>GROUP</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>sss_groupmod</command> modifies the + group to reflect the changes that are specified on + the command line. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist remap='IP'> + <varlistentry> + <term> + <option>-a</option>,<option>--append-group</option> + <replaceable>GROUPS</replaceable> + </term> + <listitem> + <para> + Append this group to groups specified by the + <replaceable>GROUPS</replaceable> parameter. + The <replaceable>GROUPS</replaceable> parameter + is a comma separated list of group names. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-r</option>,<option>--remove-group</option> + <replaceable>GROUPS</replaceable> + </term> + <listitem> + <para> + Remove this group from groups specified by the + <replaceable>GROUPS</replaceable> parameter. + </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>sss_groupdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupadd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> +</refentry> +</reference> diff --git a/server/man/sss_useradd.8.xml b/server/man/sss_useradd.8.xml index 98bd72724..039c8487d 100644 --- a/server/man/sss_useradd.8.xml +++ b/server/man/sss_useradd.8.xml @@ -29,7 +29,7 @@ <refsect1 id='description'> <title>DESCRIPTION</title> <para> - <command>sss_useradd</command> command creates a new user account using + <command>sss_useradd</command> creates a new user account using the values specified on the command line plus the default values from the system. </para> @@ -84,7 +84,9 @@ <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. + to <filename>/home</filename> and use that as the home directory. + The base that is prepended before <replaceable>LOGIN</replaceable> is tunable + with <quote>user_defaults/baseDirectory</quote> setting in sssd.conf. </para> </listitem> </varlistentry> @@ -96,6 +98,9 @@ <listitem> <para> The user's login shell. The default is currently <filename>/bin/bash</filename>. + The default can be changed with + <quote>user_defaults/defaultShell</quote> setting + in sssd.conf. </para> </listitem> </varlistentry> @@ -118,19 +123,19 @@ <title>SEE ALSO</title> <para> <citerefentry> - <refentrytitle>groupadd</refentrytitle><manvolnum>8</manvolnum> + <refentrytitle>sss_groupadd</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citerefentry> - <refentrytitle>groupdel</refentrytitle><manvolnum>8</manvolnum> + <refentrytitle>sss_groupdel</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citerefentry> - <refentrytitle>groupmod</refentrytitle><manvolnum>8</manvolnum> + <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citerefentry> - <refentrytitle>userdel</refentrytitle><manvolnum>8</manvolnum> + <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citerefentry> - <refentrytitle>usermod</refentrytitle><manvolnum>8</manvolnum> + <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum> </citerefentry>. </para> </refsect1> diff --git a/server/man/sss_userdel.8.xml b/server/man/sss_userdel.8.xml new file mode 100644 index 000000000..10fbeb134 --- /dev/null +++ b/server/man/sss_userdel.8.xml @@ -0,0 +1,67 @@ +<?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_userdel</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv id='name'> + <refname>sss_userdel</refname> + <refpurpose>delete a user account</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>sss_userdel</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_userdel</command> deletes a user + identified by login name <replaceable>LOGIN</replaceable> + from the system. Deleting a non-existent user is a no-op and + will not be reported as an error. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist remap='IP'> + <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>sss_groupadd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> +</refentry> +</reference> diff --git a/server/man/sss_usermod.8.xml b/server/man/sss_usermod.8.xml new file mode 100644 index 000000000..4a8d3bb99 --- /dev/null +++ b/server/man/sss_usermod.8.xml @@ -0,0 +1,147 @@ +<?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_usermod</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv id='name'> + <refname>sss_usermod</refname> + <refpurpose>modify a user account</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>sss_usermod</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_usermod</command> modifies the + account specified by <replaceable>LOGIN</replaceable> + to reflect the changes that are specified on the command line. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist remap='IP'> + <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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-s</option>,<option>--shell</option> + <replaceable>SHELL</replaceable> + </term> + <listitem> + <para> + The user's login shell. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-a</option>,<option>--append-group</option> + <replaceable>GROUPS</replaceable> + </term> + <listitem> + <para> + Append this user to groups specified by the + <replaceable>GROUPS</replaceable> parameter. + The <replaceable>GROUPS</replaceable> parameter + is a comma separated list of group names. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-r</option>,<option>--remove-group</option> + <replaceable>GROUPS</replaceable> + </term> + <listitem> + <para> + Remove this user from groups specified by the + <replaceable>GROUPS</replaceable> parameter. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-l</option>,<option>--lock</option> + </term> + <listitem> + <para> + Lock the user account. The user won't be able + to log in. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-u</option>,<option>--unlock</option> + </term> + <listitem> + <para> + Unlock the user account. + </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>sss_groupadd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> +</refentry> +</reference> diff --git a/server/man/sssd.8.xml b/server/man/sssd.8.xml new file mode 100644 index 000000000..06f3c5c7a --- /dev/null +++ b/server/man/sssd.8.xml @@ -0,0 +1,125 @@ +<?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>sssd</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv id='name'> + <refname>sssd</refname> + <refpurpose>System Security Services Daemon</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>sssd</command> + <arg choice='opt'> + <replaceable>options</replaceable> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>SSSD</command> provides a set of daemons to manage access to remote + directories and authentication mechanisms. It provides an NSS and + PAM interface toward the system and a pluggable backend system to + connect to multiple different account sources as well as D-Bus + interface. It is also the basis to provide client auditing and + policy services for projects like FreeIPA. It provides a more robust database + to store local users as well as extended user data. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist remap='IP'> + <varlistentry> + <term> + <option>-d</option>,<option>--debug-level</option> + <replaceable>LEVEL</replaceable> + </term> + <listitem> + <para> + Debug level to run the daemon with. 0 is the default as well + as the lowest allowed value, 10 is the most verbose mode. This setting + overrides the settings from config file. This parameter implies <option>-i</option>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-D</option>,<option>--daemon</option> + </term> + <listitem> + <para> + Become a daemon after starting up. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-i</option>,<option>--interactive</option> + </term> + <listitem> + <para> + Run in the foreground, don't become a daemon. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>-c</option>,<option>--config</option> + </term> + <listitem> + <para> + Specify a non-default config file. The default is + <filename>/etc/sssd/sssd.conf</filename>. For reference + on the config file syntax and options, consult the + <citerefentry> + <refentrytitle>sssd.conf</refentrytitle> + <manvolnum>5</manvolnum> + </citerefentry> + manual page. + </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>sssd.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupadd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_useradd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> +</refentry> +</reference> |