summaryrefslogtreecommitdiff
path: root/docs/docbook
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook')
-rw-r--r--docs/docbook/smbdotconf/winbind/templatehomedir.xml28
-rw-r--r--docs/docbook/smbdotconf/winbind/templateshell.xml21
-rw-r--r--docs/docbook/smbdotconf/winbind/winbindcachetime.xml23
-rw-r--r--docs/docbook/smbdotconf/winbind/winbindenumgroups.xml35
-rw-r--r--docs/docbook/smbdotconf/winbind/winbindenumusers.xml39
-rw-r--r--docs/docbook/smbdotconf/winbind/winbindgid.xml26
-rw-r--r--docs/docbook/smbdotconf/winbind/winbindseparator.xml34
-rw-r--r--docs/docbook/smbdotconf/winbind/winbinduid.xml26
-rw-r--r--docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml31
9 files changed, 146 insertions, 117 deletions
diff --git a/docs/docbook/smbdotconf/winbind/templatehomedir.xml b/docs/docbook/smbdotconf/winbind/templatehomedir.xml
index a931e9b5a3..6c19617bab 100644
--- a/docs/docbook/smbdotconf/winbind/templatehomedir.xml
+++ b/docs/docbook/smbdotconf/winbind/templatehomedir.xml
@@ -1,13 +1,17 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="TEMPLATEHOMEDIR"/>template homedir (G)</term>
- <listitem><para>When filling out the user information for a Windows NT
- user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
- uses this parameter to fill in the home directory for that user.
- If the string <parameter moreinfo="none">%D</parameter> is present it is substituted
- with the user's Windows NT domain name. If the string <parameter moreinfo="none">%U
- </parameter> is present it is substituted with the user's Windows
- NT user name.</para>
+<samba:parameter name="template homedir"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>When filling out the user information for a Windows NT
+ user, the <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> daemon uses this
+ parameter to fill in the home directory for that user. If the
+ string <parameter moreinfo="none">%D</parameter> is present it
+ is substituted with the user's Windows NT domain name. If the
+ string <parameter moreinfo="none">%U</parameter> is present it
+ is substituted with the user's Windows NT user name.</para>
- <para>Default: <command moreinfo="none">template homedir = /home/%D/%U</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">template homedir = /home/%D/%U</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/templateshell.xml b/docs/docbook/smbdotconf/winbind/templateshell.xml
index e0b9f1a2ca..1104387331 100644
--- a/docs/docbook/smbdotconf/winbind/templateshell.xml
+++ b/docs/docbook/smbdotconf/winbind/templateshell.xml
@@ -1,10 +1,13 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="TEMPLATESHELL"/>template shell (G)</term>
- <listitem><para>When filling out the user information for a Windows NT
- user, the <citerefentry><refentrytitle>winbindd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> daemon
- uses this parameter to fill in the login shell for that user.</para>
+<samba:parameter name="template shell"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>When filling out the user information for a Windows NT
+ user, the <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> daemon uses this
+ parameter to fill in the login shell for that user.</para>
- <para>Default: <command moreinfo="none">template shell = /bin/false</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">template shell = /bin/false</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/winbindcachetime.xml b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml
index adbb8b12f6..3080adc7c8 100644
--- a/docs/docbook/smbdotconf/winbind/winbindcachetime.xml
+++ b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml
@@ -1,11 +1,14 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WINBINDCACHETIME"/>winbind cache time (G)</term>
- <listitem><para>This parameter specifies the number of
- seconds the <citerefentry><refentrytitle>winbindd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> daemon will cache
- user and group information before querying a Windows NT server
- again.</para>
+<samba:parameter name="winbind cache time"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter specifies the number of
+ seconds the <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> daemon will cache
+ user and group information before querying a Windows NT server
+ again.</para>
- <para>Default: <command moreinfo="none">winbind cache type = 15</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">winbind cache type = 15</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml b/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml
index 096c280fc2..1cffca7492 100644
--- a/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml
+++ b/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml
@@ -1,18 +1,21 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WINBINDENUMGROUPS"/>winbind enum groups (G)</term>
- <listitem><para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> it may be necessary to suppress
- the enumeration of groups through the <command moreinfo="none">setgrent()</command>,
- <command moreinfo="none">getgrent()</command> and
- <command moreinfo="none">endgrent()</command> group of system calls. If
- the <parameter moreinfo="none">winbind enum groups</parameter> parameter is
- <constant>no</constant>, calls to the <command moreinfo="none">getgrent()</command> system
- call will not return any data. </para>
+<samba:parameter name="winbind enum groups"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> it may be necessary to suppress
+ the enumeration of groups through the <command moreinfo="none">setgrent()</command>,
+ <command moreinfo="none">getgrent()</command> and
+ <command moreinfo="none">endgrent()</command> group of system calls. If
+ the <parameter moreinfo="none">winbind enum groups</parameter> parameter is
+ <constant>no</constant>, calls to the <command moreinfo="none">getgrent()</command> system
+ call will not return any data. </para>
- <para><emphasis>Warning:</emphasis> Turning off group
- enumeration may cause some programs to behave oddly.
- </para>
+ <para><emphasis>Warning:</emphasis> Turning off group
+ enumeration may cause some programs to behave oddly.
+ </para>
- <para>Default: <command moreinfo="none">winbind enum groups = yes </command>
- </para></listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">winbind enum groups = yes </command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/winbindenumusers.xml b/docs/docbook/smbdotconf/winbind/winbindenumusers.xml
index 7935755f0c..95f1e7ff4c 100644
--- a/docs/docbook/smbdotconf/winbind/winbindenumusers.xml
+++ b/docs/docbook/smbdotconf/winbind/winbindenumusers.xml
@@ -1,20 +1,23 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WINBINDENUMUSERS"/>winbind enum users (G)</term>
- <listitem><para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> it may be
- necessary to suppress the enumeration of users through the <command moreinfo="none">setpwent()</command>,
- <command moreinfo="none">getpwent()</command> and
- <command moreinfo="none">endpwent()</command> group of system calls. If
- the <parameter moreinfo="none">winbind enum users</parameter> parameter is
- <constant>no</constant>, calls to the <command moreinfo="none">getpwent</command> system call
- will not return any data. </para>
+<samba:parameter name="winbind enum users"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> it may be
+ necessary to suppress the enumeration of users through the <command moreinfo="none">setpwent()</command>,
+ <command moreinfo="none">getpwent()</command> and
+ <command moreinfo="none">endpwent()</command> group of system calls. If
+ the <parameter moreinfo="none">winbind enum users</parameter> parameter is
+ <constant>no</constant>, calls to the <command moreinfo="none">getpwent</command> system call
+ will not return any data. </para>
- <para><emphasis>Warning:</emphasis> Turning off user
- enumeration may cause some programs to behave oddly. For
- example, the finger program relies on having access to the
- full user list when searching for matching
- usernames. </para>
+ <para><emphasis>Warning:</emphasis> Turning off user
+ enumeration may cause some programs to behave oddly. For
+ example, the finger program relies on having access to the
+ full user list when searching for matching
+ usernames. </para>
- <para>Default: <command moreinfo="none">winbind enum users = yes </command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">winbind enum users = yes </command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/winbindgid.xml b/docs/docbook/smbdotconf/winbind/winbindgid.xml
index a8a9683b01..a8414e9e8c 100644
--- a/docs/docbook/smbdotconf/winbind/winbindgid.xml
+++ b/docs/docbook/smbdotconf/winbind/winbindgid.xml
@@ -1,14 +1,16 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WINBINDGID"/>winbind gid (G)</term>
- <listitem><para>The winbind gid parameter specifies the range of group
- ids that are allocated by the <citerefentry><refentrytitle>winbindd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> daemon. This range of group ids should have no
- existing local or NIS groups within it as strange conflicts can
- occur otherwise.</para>
+<samba:parameter name="winbind gid"
+ context="G"
+ advanced="1" developer="1" hide="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>The winbind gid parameter specifies the range of group
+ ids that are allocated by the <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> daemon. This range of group ids should have no
+ existing local or NIS groups within it as strange conflicts can
+ occur otherwise.</para>
- <para>Default: <command moreinfo="none">winbind gid = &lt;empty string&gt;
- </command></para>
+ <para>Default: <command moreinfo="none">winbind gid = &lt;empty string&gt;</command></para>
- <para>Example: <command moreinfo="none">winbind gid = 10000-20000</command></para>
- </listitem>
- </samba:parameter>
+ <para>Example: <command moreinfo="none">winbind gid = 10000-20000</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/winbindseparator.xml b/docs/docbook/smbdotconf/winbind/winbindseparator.xml
index 416adcb531..cefc69d5bd 100644
--- a/docs/docbook/smbdotconf/winbind/winbindseparator.xml
+++ b/docs/docbook/smbdotconf/winbind/winbindseparator.xml
@@ -1,17 +1,21 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WINBINDSEPARATOR"/>winbind separator (G)</term>
- <listitem><para>This parameter allows an admin to define the character
- used when listing a username of the form of <replaceable>DOMAIN
- </replaceable>\<replaceable>user</replaceable>. This parameter
- is only applicable when using the <filename moreinfo="none">pam_winbind.so</filename>
- and <filename moreinfo="none">nss_winbind.so</filename> modules for UNIX services.
- </para>
+<samba:parameter name="winbind separator"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter allows an admin to define the character
+ used when listing a username of the form of <replaceable>DOMAIN
+ </replaceable>\<replaceable>user</replaceable>. This parameter
+ is only applicable when using the <filename moreinfo="none">pam_winbind.so</filename>
+ and <filename moreinfo="none">nss_winbind.so</filename> modules for UNIX services.
+ </para>
- <para>Please note that setting this parameter to + causes problems
- with group membership at least on glibc systems, as the character +
- is used as a special character for NIS in /etc/group.</para>
+ <para>Please note that setting this parameter to + causes problems
+ with group membership at least on glibc systems, as the character +
+ is used as a special character for NIS in /etc/group.</para>
- <para>Default: <command moreinfo="none">winbind separator = '\'</command></para>
- <para>Example: <command moreinfo="none">winbind separator = +</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">winbind separator = '\'</command></para>
+
+ <para>Example: <command moreinfo="none">winbind separator = +</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/winbinduid.xml b/docs/docbook/smbdotconf/winbind/winbinduid.xml
index ecd7848f61..6fee40fcb8 100644
--- a/docs/docbook/smbdotconf/winbind/winbinduid.xml
+++ b/docs/docbook/smbdotconf/winbind/winbinduid.xml
@@ -1,14 +1,16 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WINBINDUID"/>winbind uid (G)</term>
- <listitem><para>The winbind gid parameter specifies the range of group
- ids that are allocated by the <citerefentry><refentrytitle>winbindd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> daemon. This range of ids should have no
- existing local or NIS users within it as strange conflicts can
- occur otherwise.</para>
+<samba:parameter name="winbind uid"
+ context="G"
+ advanced="1" developer="1" hide="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>The winbind gid parameter specifies the range of group
+ ids that are allocated by the <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> daemon. This range of ids should have no
+ existing local or NIS users within it as strange conflicts can
+ occur otherwise.</para>
- <para>Default: <command moreinfo="none">winbind uid = &lt;empty string&gt;
- </command></para>
+ <para>Default: <command moreinfo="none">winbind uid = &lt;empty string&gt;</command></para>
- <para>Example: <command moreinfo="none">winbind uid = 10000-20000</command></para>
- </listitem>
- </samba:parameter>
+ <para>Example: <command moreinfo="none">winbind uid = 10000-20000</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml b/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml
index a6b7bcd7e5..5c31a7f9b0 100644
--- a/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml
+++ b/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml
@@ -1,14 +1,19 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WINBINDUSEDEFAULTDOMAIN"/>winbind use default domain (G)</term>
- <listitem><para>This parameter specifies whether the <citerefentry><refentrytitle>winbindd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> daemon should operate on users
- without domain component in their username.
- Users without a domain component are treated as is part of the winbindd server's
- own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
- function in a way much closer to the way they would in a native unix system.</para>
+<samba:parameter name="winbind used default domain"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter specifies whether the
+ <citerefentry><refentrytitle>winbindd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> daemon should operate on users
+ without domain component in their username. Users without a domain
+ component are treated as is part of the winbindd server's own
+ domain. While this does not benifit Windows users, it makes SSH, FTP and
+ e-mail function in a way much closer to the way they
+ would in a native unix system.</para>
- <para>Default: <command moreinfo="none">winbind use default domain = &lt;no&gt;
- </command></para>
- <para>Example: <command moreinfo="none">winbind use default domain = yes</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">winbind use default domain = &lt;no&gt;</command></para>
+
+ <para>Example: <command moreinfo="none">winbind use default domain = yes</command></para>
+</listitem>
+</samba:parameter>