diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docbook/smbdotconf/misc/addsharecommand.xml | 90 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/autoservices.xml | 15 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/changesharecommand.xml | 88 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/configfile.xml | 37 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/defaultservice.xml | 48 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/deletesharecommand.xml | 79 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/lockdir.xml | 14 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/lockdirectory.xml | 24 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/piddirectory.xml | 20 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/preload.xml | 29 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/utmp.xml | 39 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/utmpdirectory.xml | 34 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/misc/wtmpdirectory.xml | 40 |
13 files changed, 311 insertions, 246 deletions
diff --git a/docs/docbook/smbdotconf/misc/addsharecommand.xml b/docs/docbook/smbdotconf/misc/addsharecommand.xml index 233d3e7dc4..bd5f2101db 100644 --- a/docs/docbook/smbdotconf/misc/addsharecommand.xml +++ b/docs/docbook/smbdotconf/misc/addsharecommand.xml @@ -1,51 +1,63 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="ADDSHARECOMMAND"/>add share command (G)</term> - <listitem><para>Samba 2.2.0 introduced the ability to dynamically - add and delete shares via the Windows NT 4.0 Server Manager. The - <parameter moreinfo="none">add share command</parameter> is used to define an - external program or script which will add a new service definition - to <filename moreinfo="none">smb.conf</filename>. In order to successfully - execute the <parameter moreinfo="none">add share command</parameter>, <command moreinfo="none">smbd</command> - requires that the administrator be connected using a root account (i.e. - uid == 0). - </para> +<samba:parameter name="add share command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba 2.2.0 introduced the ability to dynamically + add and delete shares via the Windows NT 4.0 Server Manager. The + <parameter moreinfo="none">add share command</parameter> is used to define an + external program or script which will add a new service definition + to <filename moreinfo="none">smb.conf</filename>. In order to successfully + execute the <parameter moreinfo="none">add share command</parameter>, <command moreinfo="none">smbd</command> + requires that the administrator be connected using a root account (i.e. + uid == 0). + </para> - <para> - When executed, <command moreinfo="none">smbd</command> will automatically invoke the - <parameter moreinfo="none">add share command</parameter> with four parameters. - </para> + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">add share command</parameter> with four parameters. + </para> - <itemizedlist> - <listitem><para><parameter moreinfo="none">configFile</parameter> - the location + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location of the global <filename moreinfo="none">smb.conf</filename> file. - </para></listitem> + </para> + </listitem> - <listitem><para><parameter moreinfo="none">shareName</parameter> - the name of the new + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of the new share. - </para></listitem> + </para> + </listitem> - <listitem><para><parameter moreinfo="none">pathName</parameter> - path to an **existing** + <listitem> + <para><parameter moreinfo="none">pathName</parameter> - path to an **existing** directory on disk. - </para></listitem> + </para> + </listitem> - <listitem><para><parameter moreinfo="none">comment</parameter> - comment string to associate + <listitem> + <para><parameter moreinfo="none">comment</parameter> - comment string to associate with the new share. - </para></listitem> - </itemizedlist> + </para> + </listitem> + </itemizedlist> - <para> - This parameter is only used for add file shares. To add printer shares, - see the <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none">addprinter - command</parameter></link>. - </para> + <para> + This parameter is only used for add file shares. To add printer shares, + see the <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none">addprinter + command</parameter></link>. + </para> - <para> - See also <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change share - command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete share - command</parameter></link>. - </para> + <para> + See also <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change share + command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete share + command</parameter></link>. + </para> - <para>Default: <emphasis>none</emphasis></para> - <para>Example: <command moreinfo="none">add share command = /usr/local/bin/addshare</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">add share command = /usr/local/bin/addshare</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/autoservices.xml b/docs/docbook/smbdotconf/misc/autoservices.xml index d137f650f8..d94997a6ce 100644 --- a/docs/docbook/smbdotconf/misc/autoservices.xml +++ b/docs/docbook/smbdotconf/misc/autoservices.xml @@ -1,6 +1,9 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="AUTOSERVICES"/>auto services (G)</term> - <listitem><para>This is a synonym for the <link linkend="PRELOAD"> - <parameter moreinfo="none">preload</parameter></link>.</para> - </listitem> - </samba:parameter> +<samba:parameter name="auto services" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a synonym for the <link linkend="PRELOAD"> + <parameter moreinfo="none">preload</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/changesharecommand.xml b/docs/docbook/smbdotconf/misc/changesharecommand.xml index 3fb494c513..d0116594c0 100644 --- a/docs/docbook/smbdotconf/misc/changesharecommand.xml +++ b/docs/docbook/smbdotconf/misc/changesharecommand.xml @@ -1,50 +1,62 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="CHANGESHARECOMMAND"/>change share command (G)</term> - <listitem><para>Samba 2.2.0 introduced the ability to dynamically - add and delete shares via the Windows NT 4.0 Server Manager. The - <parameter moreinfo="none">change share command</parameter> is used to define an - external program or script which will modify an existing service definition - in <filename moreinfo="none">smb.conf</filename>. In order to successfully - execute the <parameter moreinfo="none">change share command</parameter>, <command moreinfo="none">smbd</command> - requires that the administrator be connected using a root account (i.e. - uid == 0). - </para> +<samba:parameter name="change share command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba 2.2.0 introduced the ability to dynamically + add and delete shares via the Windows NT 4.0 Server Manager. The + <parameter moreinfo="none">change share command</parameter> is used to define an + external program or script which will modify an existing service definition + in <filename moreinfo="none">smb.conf</filename>. In order to successfully + execute the <parameter moreinfo="none">change share command</parameter>, <command moreinfo="none">smbd</command> + requires that the administrator be connected using a root account (i.e. + uid == 0). + </para> - <para> - When executed, <command moreinfo="none">smbd</command> will automatically invoke the - <parameter moreinfo="none">change share command</parameter> with four parameters. - </para> + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">change share command</parameter> with four parameters. + </para> - <itemizedlist> - <listitem><para><parameter moreinfo="none">configFile</parameter> - the location + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location of the global <filename moreinfo="none">smb.conf</filename> file. - </para></listitem> + </para> + </listitem> - <listitem><para><parameter moreinfo="none">shareName</parameter> - the name of the new + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of the new share. - </para></listitem> + </para> + </listitem> - <listitem><para><parameter moreinfo="none">pathName</parameter> - path to an **existing** + <listitem> + <para><parameter moreinfo="none">pathName</parameter> - path to an **existing** directory on disk. - </para></listitem> + </para> + </listitem> - <listitem><para><parameter moreinfo="none">comment</parameter> - comment string to associate + <listitem> + <para><parameter moreinfo="none">comment</parameter> - comment string to associate with the new share. - </para></listitem> - </itemizedlist> + </para> + </listitem> + </itemizedlist> - <para> - This parameter is only used modify existing file shares definitions. To modify - printer shares, use the "Printers..." folder as seen when browsing the Samba host. - </para> + <para> + This parameter is only used modify existing file shares definitions. To modify + printer shares, use the "Printers..." folder as seen when browsing the Samba host. + </para> - <para> - See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share - command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete - share command</parameter></link>. - </para> + <para> + See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share + command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete + share command</parameter></link>. + </para> - <para>Default: <emphasis>none</emphasis></para> - <para>Example: <command moreinfo="none">change share command = /usr/local/bin/addshare</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">change share command = /usr/local/bin/addshare</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/configfile.xml b/docs/docbook/smbdotconf/misc/configfile.xml index 3edf611b55..855b6460fe 100644 --- a/docs/docbook/smbdotconf/misc/configfile.xml +++ b/docs/docbook/smbdotconf/misc/configfile.xml @@ -1,21 +1,24 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="CONFIGFILE"/>config file (G)</term> - <listitem><para>This allows you to override the config file - to use, instead of the default (usually <filename moreinfo="none">smb.conf</filename>). - There is a chicken and egg problem here as this option is set - in the config file!</para> +<samba:parameter name="config file" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This allows you to override the config file + to use, instead of the default (usually <filename moreinfo="none">smb.conf</filename>). + There is a chicken and egg problem here as this option is set + in the config file!</para> - <para>For this reason, if the name of the config file has changed - when the parameters are loaded then it will reload them from - the new config file.</para> + <para>For this reason, if the name of the config file has changed + when the parameters are loaded then it will reload them from + the new config file.</para> - <para>This option takes the usual substitutions, which can - be very useful.</para> + <para>This option takes the usual substitutions, which can + be very useful.</para> - <para>If the config file doesn't exist then it won't be loaded - (allowing you to special case the config files of just a few - clients).</para> + <para>If the config file doesn't exist then it won't be loaded + (allowing you to special case the config files of just a few + clients).</para> - <para>Example: <command moreinfo="none">config file = /usr/local/samba/lib/smb.conf.%m - </command></para></listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">config file = /usr/local/samba/lib/smb.conf.%m</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/defaultservice.xml b/docs/docbook/smbdotconf/misc/defaultservice.xml index 7aeedb177a..39e467b1d1 100644 --- a/docs/docbook/smbdotconf/misc/defaultservice.xml +++ b/docs/docbook/smbdotconf/misc/defaultservice.xml @@ -1,29 +1,31 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DEFAULTSERVICE"/>default service (G)</term> - <listitem><para>This parameter specifies the name of a service - which will be connected to if the service actually requested cannot - be found. Note that the square brackets are <emphasis>NOT</emphasis> - given in the parameter value (see example below).</para> +<samba:parameter name="default service" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the name of a service + which will be connected to if the service actually requested cannot + be found. Note that the square brackets are <emphasis>NOT</emphasis> + given in the parameter value (see example below).</para> - <para>There is no default value for this parameter. If this - parameter is not given, attempting to connect to a nonexistent - service results in an error.</para> + <para>There is no default value for this parameter. If this + parameter is not given, attempting to connect to a nonexistent + service results in an error.</para> - <para>Typically the default service would be a <link linkend="GUESTOK"> - <parameter moreinfo="none">guest ok</parameter></link>, <link linkend="READONLY"> - <parameter moreinfo="none">read-only</parameter></link> service.</para> + <para>Typically the default service would be a <link linkend="GUESTOK"> + <parameter moreinfo="none">guest ok</parameter></link>, <link linkend="READONLY"> + <parameter moreinfo="none">read-only</parameter></link> service.</para> - <para>Also note that the apparent service name will be changed - to equal that of the requested service, this is very useful as it - allows you to use macros like <parameter moreinfo="none">%S</parameter> to make - a wildcard service.</para> + <para>Also note that the apparent service name will be changed + to equal that of the requested service, this is very useful as it + allows you to use macros like <parameter moreinfo="none">%S</parameter> to make + a wildcard service.</para> - <para>Note also that any "_" characters in the name of the service - used in the default service will get mapped to a "/". This allows for - interesting things.</para> + <para>Note also that any "_" characters in the name of the service + used in the default service will get mapped to a "/". This allows for + interesting things.</para> - - <para>Example:</para> + <para>Example:</para> <para><programlisting format="linespecific"> [global] @@ -32,5 +34,5 @@ [pub] path = /%S </programlisting></para> - </listitem> - </samba:parameter> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/deletesharecommand.xml b/docs/docbook/smbdotconf/misc/deletesharecommand.xml index c3481c86ec..cf60b27752 100644 --- a/docs/docbook/smbdotconf/misc/deletesharecommand.xml +++ b/docs/docbook/smbdotconf/misc/deletesharecommand.xml @@ -1,44 +1,51 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DELETESHARECOMMAND"/>delete share command (G)</term> - <listitem><para>Samba 2.2.0 introduced the ability to dynamically - add and delete shares via the Windows NT 4.0 Server Manager. The - <parameter moreinfo="none">delete share command</parameter> is used to define an - external program or script which will remove an existing service - definition from <filename moreinfo="none">smb.conf</filename>. In order to successfully - execute the <parameter moreinfo="none">delete share command</parameter>, <command moreinfo="none">smbd</command> - requires that the administrator be connected using a root account (i.e. - uid == 0). - </para> +<samba:parameter name="delete share command" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba 2.2.0 introduced the ability to dynamically + add and delete shares via the Windows NT 4.0 Server Manager. The + <parameter moreinfo="none">delete share command</parameter> is used to define an + external program or script which will remove an existing service + definition from <filename moreinfo="none">smb.conf</filename>. In order to successfully + execute the <parameter moreinfo="none">delete share command</parameter>, <command moreinfo="none">smbd</command> + requires that the administrator be connected using a root account (i.e. + uid == 0). + </para> - <para> - When executed, <command moreinfo="none">smbd</command> will automatically invoke the - <parameter moreinfo="none">delete share command</parameter> with two parameters. - </para> + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">delete share command</parameter> with two parameters. + </para> - <itemizedlist> - <listitem><para><parameter moreinfo="none">configFile</parameter> - the location + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location of the global <filename moreinfo="none">smb.conf</filename> file. - </para></listitem> + </para> + </listitem> - <listitem><para><parameter moreinfo="none">shareName</parameter> - the name of + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of the existing service. - </para></listitem> - </itemizedlist> - - <para> - This parameter is only used to remove file shares. To delete printer shares, - see the <link linkend="DELETEPRINTERCOMMAND"><parameter moreinfo="none">deleteprinter - command</parameter></link>. - </para> + </para> + </listitem> + </itemizedlist> - <para> - See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share - command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change - share command</parameter></link>. - </para> + <para> + This parameter is only used to remove file shares. To delete printer shares, + see the <link linkend="DELETEPRINTERCOMMAND"><parameter moreinfo="none">deleteprinter + command</parameter></link>. + </para> - <para>Default: <emphasis>none</emphasis></para> - <para>Example: <command moreinfo="none">delete share command = /usr/local/bin/delshare</command></para> + <para> + See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share + command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change + share command</parameter></link>. + </para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">delete share command = /usr/local/bin/delshare</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/lockdir.xml b/docs/docbook/smbdotconf/misc/lockdir.xml index 2c29b9b61c..4e5f6bce85 100644 --- a/docs/docbook/smbdotconf/misc/lockdir.xml +++ b/docs/docbook/smbdotconf/misc/lockdir.xml @@ -1,5 +1,9 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LOCKDIR"/>lock dir (G)</term> - <listitem><para>Synonym for <link linkend="LOCKDIRECTORY"><parameter moreinfo="none"> - lock directory</parameter></link>.</para></listitem> - </samba:parameter> +<samba:parameter name="lock dir" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="LOCKDIRECTORY"><parameter moreinfo="none"> + lock directory</parameter></link>. +</para></listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/lockdirectory.xml b/docs/docbook/smbdotconf/misc/lockdirectory.xml index 7945f19864..c877566b31 100644 --- a/docs/docbook/smbdotconf/misc/lockdirectory.xml +++ b/docs/docbook/smbdotconf/misc/lockdirectory.xml @@ -1,11 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LOCKDIRECTORY"/>lock directory (G)</term> - <listitem><para>This option specifies the directory where lock - files will be placed. The lock files are used to implement the - <link linkend="MAXCONNECTIONS"><parameter moreinfo="none">max connections</parameter> - </link> option.</para> +<samba:parameter name="lock directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies the directory where lock + files will be placed. The lock files are used to implement the + <link linkend="MAXCONNECTIONS"><parameter moreinfo="none">max connections</parameter> + </link> option.</para> - <para>Default: <command moreinfo="none">lock directory = ${prefix}/var/locks</command></para> - <para>Example: <command moreinfo="none">lock directory = /var/run/samba/locks</command> - </para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">lock directory = ${prefix}/var/locks</command></para> + + <para>Example: <command moreinfo="none">lock directory = /var/run/samba/locks</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/piddirectory.xml b/docs/docbook/smbdotconf/misc/piddirectory.xml index 81c1b13e75..b526a80221 100644 --- a/docs/docbook/smbdotconf/misc/piddirectory.xml +++ b/docs/docbook/smbdotconf/misc/piddirectory.xml @@ -1,9 +1,13 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PIDDIRECTORY"/>pid directory (G)</term> - <listitem><para>This option specifies the directory where pid - files will be placed. </para> +<samba:parameter name="pid directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies the directory where pid + files will be placed. </para> - <para>Default: <command moreinfo="none">pid directory = ${prefix}/var/locks</command></para> - <para>Example: <command moreinfo="none">pid directory = /var/run/</command> - </para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">pid directory = ${prefix}/var/locks</command></para> + + <para>Example: <command moreinfo="none">pid directory = /var/run/</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/preload.xml b/docs/docbook/smbdotconf/misc/preload.xml index 574ed1a369..96b59e3a43 100644 --- a/docs/docbook/smbdotconf/misc/preload.xml +++ b/docs/docbook/smbdotconf/misc/preload.xml @@ -1,16 +1,19 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PRELOAD"/>preload (G)</term> - <listitem><para>This is a list of services that you want to be - automatically added to the browse lists. This is most useful - for homes and printers services that would otherwise not be - visible.</para> +<samba:parameter name="preload" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of services that you want to be + automatically added to the browse lists. This is most useful + for homes and printers services that would otherwise not be + visible.</para> - <para>Note that if you just want all printers in your - printcap file loaded then the <link linkend="LOADPRINTERS"> - <parameter moreinfo="none">load printers</parameter></link> option is easier.</para> + <para>Note that if you just want all printers in your + printcap file loaded then the <link linkend="LOADPRINTERS"> + <parameter moreinfo="none">load printers</parameter></link> option is easier.</para> - <para>Default: <emphasis>no preloaded services</emphasis></para> + <para>Default: <emphasis>no preloaded services</emphasis></para> - <para>Example: <command moreinfo="none">preload = fred lp colorlp</command></para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">preload = fred lp colorlp</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/utmp.xml b/docs/docbook/smbdotconf/misc/utmp.xml index 014b85d6bc..3dfa7caa5d 100644 --- a/docs/docbook/smbdotconf/misc/utmp.xml +++ b/docs/docbook/smbdotconf/misc/utmp.xml @@ -1,21 +1,24 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="UTMP"/>utmp (G)</term> - <listitem><para>This boolean parameter is only available if - Samba has been configured and compiled with the option <command moreinfo="none"> - --with-utmp</command>. If set to <constant>yes</constant> then Samba will attempt - to add utmp or utmpx records (depending on the UNIX system) whenever a - connection is made to a Samba server. Sites may use this to record the - user connecting to a Samba share.</para> +<samba:parameter name="utmp" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter is only available if + Samba has been configured and compiled with the option <command moreinfo="none"> + --with-utmp</command>. If set to <constant>yes</constant> then Samba will attempt + to add utmp or utmpx records (depending on the UNIX system) whenever a + connection is made to a Samba server. Sites may use this to record the + user connecting to a Samba share.</para> - <para>Due to the requirements of the utmp record, we - are required to create a unique identifier for the - incoming user. Enabling this option creates an n^2 - algorithm to find this number. This may impede - performance on large installations. </para> + <para>Due to the requirements of the utmp record, we + are required to create a unique identifier for the + incoming user. Enabling this option creates an n^2 + algorithm to find this number. This may impede + performance on large installations. </para> - <para>See also the <link linkend="UTMPDIRECTORY"><parameter moreinfo="none"> - utmp directory</parameter></link> parameter.</para> + <para>See also the <link linkend="UTMPDIRECTORY"><parameter moreinfo="none"> + utmp directory</parameter></link> parameter.</para> - <para>Default: <command moreinfo="none">utmp = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">utmp = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/utmpdirectory.xml b/docs/docbook/smbdotconf/misc/utmpdirectory.xml index 9e5574fb39..3b50c3db29 100644 --- a/docs/docbook/smbdotconf/misc/utmpdirectory.xml +++ b/docs/docbook/smbdotconf/misc/utmpdirectory.xml @@ -1,16 +1,20 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="UTMPDIRECTORY"/>utmp directory(G)</term> - <listitem><para>This parameter is only available if Samba has - been configured and compiled with the option <command moreinfo="none"> - --with-utmp</command>. It specifies a directory pathname that is - used to store the utmp or utmpx files (depending on the UNIX system) that - record user connections to a Samba server. See also the <link linkend="UTMP"> - <parameter moreinfo="none">utmp</parameter></link> parameter. By default this is - not set, meaning the system will use whatever utmp file the - native system is set to use (usually - <filename moreinfo="none">/var/run/utmp</filename> on Linux).</para> +<samba:parameter name="utmp directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only available if Samba has + been configured and compiled with the option <command moreinfo="none"> + --with-utmp</command>. It specifies a directory pathname that is + used to store the utmp or utmpx files (depending on the UNIX system) that + record user connections to a Samba server. See also the <link linkend="UTMP"> + <parameter moreinfo="none">utmp</parameter></link> parameter. By default this is + not set, meaning the system will use whatever utmp file the + native system is set to use (usually + <filename moreinfo="none">/var/run/utmp</filename> on Linux).</para> - <para>Default: <emphasis>no utmp directory</emphasis></para> - <para>Example: <command moreinfo="none">utmp directory = /var/run/utmp</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>no utmp directory</emphasis></para> + + <para>Example: <command moreinfo="none">utmp directory = /var/run/utmp</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/misc/wtmpdirectory.xml b/docs/docbook/smbdotconf/misc/wtmpdirectory.xml index bb144473ff..2448edfadb 100644 --- a/docs/docbook/smbdotconf/misc/wtmpdirectory.xml +++ b/docs/docbook/smbdotconf/misc/wtmpdirectory.xml @@ -1,20 +1,24 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WTMPDIRECTORY"/>wtmp directory(G)</term> - <listitem><para>This parameter is only available if Samba has - been configured and compiled with the option <command moreinfo="none"> - --with-utmp</command>. It specifies a directory pathname that is - used to store the wtmp or wtmpx files (depending on the UNIX system) that - record user connections to a Samba server. The difference with - the utmp directory is the fact that user info is kept after a user - has logged out. +<samba:parameter name="wtmp directory" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only available if Samba has + been configured and compiled with the option <command moreinfo="none"> + --with-utmp</command>. It specifies a directory pathname that is + used to store the wtmp or wtmpx files (depending on the UNIX system) that + record user connections to a Samba server. The difference with + the utmp directory is the fact that user info is kept after a user + has logged out.</para> - See also the <link linkend="UTMP"> - <parameter moreinfo="none">utmp</parameter></link> parameter. By default this is - not set, meaning the system will use whatever utmp file the - native system is set to use (usually - <filename moreinfo="none">/var/run/wtmp</filename> on Linux).</para> + <para>See also the <link linkend="UTMP"> + <parameter moreinfo="none">utmp</parameter></link> parameter. By default this is + not set, meaning the system will use whatever utmp file the + native system is set to use (usually + <filename moreinfo="none">/var/run/wtmp</filename> on Linux).</para> - <para>Default: <emphasis>no wtmp directory</emphasis></para> - <para>Example: <command moreinfo="none">wtmp directory = /var/log/wtmp</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>no wtmp directory</emphasis></para> + + <para>Example: <command moreinfo="none">wtmp directory = /var/log/wtmp</command></para> +</listitem> +</samba:parameter> |