diff options
| author | Alexander Bokovoy <ab@samba.org> | 2003-04-06 22:14:01 +0000 |
|---|---|---|
| committer | Alexander Bokovoy <ab@samba.org> | 2003-04-06 22:14:01 +0000 |
| commit | c29eb90444170953721b087f8d26b4a3b98b3fe8 (patch) | |
| tree | 257b1ee9b093a057b81e289fd511b992cc518642 /docs/docbook/smbdotconf | |
| parent | 27aef6855f1543547b8190f06fd264d1b52a558d (diff) | |
| download | samba-c29eb90444170953721b087f8d26b4a3b98b3fe8.tar.gz samba-c29eb90444170953721b087f8d26b4a3b98b3fe8.tar.bz2 samba-c29eb90444170953721b087f8d26b4a3b98b3fe8.zip | |
Convert more parameters to new smb.conf(5) style. Document found occurences of non-documented parameters in doc-status
(This used to be commit 3a9784d8b2318af4d9b349edd1aba4065d25da23)
Diffstat (limited to 'docs/docbook/smbdotconf')
71 files changed, 1331 insertions, 1089 deletions
diff --git a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml index a5f40b73ca..4e49b89ddb 100644 --- a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml +++ b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml @@ -1,14 +1,17 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DEBUGHIRESTIMESTAMP"/>debug hires timestamp (G)</term> - <listitem><para>Sometimes the timestamps in the log messages - are needed with a resolution of higher that seconds, this - boolean parameter adds microsecond resolution to the timestamp - message header when turned on.</para> +<samba:parameter name="debug hires timestamp" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Sometimes the timestamps in the log messages + are needed with a resolution of higher that seconds, this + boolean parameter adds microsecond resolution to the timestamp + message header when turned on.</para> - <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> - debug timestamp</parameter></link> must be on for this to have an - effect.</para> + <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> - <para>Default: <command moreinfo="none">debug hires timestamp = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">debug hires timestamp = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debuglevel.xml b/docs/docbook/smbdotconf/logging/debuglevel.xml index 99153fa853..8bd4b4e0b5 100644 --- a/docs/docbook/smbdotconf/logging/debuglevel.xml +++ b/docs/docbook/smbdotconf/logging/debuglevel.xml @@ -1,6 +1,9 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DEBUGLEVEL"/>debuglevel (G)</term> - <listitem><para>Synonym for <link linkend="LOGLEVEL"><parameter moreinfo="none"> - log level</parameter></link>.</para> - </listitem> - </samba:parameter> +<samba:parameter name="debug level" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="LOGLEVEL"><parameter moreinfo="none"> + log level</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debugpid.xml b/docs/docbook/smbdotconf/logging/debugpid.xml index 829e168412..ff393f5159 100644 --- a/docs/docbook/smbdotconf/logging/debugpid.xml +++ b/docs/docbook/smbdotconf/logging/debugpid.xml @@ -1,13 +1,19 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DEBUGPID"/>debug pid (G)</term> - <listitem><para>When using only one log file for more then one - forked <ulink url="smbd.8.html">smbd</ulink>-process there may be hard to follow which process - outputs which message. This boolean parameter is adds the process-id - to the timestamp message headers in the logfile when turned on.</para> +<samba:parameter name="debug pid" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>When using only one log file for more then one forked + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>-process there may be hard to + follow which process outputs which message. This boolean parameter + is adds the process-id to the timestamp message headers in the + logfile when turned on.</para> - <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> - debug timestamp</parameter></link> must be on for this to have an - effect.</para> + <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> - <para>Default: <command moreinfo="none">debug pid = no</command></para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">debug pid = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debugtimestamp.xml b/docs/docbook/smbdotconf/logging/debugtimestamp.xml index 1265c1d21b..e337b5b8f2 100644 --- a/docs/docbook/smbdotconf/logging/debugtimestamp.xml +++ b/docs/docbook/smbdotconf/logging/debugtimestamp.xml @@ -1,10 +1,14 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DEBUGTIMESTAMP"/>debug timestamp (G)</term> - <listitem><para>Samba debug log messages are timestamped - by default. If you are running at a high <link linkend="DEBUGLEVEL"> - <parameter moreinfo="none">debug level</parameter></link> these timestamps - can be distracting. This boolean parameter allows timestamping - to be turned off.</para> +<samba:parameter name="debug timestamp" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba debug log messages are timestamped + by default. If you are running at a high <link linkend="DEBUGLEVEL"> + <parameter moreinfo="none">debug level</parameter></link> these timestamps + can be distracting. This boolean parameter allows timestamping + to be turned off.</para> - <para>Default: <command moreinfo="none">debug timestamp = yes</command></para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">debug timestamp = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/debuguid.xml b/docs/docbook/smbdotconf/logging/debuguid.xml index 9b0786d6b3..bcacdf32c0 100644 --- a/docs/docbook/smbdotconf/logging/debuguid.xml +++ b/docs/docbook/smbdotconf/logging/debuguid.xml @@ -1,13 +1,17 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DEBUGUID"/>debug uid (G)</term> - <listitem><para>Samba is sometimes run as root and sometime - run as the connected user, this boolean parameter inserts the - current euid, egid, uid and gid to the timestamp message headers - in the log file if turned on.</para> +<samba:parameter name="debug uid" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Samba is sometimes run as root and sometime + run as the connected user, this boolean parameter inserts the + current euid, egid, uid and gid to the timestamp message headers + in the log file if turned on.</para> - <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> - debug timestamp</parameter></link> must be on for this to have an - effect.</para> + <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link> must be on for this to have an + effect.</para> - <para>Default: <command moreinfo="none">debug uid = no</command></para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">debug uid = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/logfile.xml b/docs/docbook/smbdotconf/logging/logfile.xml index 6f176ef02b..8d3761a841 100644 --- a/docs/docbook/smbdotconf/logging/logfile.xml +++ b/docs/docbook/smbdotconf/logging/logfile.xml @@ -1,11 +1,14 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LOGFILE"/>log file (G)</term> - <listitem><para>This option allows you to override the name - of the Samba log file (also known as the debug file).</para> +<samba:parameter name="log file" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to override the name + of the Samba log file (also known as the debug file).</para> - <para>This option takes the standard substitutions, allowing - you to have separate log files for each user or machine.</para> + <para>This option takes the standard substitutions, allowing + you to have separate log files for each user or machine.</para> - <para>Example: <command moreinfo="none">log file = /usr/local/samba/var/log.%m - </command></para></listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">log file = /usr/local/samba/var/log.%m</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/loglevel.xml b/docs/docbook/smbdotconf/logging/loglevel.xml index 610dc96812..6f03fe80e9 100644 --- a/docs/docbook/smbdotconf/logging/loglevel.xml +++ b/docs/docbook/smbdotconf/logging/loglevel.xml @@ -1,15 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LOGLEVEL"/>log level (G)</term> - <listitem><para>The value of the parameter (a astring) allows - the debug level (logging level) to be specified in the - <filename moreinfo="none">smb.conf</filename> file. This parameter has been - extended since the 2.2.x series, now it allow to specify the debug - level for multiple debug classes. This is to give greater - flexibility in the configuration of the system.</para> +<samba:parameter name="log level" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a astring) allows + the debug level (logging level) to be specified in the + <filename moreinfo="none">smb.conf</filename> file. This parameter has been + extended since the 2.2.x series, now it allow to specify the debug + level for multiple debug classes. This is to give greater + flexibility in the configuration of the system.</para> - <para>The default will be the log level specified on - the command line or level zero if none was specified.</para> + <para>The default will be the log level specified on + the command line or level zero if none was specified.</para> - <para>Example: <command moreinfo="none">log level = 3 passdb:5 auth:10 winbind:2 - </command></para></listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">log level = 3 passdb:5 auth:10 winbind:2</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/maxlogsize.xml b/docs/docbook/smbdotconf/logging/maxlogsize.xml index 117410b18c..6e0ec6735a 100644 --- a/docs/docbook/smbdotconf/logging/maxlogsize.xml +++ b/docs/docbook/smbdotconf/logging/maxlogsize.xml @@ -1,13 +1,17 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXLOGSIZE"/>max log size (G)</term> - <listitem><para>This option (an integer in kilobytes) specifies - the max size the log file should grow to. Samba periodically checks - the size and if it is exceeded it will rename the file, adding - a <filename moreinfo="none">.old</filename> extension.</para> +<samba:parameter name="max log size" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option (an integer in kilobytes) specifies + the max size the log file should grow to. Samba periodically checks + the size and if it is exceeded it will rename the file, adding + a <filename moreinfo="none">.old</filename> extension.</para> - <para>A size of 0 means no limit.</para> + <para>A size of 0 means no limit.</para> - <para>Default: <command moreinfo="none">max log size = 5000</command></para> - <para>Example: <command moreinfo="none">max log size = 1000</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max log size = 5000</command></para> + + <para>Example: <command moreinfo="none">max log size = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/syslog.xml b/docs/docbook/smbdotconf/logging/syslog.xml index ac098e690a..0fdf070045 100644 --- a/docs/docbook/smbdotconf/logging/syslog.xml +++ b/docs/docbook/smbdotconf/logging/syslog.xml @@ -1,17 +1,20 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="SYSLOG"/>syslog (G)</term> - <listitem><para>This parameter maps how Samba debug messages - are logged onto the system syslog logging levels. Samba debug - level zero maps onto syslog <constant>LOG_ERR</constant>, debug - level one maps onto <constant>LOG_WARNING</constant>, debug level - two maps onto <constant>LOG_NOTICE</constant>, debug level three - maps onto LOG_INFO. All higher levels are mapped to <constant> - LOG_DEBUG</constant>.</para> +<samba:parameter name="syslog" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter maps how Samba debug messages + are logged onto the system syslog logging levels. Samba debug + level zero maps onto syslog <constant>LOG_ERR</constant>, debug + level one maps onto <constant>LOG_WARNING</constant>, debug level + two maps onto <constant>LOG_NOTICE</constant>, debug level three + maps onto LOG_INFO. All higher levels are mapped to <constant> + LOG_DEBUG</constant>.</para> - <para>This parameter sets the threshold for sending messages - to syslog. Only messages with debug level less than this value - will be sent to syslog.</para> + <para>This parameter sets the threshold for sending messages + to syslog. Only messages with debug level less than this value + will be sent to syslog.</para> - <para>Default: <command moreinfo="none">syslog = 1</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">syslog = 1</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/syslogonly.xml b/docs/docbook/smbdotconf/logging/syslogonly.xml index a955306fe0..2b584d8d6d 100644 --- a/docs/docbook/smbdotconf/logging/syslogonly.xml +++ b/docs/docbook/smbdotconf/logging/syslogonly.xml @@ -1,9 +1,12 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="SYSLOGONLY"/>syslog only (G)</term> - <listitem><para>If this parameter is set then Samba debug - messages are logged into the system syslog only, and not to - the debug log files.</para> +<samba:parameter name="syslog only" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is set then Samba debug + messages are logged into the system syslog only, and not to + the debug log files.</para> - <para>Default: <command moreinfo="none">syslog only = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">syslog only = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logging/timestamplogs.xml b/docs/docbook/smbdotconf/logging/timestamplogs.xml index 5f5f42d738..e744ce54c6 100644 --- a/docs/docbook/smbdotconf/logging/timestamplogs.xml +++ b/docs/docbook/smbdotconf/logging/timestamplogs.xml @@ -1,6 +1,9 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="TIMESTAMPLOGS"/>timestamp logs (G)</term> - <listitem><para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> - debug timestamp</parameter></link>.</para> - </listitem> - </samba:parameter> +<samba:parameter name="timestamp logs" + context="G" + developer="1" advanced="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter moreinfo="none"> + debug timestamp</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml index c4b2aa1d92..45380ce4a8 100644 --- a/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml +++ b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml @@ -1,5 +1,7 @@ -<samba:parameter xmlns:samba="http://samba.org/common"><term><anchor id="SETPRIMARYGROUPSCRIPT"/>set primary group script (G)</term> - <listitem><para>Thanks to the Posix subsystem in NT a +<samba:parameter xmlns:samba="http://samba.org/common"> +<term><anchor id="SETPRIMARYGROUPSCRIPT"/>set primary group script (G)</term> +<listitem> + <para>Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups. This script sets the primary group in the unix userdatase when an administrator sets the @@ -8,7 +10,7 @@ vampire</command>. <parameter>%u</parameter> will be replaced with the user whose primary group is to be set. <parameter>%g</parameter> will be replaced with - the group to set. + the group to set.</para> <para>Default: <emphasis>No default value</emphasis></para> diff --git a/docs/docbook/smbdotconf/printing/disablespoolss.xml b/docs/docbook/smbdotconf/printing/disablespoolss.xml index dff1e63fab..366092fce1 100644 --- a/docs/docbook/smbdotconf/printing/disablespoolss.xml +++ b/docs/docbook/smbdotconf/printing/disablespoolss.xml @@ -1,20 +1,23 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DISABLESPOOLSS"/>disable spoolss (G)</term> - <listitem><para>Enabling this parameter will disable Samba's support - for the SPOOLSS set of MS-RPC's and will yield identical behavior - as Samba 2.0.x. Windows NT/2000 clients will downgrade to using - Lanman style printing commands. Windows 9x/ME will be uneffected by - the parameter. However, this will also disable the ability to upload - printer drivers to a Samba server via the Windows NT Add Printer - Wizard or by using the NT printer properties dialog window. It will - also disable the capability of Windows NT/2000 clients to download - print drivers from the Samba host upon demand. - <emphasis>Be very careful about enabling this parameter.</emphasis> - </para> +<samba:parameter name="disable spoolss" + context="G" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Enabling this parameter will disable Samba's support + for the SPOOLSS set of MS-RPC's and will yield identical behavior + as Samba 2.0.x. Windows NT/2000 clients will downgrade to using + Lanman style printing commands. Windows 9x/ME will be uneffected by + the parameter. However, this will also disable the ability to upload + printer drivers to a Samba server via the Windows NT Add Printer + Wizard or by using the NT printer properties dialog window. It will + also disable the capability of Windows NT/2000 clients to download + print drivers from the Samba host upon demand. + <emphasis>Be very careful about enabling this parameter.</emphasis> + </para> - <para>See also <link linkend="USECLIENTDRIVER">use client driver</link> - </para> + <para>See also <link linkend="USECLIENTDRIVER">use client driver</link> + </para> - <para>Default : <command moreinfo="none">disable spoolss = no</command></para> - </listitem> - </samba:parameter> + <para>Default : <command moreinfo="none">disable spoolss = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/loadprinters.xml b/docs/docbook/smbdotconf/printing/loadprinters.xml index adaa8afca9..efc2658ba8 100644 --- a/docs/docbook/smbdotconf/printing/loadprinters.xml +++ b/docs/docbook/smbdotconf/printing/loadprinters.xml @@ -1,9 +1,13 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LOADPRINTERS"/>load printers (G)</term> - <listitem><para>A boolean variable that controls whether all - printers in the printcap will be loaded for browsing by default. - See the <link linkend="PRINTERSSECT">printers</link> section for - more details.</para> +<samba:parameter name="load printers" + context="G" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A boolean variable that controls whether all + printers in the printcap will be loaded for browsing by default. + See the <link linkend="PRINTERSSECT">printers</link> section for + more details.</para> - <para>Default: <command moreinfo="none">load printers = yes</command></para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">load printers = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/lpqcommand.xml b/docs/docbook/smbdotconf/printing/lpqcommand.xml index ddcdf1ef49..f1b62af627 100644 --- a/docs/docbook/smbdotconf/printing/lpqcommand.xml +++ b/docs/docbook/smbdotconf/printing/lpqcommand.xml @@ -1,41 +1,44 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LPQCOMMAND"/>lpq command (S)</term> - <listitem><para>This parameter specifies the command to be - executed on the server host in order to obtain <command moreinfo="none">lpq - </command>-style printer status information.</para> - - <para>This command should be a program or script which - takes a printer name as its only parameter and outputs printer - status information.</para> - - <para>Currently nine styles of printer status information - are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. - This covers most UNIX systems. You control which type is expected - using the <parameter moreinfo="none">printing =</parameter> option.</para> - - <para>Some clients (notably Windows for Workgroups) may not - correctly send the connection number for the printer they are - requesting status information about. To get around this, the - server reports on the first printer service connected to by the - client. This only happens if the connection number sent is invalid.</para> - - <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name - is put in its place. Otherwise it is placed at the end of the - command.</para> - - <para>Note that it is good practice to include the absolute path - in the <parameter moreinfo="none">lpq command</parameter> as the <envar>$PATH - </envar> may not be available to the server. When compiled with - the CUPS libraries, no <parameter moreinfo="none">lpq command</parameter> is - needed because smbd will make a library call to obtain the - print queue listing.</para> - - <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing - </parameter></link> parameter.</para> - - <para>Default: <emphasis>depends on the setting of <parameter moreinfo="none"> - printing</parameter></emphasis></para> - - <para>Example: <command moreinfo="none">lpq command = /usr/bin/lpq -P%p</command></para> - </listitem> - </samba:parameter> +<samba:parameter name="lpq command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to obtain <command moreinfo="none">lpq + </command>-style printer status information.</para> + + <para>This command should be a program or script which + takes a printer name as its only parameter and outputs printer + status information.</para> + + <para>Currently nine styles of printer status information + are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. + This covers most UNIX systems. You control which type is expected + using the <parameter moreinfo="none">printing =</parameter> option.</para> + + <para>Some clients (notably Windows for Workgroups) may not + correctly send the connection number for the printer they are + requesting status information about. To get around this, the + server reports on the first printer service connected to by the + client. This only happens if the connection number sent is invalid.</para> + + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. Otherwise it is placed at the end of the + command.</para> + + <para>Note that it is good practice to include the absolute path + in the <parameter moreinfo="none">lpq command</parameter> as the <envar>$PATH + </envar> may not be available to the server. When compiled with + the CUPS libraries, no <parameter moreinfo="none">lpq command</parameter> is + needed because smbd will make a library call to obtain the + print queue listing.</para> + + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> + + <para>Default: <emphasis>depends on the setting of <parameter moreinfo="none"> + printing</parameter></emphasis></para> + + <para>Example: <command moreinfo="none">lpq command = /usr/bin/lpq -P%p</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/lprmcommand.xml b/docs/docbook/smbdotconf/printing/lprmcommand.xml index 7f59d6c5a0..567602c4f9 100644 --- a/docs/docbook/smbdotconf/printing/lprmcommand.xml +++ b/docs/docbook/smbdotconf/printing/lprmcommand.xml @@ -1,27 +1,30 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LPRMCOMMAND"/>lprm command (S)</term> - <listitem><para>This parameter specifies the command to be - executed on the server host in order to delete a print job.</para> +<samba:parameter name="lprm command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter specifies the command to be + executed on the server host in order to delete a print job.</para> - <para>This command should be a program or script which takes - a printer name and job number, and deletes the print job.</para> + <para>This command should be a program or script which takes + a printer name and job number, and deletes the print job.</para> - <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name - is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with - the job number (an integer).</para> + <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name + is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with + the job number (an integer).</para> - <para>Note that it is good practice to include the absolute - path in the <parameter moreinfo="none">lprm command</parameter> as the PATH may not be - available to the server.</para> + <para>Note that it is good practice to include the absolute + path in the <parameter moreinfo="none">lprm command</parameter> as the PATH may not be + available to the server.</para> - <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing - </parameter></link> parameter.</para> + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> - <para>Default: <emphasis>depends on the setting of <parameter moreinfo="none">printing - </parameter></emphasis></para> + <para>Default: <emphasis>depends on the setting of <parameter moreinfo="none">printing + </parameter></emphasis></para> - <para>Example 1: <command moreinfo="none">lprm command = /usr/bin/lprm -P%p %j - </command></para> - <para>Example 2: <command moreinfo="none">lprm command = /usr/bin/cancel %p-%j - </command></para></listitem> - </samba:parameter> + <para>Example 1: <command moreinfo="none">lprm command = /usr/bin/lprm -P%p %j</command></para> + + <para>Example 2: <command moreinfo="none">lprm command = /usr/bin/cancel %p-%j</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/maxprintjobs.xml b/docs/docbook/smbdotconf/printing/maxprintjobs.xml index f0c7d83d3f..a631b6b8c4 100644 --- a/docs/docbook/smbdotconf/printing/maxprintjobs.xml +++ b/docs/docbook/smbdotconf/printing/maxprintjobs.xml @@ -1,14 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXPRINTJOBS"/>max print jobs (S)</term> - <listitem><para>This parameter limits the maximum number of - jobs allowable in a Samba printer queue at any given moment. - If this number is exceeded, <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> will remote "Out of Space" to the client. - See all <link linkend="TOTALPRINTJOBS"><parameter moreinfo="none">total - print jobs</parameter></link>. - </para> +<samba:parameter name="max print jobs" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of + jobs allowable in a Samba printer queue at any given moment. + If this number is exceeded, <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will remote "Out of Space" to the client. + See all <link linkend="TOTALPRINTJOBS"><parameter moreinfo="none">total + print jobs</parameter></link>. + </para> - <para>Default: <command moreinfo="none">max print jobs = 1000</command></para> - <para>Example: <command moreinfo="none">max print jobs = 5000</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max print jobs = 1000</command></para> + + <para>Example: <command moreinfo="none">max print jobs = 5000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printable.xml b/docs/docbook/smbdotconf/printing/printable.xml index 22d4d73b01..946e8b4b96 100644 --- a/docs/docbook/smbdotconf/printing/printable.xml +++ b/docs/docbook/smbdotconf/printing/printable.xml @@ -1,15 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PRINTABLE"/>printable (S)</term> - <listitem><para>If this parameter is <constant>yes</constant>, then - clients may open, write to and submit spool files on the directory - specified for the service. </para> +<samba:parameter name="printable" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is <constant>yes</constant>, then + clients may open, write to and submit spool files on the directory + specified for the service. </para> - <para>Note that a printable service will ALWAYS allow writing - to the service path (user privileges permitting) via the spooling - of print data. The <link linkend="READONLY"><parameter moreinfo="none">read only - </parameter></link> parameter controls only non-printing access to - the resource.</para> + <para>Note that a printable service will ALWAYS allow writing + to the service path (user privileges permitting) via the spooling + of print data. The <link linkend="READONLY"><parameter moreinfo="none">read only + </parameter></link> parameter controls only non-printing access to + the resource.</para> - <para>Default: <command moreinfo="none">printable = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">printable = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printcap.xml b/docs/docbook/smbdotconf/printing/printcap.xml index 2f5e4af580..0ee08a263f 100644 --- a/docs/docbook/smbdotconf/printing/printcap.xml +++ b/docs/docbook/smbdotconf/printing/printcap.xml @@ -1,6 +1,9 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PRINTCAP"/>printcap (G)</term> - <listitem><para>Synonym for <link linkend="PRINTCAPNAME"><parameter moreinfo="none"> - printcap name</parameter></link>.</para> - </listitem> - </samba:parameter> +<samba:parameter name="printcap" + context="G" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="PRINTCAPNAME"><parameter moreinfo="none"> + printcap name</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printcapname.xml b/docs/docbook/smbdotconf/printing/printcapname.xml index 0025624d25..5f5b5c86a9 100644 --- a/docs/docbook/smbdotconf/printing/printcapname.xml +++ b/docs/docbook/smbdotconf/printing/printcapname.xml @@ -1,28 +1,32 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PRINTCAPNAME"/>printcap name (G)</term> - <listitem><para>This parameter may be used to override the - compiled-in default printcap name used by the server (usually <filename moreinfo="none"> - /etc/printcap</filename>). See the discussion of the <link linkend="PRINTERSSECT">[printers]</link> section above for reasons - why you might want to do this.</para> +<samba:parameter name="max print jobs" + context="S" + print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter may be used to override the + compiled-in default printcap name used by the server (usually <filename moreinfo="none"> + /etc/printcap</filename>). See the discussion of the <link + linkend="PRINTERSSECT">[printers]</link> section above for reasons + why you might want to do this.</para> - <para>To use the CUPS printing interface set <command moreinfo="none">printcap name = cups - </command>. This should be supplemented by an addtional setting - <link linkend="PRINTING">printing = cups</link> in the [global] - section. <command moreinfo="none">printcap name = cups</command> will use the - "dummy" printcap created by CUPS, as specified in your CUPS - configuration file. - </para> + <para>To use the CUPS printing interface set <command moreinfo="none">printcap name = cups + </command>. This should be supplemented by an addtional setting + <link linkend="PRINTING">printing = cups</link> in the [global] + section. <command moreinfo="none">printcap name = cups</command> will use the + "dummy" printcap created by CUPS, as specified in your CUPS + configuration file. + </para> - <para>On System V systems that use <command moreinfo="none">lpstat</command> to - list available printers you can use <command moreinfo="none">printcap name = lpstat - </command> to automatically obtain lists of available printers. This - is the default for systems that define SYSV at configure time in - Samba (this includes most System V based systems). If <parameter moreinfo="none"> - printcap name</parameter> is set to <command moreinfo="none">lpstat</command> on - these systems then Samba will launch <command moreinfo="none">lpstat -v</command> and - attempt to parse the output to obtain a printer list.</para> + <para>On System V systems that use <command moreinfo="none">lpstat</command> to + list available printers you can use <command moreinfo="none">printcap name = lpstat + </command> to automatically obtain lists of available printers. This + is the default for systems that define SYSV at configure time in + Samba (this includes most System V based systems). If <parameter moreinfo="none"> + printcap name</parameter> is set to <command moreinfo="none">lpstat</command> on + these systems then Samba will launch <command moreinfo="none">lpstat -v</command> and + attempt to parse the output to obtain a printer list.</para> - <para>A minimal printcap file would look something like this:</para> + <para>A minimal printcap file would look something like this:</para> <para><programlisting format="linespecific"> print1|My Printer 1 @@ -32,16 +36,17 @@ print4|My Printer 4 print5|My Printer 5 </programlisting></para> - <para>where the '|' separates aliases of a printer. The fact - that the second alias has a space in it gives a hint to Samba - that it's a comment.</para> + <para>where the '|' separates aliases of a printer. The fact + that the second alias has a space in it gives a hint to Samba + that it's a comment.</para> - <note><para>Under AIX the default printcap - name is <filename moreinfo="none">/etc/qconfig</filename>. Samba will assume the - file is in AIX <filename moreinfo="none">qconfig</filename> format if the string - <filename moreinfo="none">qconfig</filename> appears in the printcap filename.</para></note> + <note><para>Under AIX the default printcap + name is <filename moreinfo="none">/etc/qconfig</filename>. Samba will assume the + file is in AIX <filename moreinfo="none">qconfig</filename> format if the string + <filename moreinfo="none">qconfig</filename> appears in the printcap filename.</para></note> - <para>Default: <command moreinfo="none">printcap name = /etc/printcap</command></para> - <para>Example: <command moreinfo="none">printcap name = /etc/myprintcap</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">printcap name = /etc/printcap</command></para> + + <para>Example: <command moreinfo="none">printcap name = /etc/myprintcap</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printcommand.xml b/docs/docbook/smbdotconf/printing/printcommand.xml index c996ed6c2e..5444309053 100644 --- a/docs/docbook/smbdotconf/printing/printcommand.xml +++ b/docs/docbook/smbdotconf/printing/printcommand.xml @@ -1,86 +1,89 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PRINTCOMMAND"/>print command (S)</term> - <listitem><para>After a print job has finished spooling to - a service, this command will be used via a <command moreinfo="none">system()</command> - call to process the spool file. Typically the command specified will - submit the spool file to the host's printing subsystem, but there - is no requirement that this be the case. The server will not remove - the spool file, so whatever command you specify should remove the - spool file when it has been processed, otherwise you will need to - manually remove old spool files.</para> +<samba:parameter name="print command" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>After a print job has finished spooling to + a service, this command will be used via a <command moreinfo="none">system()</command> + call to process the spool file. Typically the command specified will + submit the spool file to the host's printing subsystem, but there + is no requirement that this be the case. The server will not remove + the spool file, so whatever command you specify should remove the + spool file when it has been processed, otherwise you will need to + manually remove old spool files.</para> - <para>The print command is simply a text string. It will be used - verbatim after macro substitutions have been made:</para> + <para>The print command is simply a text string. It will be used + verbatim after macro substitutions have been made:</para> - <para>s, %p - the path to the spool - file name</para> + <para>%s, %p - the path to the spool + file name</para> - <para>%p - the appropriate printer - name</para> + <para>%p - the appropriate printer + name</para> - <para>%J - the job - name as transmitted by the client.</para> + <para>%J - the job + name as transmitted by the client.</para> - <para>%c - The number of printed pages - of the spooled job (if known).</para> + <para>%c - The number of printed pages + of the spooled job (if known).</para> - <para>%z - the size of the spooled - print job (in bytes)</para> + <para>%z - the size of the spooled + print job (in bytes)</para> - <para>The print command <emphasis>MUST</emphasis> contain at least - one occurrence of <parameter moreinfo="none">%s</parameter> or <parameter moreinfo="none">%f - </parameter> - the <parameter moreinfo="none">%p</parameter> is optional. At the time - a job is submitted, if no printer name is supplied the <parameter moreinfo="none">%p - </parameter> will be silently removed from the printer command.</para> + <para>The print command <emphasis>MUST</emphasis> contain at least + one occurrence of <parameter moreinfo="none">%s</parameter> or <parameter moreinfo="none">%f + </parameter> - the <parameter moreinfo="none">%p</parameter> is optional. At the time + a job is submitted, if no printer name is supplied the <parameter moreinfo="none">%p + </parameter> will be silently removed from the printer command.</para> - <para>If specified in the [global] section, the print command given - will be used for any printable service that does not have its own - print command specified.</para> + <para>If specified in the [global] section, the print command given + will be used for any printable service that does not have its own + print command specified.</para> - <para>If there is neither a specified print command for a - printable service nor a global print command, spool files will - be created but not processed and (most importantly) not removed.</para> + <para>If there is neither a specified print command for a + printable service nor a global print command, spool files will + be created but not processed and (most importantly) not removed.</para> - <para>Note that printing may fail on some UNIXes from the - <constant>nobody</constant> account. If this happens then create - an alternative guest account that can print and set the <link linkend="GUESTACCOUNT"><parameter moreinfo="none">guest account</parameter></link> - in the [global] section.</para> + <para>Note that printing may fail on some UNIXes from the + <constant>nobody</constant> account. If this happens then create + an alternative guest account that can print and set the <link linkend="GUESTACCOUNT"> + <parameter moreinfo="none">guest account</parameter></link> + in the [global] section.</para> - <para>You can form quite complex print commands by realizing - that they are just passed to a shell. For example the following - will log a print job, print the file, then remove it. Note that - ';' is the usual separator for command in shell scripts.</para> + <para>You can form quite complex print commands by realizing + that they are just passed to a shell. For example the following + will log a print job, print the file, then remove it. Note that + ';' is the usual separator for command in shell scripts.</para> - <para><command moreinfo="none">print command = echo Printing %s >> - /tmp/print.log; lpr -P %p %s; rm %s</command></para> + <para><command moreinfo="none">print command = echo Printing %s >> + /tmp/print.log; lpr -P %p %s; rm %s</command></para> - <para>You may have to vary this command considerably depending - on how you normally print files on your system. The default for - the parameter varies depending on the setting of the <link linkend="PRINTING"> - <parameter moreinfo="none">printing</parameter></link> parameter.</para> + <para>You may have to vary this command considerably depending + on how you normally print files on your system. The default for + the parameter varies depending on the setting of the <link linkend="PRINTING"> + <parameter moreinfo="none">printing</parameter></link> parameter.</para> - <para>Default: For <command moreinfo="none">printing = BSD, AIX, QNX, LPRNG - or PLP :</command></para> - <para><command moreinfo="none">print command = lpr -r -P%p %s</command></para> + <para>Default: For <command moreinfo="none">printing = BSD, AIX, QNX, LPRNG + or PLP :</command></para> + <para><command moreinfo="none">print command = lpr -r -P%p %s</command></para> - <para>For <command moreinfo="none">printing = SYSV or HPUX :</command></para> - <para><command moreinfo="none">print command = lp -c -d%p %s; rm %s</command></para> + <para>For <command moreinfo="none">printing = SYSV or HPUX :</command></para> + <para><command moreinfo="none">print command = lp -c -d%p %s; rm %s</command></para> - <para>For <command moreinfo="none">printing = SOFTQ :</command></para> - <para><command moreinfo="none">print command = lp -d%p -s %s; rm %s</command></para> + <para>For <command moreinfo="none">printing = SOFTQ :</command></para> + <para><command moreinfo="none">print command = lp -d%p -s %s; rm %s</command></para> - <para>For printing = CUPS : If SAMBA is compiled against - libcups, then <link linkend="PRINTING">printcap = cups</link> - uses the CUPS API to - submit jobs, etc. Otherwise it maps to the System V - commands with the -oraw option for printing, i.e. it - uses <command moreinfo="none">lp -c -d%p -oraw; rm %s</command>. - With <command moreinfo="none">printing = cups</command>, - and if SAMBA is compiled against libcups, any manually - set print command will be ignored.</para> + <para>For printing = CUPS : If SAMBA is compiled against + libcups, then <link linkend="PRINTING">printcap = cups</link> + uses the CUPS API to + submit jobs, etc. Otherwise it maps to the System V + commands with the -oraw option for printing, i.e. it + uses <command moreinfo="none">lp -c -d%p -oraw; rm %s</command>. + With <command moreinfo="none">printing = cups</command>, + and if SAMBA is compiled against libcups, any manually + set print command will be ignored.</para> - <para>Example: <command moreinfo="none">print command = /usr/local/samba/bin/myprintscript - %p %s</command></para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">print command = /usr/local/samba/bin/myprintscript %p %s</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printing.xml b/docs/docbook/smbdotconf/printing/printing.xml index d49c0e2471..4e9caa9b54 100644 --- a/docs/docbook/smbdotconf/printing/printing.xml +++ b/docs/docbook/smbdotconf/printing/printing.xml @@ -1,26 +1,31 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PRINTING"/>printing (S)</term> - <listitem><para>This parameters controls how printer status - information is interpreted on your system. It also affects the - default values for the <parameter moreinfo="none">print command</parameter>, - <parameter moreinfo="none">lpq command</parameter>, <parameter moreinfo="none">lppause command - </parameter>, <parameter moreinfo="none">lpresume command</parameter>, and - <parameter moreinfo="none">lprm command</parameter> if specified in the - [global] section.</para> +<samba:parameter name="printing" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameters controls how printer status information is + interpreted on your system. It also affects the default values for + the <parameter moreinfo="none">print command</parameter>, parameter + moreinfo="none">lpq command</parameter>, <parameter + moreinfo="none">lppause command </parameter>, <parameter + moreinfo="none">lpresume command</parameter>, and <parameter + moreinfo="none">lprm command</parameter> if specified in the + [global] section.</para> - <para>Currently nine printing styles are supported. They are - <constant>BSD</constant>, <constant>AIX</constant>, - <constant>LPRNG</constant>, <constant>PLP</constant>, - <constant>SYSV</constant>, <constant>HPUX</constant>, - <constant>QNX</constant>, <constant>SOFTQ</constant>, - and <constant>CUPS</constant>.</para> + <para>Currently nine printing styles are supported. They are + <constant>BSD</constant>, <constant>AIX</constant>, + <constant>LPRNG</constant>, <constant>PLP</constant>, + <constant>SYSV</constant>, <constant>HPUX</constant>, + <constant>QNX</constant>, <constant>SOFTQ</constant>, + and <constant>CUPS</constant>.</para> - <para>To see what the defaults are for the other print - commands when using the various options use the <ulink url="testparm.1.html">testparm(1)</ulink> program.</para> + <para>To see what the defaults are for the other print + commands when using the various options use the <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> program.</para> - <para>This option can be set on a per printer basis</para> + <para>This option can be set on a per printer basis</para> - <para>See also the discussion in the <link linkend="PRINTERSSECT"> - [printers]</link> section.</para> - </listitem> - </samba:parameter> + <para>See also the discussion in the <link linkend="PRINTERSSECT"> + [printers]</link> section.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/printok.xml b/docs/docbook/smbdotconf/printing/printok.xml index 7900e91bbb..0a0e6605f1 100644 --- a/docs/docbook/smbdotconf/printing/printok.xml +++ b/docs/docbook/smbdotconf/printing/printok.xml @@ -1,6 +1,9 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PRINTOK"/>print ok (S)</term> - <listitem><para>Synonym for <link linkend="PRINTABLE"> - <parameter moreinfo="none">printable</parameter></link>.</para> - </listitem> - </samba:parameter> +<samba:parameter name="print ok" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="PRINTABLE"> + <parameter moreinfo="none">printable</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/printing/totalprintjobs.xml b/docs/docbook/smbdotconf/printing/totalprintjobs.xml index 25784a3c29..ccdb137a69 100644 --- a/docs/docbook/smbdotconf/printing/totalprintjobs.xml +++ b/docs/docbook/smbdotconf/printing/totalprintjobs.xml @@ -1,18 +1,22 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="TOTALPRINTJOBS"/>total print jobs (G)</term> - <listitem><para>This parameter accepts an integer value which defines - a limit on the maximum number of print jobs that will be accepted - system wide at any given time. If a print job is submitted - by a client which will exceed this number, then <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> will return an - error indicating that no space is available on the server. The - default value of 0 means that no such limit exists. This parameter - can be used to prevent a server from exceeding its capacity and is - designed as a printing throttle. See also - <link linkend="MAXPRINTJOBS"><parameter moreinfo="none">max print jobs</parameter></link>. - </para> +<samba:parameter name="total print jobs" + context="G" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter accepts an integer value which defines + a limit on the maximum number of print jobs that will be accepted + system wide at any given time. If a print job is submitted + by a client which will exceed this number, then <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will return an + error indicating that no space is available on the server. The + default value of 0 means that no such limit exists. This parameter + can be used to prevent a server from exceeding its capacity and is + designed as a printing throttle. See also <link linkend="MAXPRINTJOBS"> + <parameter moreinfo="none">max print jobs</parameter></link>. + </para> - <para>Default: <command moreinfo="none">total print jobs = 0</command></para> - <para>Example: <command moreinfo="none">total print jobs = 5000</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">total print jobs = 0</command></para> + + <para>Example: <command moreinfo="none">total print jobs = 5000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/announceas.xml b/docs/docbook/smbdotconf/protocol/announceas.xml index 1f3169609c..b063fcc1b7 100644 --- a/docs/docbook/smbdotconf/protocol/announceas.xml +++ b/docs/docbook/smbdotconf/protocol/announceas.xml @@ -1,18 +1,21 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="ANNOUNCEAS"/>announce as (G)</term> - <listitem><para>This specifies what type of server <citerefentry><refentrytitle>nmbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> will announce itself as, to a network neighborhood browse - list. By default this is set to Windows NT. The valid options - are : "NT Server" (which can also be written as "NT"), - "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, - Windows NT Workstation, Windows 95 and Windows for Workgroups - respectively. Do not change this parameter unless you have a - specific need to stop Samba appearing as an NT server as this - may prevent Samba servers from participating as browser servers - correctly.</para> +<samba:parameter name="announce as" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies what type of server <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will announce itself as, to a network neighborhood browse + list. By default this is set to Windows NT. The valid options + are : "NT Server" (which can also be written as "NT"), + "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, + Windows NT Workstation, Windows 95 and Windows for Workgroups + respectively. Do not change this parameter unless you have a + specific need to stop Samba appearing as an NT server as this + may prevent Samba servers from participating as browser servers + correctly.</para> - <para>Default: <command moreinfo="none">announce as = NT Server</command></para> - - <para>Example: <command moreinfo="none">announce as = Win95</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">announce as = NT Server</command></para> + + <para>Example: <command moreinfo="none">announce as = Win95</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/announceversion.xml b/docs/docbook/smbdotconf/protocol/announceversion.xml index 03ad429dbd..217004b5fc 100644 --- a/docs/docbook/smbdotconf/protocol/announceversion.xml +++ b/docs/docbook/smbdotconf/protocol/announceversion.xml @@ -1,12 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="ANNOUNCEVERSION"/>announce version (G)</term> - <listitem><para>This specifies the major and minor version numbers - that nmbd will use when announcing itself as a server. The default - is 4.9. Do not change this parameter unless you have a specific - need to set a Samba server to be a downlevel server.</para> +<samba:parameter name="announce version" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies the major and minor version numbers + that nmbd will use when announcing itself as a server. The default + is 4.9. Do not change this parameter unless you have a specific + need to set a Samba server to be a downlevel server.</para> - <para>Default: <command moreinfo="none">announce version = 4.9</command></para> + <para>Default: <command moreinfo="none">announce version = 4.9</command></para> - <para>Example: <command moreinfo="none">announce version = 2.0</command></para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">announce version = 2.0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/disablenetbios.xml b/docs/docbook/smbdotconf/protocol/disablenetbios.xml index ac97cdf7c3..2fe92d00b7 100644 --- a/docs/docbook/smbdotconf/protocol/disablenetbios.xml +++ b/docs/docbook/smbdotconf/protocol/disablenetbios.xml @@ -1,14 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DISABLENETBIOS"/>disable netbios (G)</term> - <listitem><para>Enabling this parameter will disable netbios support - in Samba. Netbios is the only available form of browsing in - all windows versions except for 2000 and XP. </para> +<samba:parameter name="disable netbios" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Enabling this parameter will disable netbios support + in Samba. Netbios is the only available form of browsing in + all windows versions except for 2000 and XP. </para> - <para>Note that clients that only support netbios won't be able to - see your samba server when netbios support is disabled. - </para> + <note><para>Note that clients that only support netbios won't be able to + see your samba server when netbios support is disabled. + </para></note> - <para>Default: <command moreinfo="none">disable netbios = no</command></para> - <para>Example: <command moreinfo="none">disable netbios = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">disable netbios = no</command></para> + + <para>Example: <command moreinfo="none">disable netbios = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/largereadwrite.xml b/docs/docbook/smbdotconf/protocol/largereadwrite.xml index 9aa28593e6..25c58899c4 100644 --- a/docs/docbook/smbdotconf/protocol/largereadwrite.xml +++ b/docs/docbook/smbdotconf/protocol/largereadwrite.xml @@ -1,15 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="LARGEREADWRITE"/>large readwrite (G)</term> - <listitem><para>This parameter determines whether or not <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> supports the new 64k streaming - read and write varient SMB requests introduced - with Windows 2000. Note that due to Windows 2000 client redirector bugs - this requires Samba to be running on a 64-bit capable operating system such - as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with - Windows 2000 clients. Defaults to on. Not as tested as some other Samba - code paths. - </para> +<samba:parameter name="large readwrite" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines whether or not + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> supports the new 64k + streaming read and write varient SMB requests introduced with + Windows 2000. Note that due to Windows 2000 client redirector bugs + this requires Samba to be running on a 64-bit capable operating + system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve + performance by 10% with Windows 2000 clients. Defaults to on. Not as + tested as some other Samba code paths.</para> - <para>Default : <command moreinfo="none">large readwrite = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">large readwrite = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxmux.xml b/docs/docbook/smbdotconf/protocol/maxmux.xml index 51296e0747..c05487fdca 100644 --- a/docs/docbook/smbdotconf/protocol/maxmux.xml +++ b/docs/docbook/smbdotconf/protocol/maxmux.xml @@ -1,9 +1,12 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXMUX"/>max mux (G)</term> - <listitem><para>This option controls the maximum number of - outstanding simultaneous SMB operations that Samba tells the client - it will allow. You should never need to set this parameter.</para> +<samba:parameter name="max mux" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option controls the maximum number of + outstanding simultaneous SMB operations that Samba tells the client + it will allow. You should never need to set this parameter.</para> - <para>Default: <command moreinfo="none">max mux = 50</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max mux = 50</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxprotocol.xml b/docs/docbook/smbdotconf/protocol/maxprotocol.xml index be859f8ee3..3f4e917828 100644 --- a/docs/docbook/smbdotconf/protocol/maxprotocol.xml +++ b/docs/docbook/smbdotconf/protocol/maxprotocol.xml @@ -1,35 +1,48 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXPROTOCOL"/>max protocol (G)</term> - <listitem><para>The value of the parameter (a string) is the highest - protocol level that will be supported by the server.</para> +<samba:parameter name="max protocol" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a string) is the highest + protocol level that will be supported by the server.</para> - <para>Possible values are :</para> - <itemizedlist> - <listitem><para><constant>CORE</constant>: Earliest version. No - concept of user names.</para></listitem> + <para>Possible values are :</para> + <itemizedlist> + <listitem> + <para><constant>CORE</constant>: Earliest version. No + concept of user names.</para> + </listitem> - <listitem><para><constant>COREPLUS</constant>: Slight improvements on - CORE for efficiency.</para></listitem> + <listitem> + <para><constant>COREPLUS</constant>: Slight improvements on + CORE for efficiency.</para> + </listitem> - <listitem><para><constant>LANMAN1</constant>: First <emphasis> - modern</emphasis> version of the protocol. Long filename - support.</para></listitem> + <listitem> + <para><constant>LANMAN1</constant>: First <emphasis> + modern</emphasis> version of the protocol. Long filename + support.</para> + </listitem> - <listitem><para><constant>LANMAN2</constant>: Updates to Lanman1 protocol. - </para></listitem> + <listitem> + <para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.</para> + </listitem> - <listitem><para><constant>NT1</constant>: Current up to date version of - the protocol. Used by Windows NT. Known as CIFS.</para></listitem> - </itemizedlist> + <listitem> + <para><constant>NT1</constant>: Current up to date version of the protocol. + Used by Windows NT. Known as CIFS.</para> + </listitem> + </itemizedlist> - <para>Normally this option should not be set as the automatic - negotiation phase in the SMB protocol takes care of choosing - the appropriate protocol.</para> + <para>Normally this option should not be set as the automatic + negotiation phase in the SMB protocol takes care of choosing + the appropriate protocol.</para> - <para>See also <link linkend="MINPROTOCOL"><parameter moreinfo="none">min - protocol</parameter></link></para> + <para>See also <link linkend="MINPROTOCOL"><parameter moreinfo="none">min + protocol</parameter></link></para> - <para>Default: <command moreinfo="none">max protocol = NT1</command></para> - <para>Example: <command moreinfo="none">max protocol = LANMAN1</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max protocol = NT1</command></para> + + <para>Example: <command moreinfo="none">max protocol = LANMAN1</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxttl.xml b/docs/docbook/smbdotconf/protocol/maxttl.xml index 04c6771308..63c2b57ad7 100644 --- a/docs/docbook/smbdotconf/protocol/maxttl.xml +++ b/docs/docbook/smbdotconf/protocol/maxttl.xml @@ -1,12 +1,14 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXTTL"/>max ttl (G)</term> - <listitem><para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> - what the default 'time to live' of NetBIOS names should be (in seconds) - when <command moreinfo="none">nmbd</command> is requesting a name using either a - broadcast packet or from a WINS server. You should never need to - change this parameter. The default is 3 days.</para> +<samba:parameter name="max ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> what the default 'time to live' + of NetBIOS names should be (in seconds) when <command moreinfo="none">nmbd</command> is + requesting a name using either a broadcast packet or from a WINS server. You should + never need to change this parameter. The default is 3 days.</para> - <para>Default: <command moreinfo="none">max ttl = 259200</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max ttl = 259200</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxwinsttl.xml b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml index c8e2d9df8d..eafacc28fa 100644 --- a/docs/docbook/smbdotconf/protocol/maxwinsttl.xml +++ b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml @@ -1,15 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXWINSTTL"/>max wins ttl (G)</term> - <listitem><para>This option tells <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server (<link linkend="WINSSUPPORT"> - <parameter moreinfo="none">wins support = yes</parameter></link>) what the maximum - 'time to live' of NetBIOS names that <command moreinfo="none">nmbd</command> - will grant will be (in seconds). You should never need to change this - parameter. The default is 6 days (518400 seconds).</para> +<samba:parameter name="max wins ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server (<link linkend="WINSSUPPORT"> + <parameter moreinfo="none">wins support = yes</parameter></link>) what the maximum + 'time to live' of NetBIOS names that <command moreinfo="none">nmbd</command> + will grant will be (in seconds). You should never need to change this + parameter. The default is 6 days (518400 seconds).</para> - <para>See also the <link linkend="MINWINSTTL"><parameter moreinfo="none">min - wins ttl</parameter></link> parameter.</para> + <para>See also the <link linkend="MINWINSTTL"><parameter moreinfo="none">min + wins ttl</parameter></link> parameter.</para> - <para>Default: <command moreinfo="none">max wins ttl = 518400</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max wins ttl = 518400</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxxmit.xml b/docs/docbook/smbdotconf/protocol/maxxmit.xml index c16cf47655..3125b8d3b9 100644 --- a/docs/docbook/smbdotconf/protocol/maxxmit.xml +++ b/docs/docbook/smbdotconf/protocol/maxxmit.xml @@ -1,12 +1,16 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXXMIT"/>max xmit (G)</term> - <listitem><para>This option controls the maximum packet size - that will be negotiated by Samba. The default is 65535, which - is the maximum. In some cases you may find you get better performance - with a smaller value. A value below 2048 is likely to cause problems. - </para> +<samba:parameter name="max xmit" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option controls the maximum packet size + that will be negotiated by Samba. The default is 65535, which + is the maximum. In some cases you may find you get better performance + with a smaller value. A value below 2048 is likely to cause problems. + </para> - <para>Default: <command moreinfo="none">max xmit = 65535</command></para> - <para>Example: <command moreinfo="none">max xmit = 8192</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max xmit = 65535</command></para> + + <para>Example: <command moreinfo="none">max xmit = 8192</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/minprotocol.xml b/docs/docbook/smbdotconf/protocol/minprotocol.xml index 6b1d420a4b..f382701948 100644 --- a/docs/docbook/smbdotconf/protocol/minprotocol.xml +++ b/docs/docbook/smbdotconf/protocol/minprotocol.xml @@ -1,20 +1,23 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MINPROTOCOL"/>min protocol (G)</term> - <listitem><para>The value of the parameter (a string) is the - lowest SMB protocol dialect than Samba will support. Please refer - to the <link linkend="MAXPROTOCOL"><parameter moreinfo="none">max protocol</parameter></link> - parameter for a list of valid protocol names and a brief description - of each. You may also wish to refer to the C source code in - <filename moreinfo="none">source/smbd/negprot.c</filename> for a listing of known protocol - dialects supported by clients.</para> +<samba:parameter name="min protocol" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a string) is the + lowest SMB protocol dialect than Samba will support. Please refer + to the <link linkend="MAXPROTOCOL"><parameter moreinfo="none">max protocol</parameter></link> + parameter for a list of valid protocol names and a brief description + of each. You may also wish to refer to the C source code in + <filename moreinfo="none">source/smbd/negprot.c</filename> for a listing of known protocol + dialects supported by clients.</para> - <para>If you are viewing this parameter as a security measure, you should - also refer to the <link linkend="LANMANAUTH"><parameter moreinfo="none">lanman - auth</parameter></link> parameter. Otherwise, you should never need - to change this parameter.</para> + <para>If you are viewing this parameter as a security measure, you should + also refer to the <link linkend="LANMANAUTH"><parameter moreinfo="none">lanman + auth</parameter></link> parameter. Otherwise, you should never need + to change this parameter.</para> - <para>Default : <command moreinfo="none">min protocol = CORE</command></para> - <para>Example : <command moreinfo="none">min protocol = NT1</command> # disable DOS - clients</para> - </listitem> - </samba:parameter> + <para>Default : <command moreinfo="none">min protocol = CORE</command></para> + + <para>Example : <command moreinfo="none">min protocol = NT1</command> # disable DOS clients</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/minwinsttl.xml b/docs/docbook/smbdotconf/protocol/minwinsttl.xml index e67c253f2e..8ad1a5600f 100644 --- a/docs/docbook/smbdotconf/protocol/minwinsttl.xml +++ b/docs/docbook/smbdotconf/protocol/minwinsttl.xml @@ -1,13 +1,16 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MINWINSTTL"/>min wins ttl (G)</term> - <listitem><para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> - when acting as a WINS server (<link linkend="WINSSUPPORT"><parameter moreinfo="none"> - wins support = yes</parameter></link>) what the minimum 'time to live' - of NetBIOS names that <command moreinfo="none">nmbd</command> will grant will be (in - seconds). You should never need to change this parameter. The default - is 6 hours (21600 seconds).</para> +<samba:parameter name="min wins ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> + when acting as a WINS server (<link linkend="WINSSUPPORT"><parameter moreinfo="none"> + wins support = yes</parameter></link>) what the minimum 'time to live' + of NetBIOS names that <command moreinfo="none">nmbd</command> will grant will be (in + seconds). You should never need to change this parameter. The default + is 6 hours (21600 seconds).</para> - <para>Default: <command moreinfo="none">min wins ttl = 21600</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">min wins ttl = 21600</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml index a5dd893902..897d04ad1c 100644 --- a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml +++ b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml @@ -1,47 +1,58 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NAMERESOLVEORDER"/>name resolve order (G)</term> - <listitem><para>This option is used by the programs in the Samba - suite to determine what naming services to use and in what order - to resolve host names to IP addresses. The option takes a space - separated string of name resolution options.</para> - - <para>The options are :"lmhosts", "host", "wins" and "bcast". They - cause names to be resolved as follows :</para> - - <itemizedlist> - <listitem><para><constant>lmhosts</constant> : Lookup an IP - address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see the <ulink url="lmhosts.5.html">lmhosts(5)</ulink> for details) then - any name type matches for lookup.</para></listitem> - - <listitem><para><constant>host</constant> : Do a standard host - name to IP address resolution, using the system <filename moreinfo="none">/etc/hosts - </filename>, NIS, or DNS lookups. This method of name resolution - is operating system depended for instance on IRIX or Solaris this - may be controlled by the <filename moreinfo="none">/etc/nsswitch.conf</filename> - file. Note that this method is only used if the NetBIOS name - type being queried is the 0x20 (server) name type, otherwise - it is ignored.</para></listitem> - - <listitem><para><constant>wins</constant> : Query a name with - the IP address listed in the <link linkend="WINSSERVER"><parameter moreinfo="none"> - wins server</parameter></link> parameter. If no WINS server has - been specified this method will be ignored.</para></listitem> - - <listitem><para><constant>bcast</constant> : Do a broadcast on - each of the known local interfaces listed in the <link linkend="INTERFACES"><parameter moreinfo="none">interfaces</parameter></link> - parameter. This is the least reliable of the name resolution - methods as it depends on the target host being on a locally - connected subnet.</para></listitem> - </itemizedlist> - - <para>Default: <command moreinfo="none">name resolve order = lmhosts host wins bcast - </command></para> - <para>Example: <command moreinfo="none">name resolve order = lmhosts bcast host - </command></para> - - <para>This will cause the local lmhosts file to be examined - first, followed by a broadcast attempt, followed by a normal - system hostname lookup.</para> - </listitem> - </samba:parameter> +<samba:parameter name="name resolve order" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option is used by the programs in the Samba + suite to determine what naming services to use and in what order + to resolve host names to IP addresses. The option takes a space + separated string of name resolution options.</para> + + <para>The options are: "lmhosts", "host", + "wins" and "bcast". They cause names to be + resolved as follows:</para> + + <itemizedlist> + <listitem> + <para><constant>lmhosts</constant> : Lookup an IP + address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see the <ulink url="lmhosts.5.html">lmhosts(5)</ulink> for details) then + any name type matches for lookup.</para> + </listitem> + + <listitem> + <para><constant>host</constant> : Do a standard host + name to IP address resolution, using the system <filename moreinfo="none">/etc/hosts + </filename>, NIS, or DNS lookups. This method of name resolution + is operating system depended for instance on IRIX or Solaris this + may be controlled by the <filename moreinfo="none">/etc/nsswitch.conf</filename> + file. Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</para> + </listitem> + + <listitem> + <para><constant>wins</constant> : Query a name with + the IP address listed in the <link linkend="WINSSERVER"><parameter moreinfo="none"> + wins server</parameter></link> parameter. If no WINS server has + been specified this method will be ignored.</para> + </listitem> + + <listitem> + <para><constant>bcast</constant> : Do a broadcast on + each of the known local interfaces listed in the <link linkend="INTERFACES"><parameter moreinfo="none">interfaces</parameter></link> + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet.</para> + </listitem> + </itemizedlist> + + <para>Default: <command moreinfo="none">name resolve order = lmhosts host wins bcast</command></para> + + <para>Example: <command moreinfo="none">name resolve order = lmhosts bcast host</command></para> + + <para>This will cause the local lmhosts file to be examined + first, followed by a broadcast attempt, followed by a normal + system hostname lookup.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntaclsupport.xml b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml index df0d8dc068..64276d51c3 100644 --- a/docs/docbook/smbdotconf/protocol/ntaclsupport.xml +++ b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml @@ -1,11 +1,14 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NTACLSUPPORT"/>nt acl support (S)</term> - <listitem><para>This boolean parameter controls whether - <ulink url="smbd.8.html">smbd(8)</ulink> will attempt to map - UNIX permissions into Windows NT access control lists. - This parameter was formally a global parameter in releases - prior to 2.2.2.</para> +<samba:parameter name="nt acl support" + context="S" + advanced="1" wizard="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will attempt to map + UNIX permissions into Windows NT access control lists. + This parameter was formally a global parameter in releases + prior to 2.2.2.</para> - <para>Default: <command moreinfo="none">nt acl support = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">nt acl support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntpipesupport.xml b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml index cab2032847..e5c42a7696 100644 --- a/docs/docbook/smbdotconf/protocol/ntpipesupport.xml +++ b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml @@ -1,12 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NTPIPESUPPORT"/>nt pipe support (G)</term> - <listitem><para>This boolean parameter controls whether - <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> will allow Windows NT - clients to connect to the NT SMB specific <constant>IPC$</constant> - pipes. This is a developer debugging option and can be left - alone.</para> +<samba:parameter name="nt pipe support" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will allow Windows NT + clients to connect to the NT SMB specific <constant>IPC$</constant> + pipes. This is a developer debugging option and can be left + alone.</para> - <para>Default: <command moreinfo="none">nt pipe support = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">nt pipe support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntstatussupport.xml b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml index 17dafa47c5..ecb19128ee 100644 --- a/docs/docbook/smbdotconf/protocol/ntstatussupport.xml +++ b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml @@ -1,14 +1,17 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NTSTATUSSUPPORT"/>nt status support (G)</term> - <listitem><para>This boolean parameter controls whether <ulink url="smbd.8.html">smbd(8)</ulink> will negotiate NT specific status - support with Windows NT/2k/XP clients. This is a developer - debugging option and should be left alone. - If this option is set to <constant>no</constant> then Samba offers - exactly the same DOS error codes that versions prior to Samba 2.2.3 - reported.</para> +<samba:parameter name="nt status support" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will negotiate NT specific status + support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone. + If this option is set to <constant>no</constant> then Samba offers + exactly the same DOS error codes that versions prior to Samba 2.2.3 + reported.</para> - <para>You should not need to ever disable this parameter.</para> + <para>You should not need to ever disable this parameter.</para> - <para>Default: <command moreinfo="none">nt status support = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">nt status support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/protocol.xml b/docs/docbook/smbdotconf/protocol/protocol.xml index 5161806cfc..19926649c0 100644 --- a/docs/docbook/smbdotconf/protocol/protocol.xml +++ b/docs/docbook/smbdotconf/protocol/protocol.xml @@ -1,5 +1,9 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PROTOCOL"/>protocol (G)</term> - <listitem><para>Synonym for <link linkend="MAXPROTOCOL"> - <parameter moreinfo="none">max protocol</parameter></link>.</para></listitem> - </samba:parameter> +<samba:parameter name="protocol" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="MAXPROTOCOL"> + <parameter moreinfo="none">max protocol</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/readbmpx.xml b/docs/docbook/smbdotconf/protocol/readbmpx.xml index 0bc8f1d10b..0298407cef 100644 --- a/docs/docbook/smbdotconf/protocol/readbmpx.xml +++ b/docs/docbook/smbdotconf/protocol/readbmpx.xml @@ -1,10 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="READBMPX"/>read bmpx (G)</term> - <listitem><para>This boolean parameter controls whether <ulink url="smbd.8.html">smbd(8)</ulink> will support the "Read - Block Multiplex" SMB. This is now rarely used and defaults to - <constant>no</constant>. You should never need to set this - parameter.</para> +<samba:parameter name="read bmpx" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will support the "Read + Block Multiplex" SMB. This is now rarely used and defaults to + <constant>no</constant>. You should never need to set this + parameter.</para> - <para>Default: <command moreinfo="none">read bmpx = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">read bmpx = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/readraw.xml b/docs/docbook/smbdotconf/protocol/readraw.xml index b867816e84..6b24f39d68 100644 --- a/docs/docbook/smbdotconf/protocol/readraw.xml +++ b/docs/docbook/smbdotconf/protocol/readraw.xml @@ -1,21 +1,24 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="READRAW"/>read raw (G)</term> - <listitem><para>This parameter controls whether or not the server - will support the raw read SMB requests when transferring data - to clients.</para> +<samba:parameter name="read raw" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether or not the server + will support the raw read SMB requests when transferring data + to clients.</para> - <para>If enabled, raw reads allow reads of 65535 bytes in - one packet. This typically provides a major performance benefit. - </para> + <para>If enabled, raw reads allow reads of 65535 bytes in + one packet. This typically provides a major performance benefit. + </para> - <para>However, some clients either negotiate the allowable - block size incorrectly or are incapable of supporting larger block - sizes, and for these clients you may need to disable raw reads.</para> + <para>However, some clients either negotiate the allowable + block size incorrectly or are incapable of supporting larger block + sizes, and for these clients you may need to disable raw reads.</para> - <para>In general this parameter should be viewed as a system tuning - tool and left severely alone. See also <link linkend="WRITERAW"> - <parameter moreinfo="none">write raw</parameter></link>.</para> + <para>In general this parameter should be viewed as a system tuning + tool and left severely alone. See also <link linkend="WRITERAW"> + <parameter moreinfo="none">write raw</parameter></link>.</para> - <para>Default: <command moreinfo="none">read raw = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">read raw = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/smbports.xml b/docs/docbook/smbdotconf/protocol/smbports.xml index ed088ab9d2..9d06c37964 100644 --- a/docs/docbook/smbdotconf/protocol/smbports.xml +++ b/docs/docbook/smbdotconf/protocol/smbports.xml @@ -1,10 +1,10 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="SMBPORTS"/>smb ports (G)</term> - <listitem><para>Specifies which ports the server should listen on - for SMB traffic. - </para> +<samba:parameter name="smb ports" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies which ports the server should listen on for SMB traffic.</para> - <para>Default: <command moreinfo="none">smb ports = 445 139</command></para> - - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">smb ports = 445 139</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/timeserver.xml b/docs/docbook/smbdotconf/protocol/timeserver.xml index eb1a720a8d..d78f9a456d 100644 --- a/docs/docbook/smbdotconf/protocol/timeserver.xml +++ b/docs/docbook/smbdotconf/protocol/timeserver.xml @@ -1,9 +1,12 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="TIMESERVER"/>time server (G)</term> - <listitem><para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> advertises itself as a time server to Windows - clients.</para> +<samba:parameter name="time server" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> advertises itself as a time server to Windows + clients.</para> - <para>Default: <command moreinfo="none">time server = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">time server = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/unicode.xml b/docs/docbook/smbdotconf/protocol/unicode.xml index 866dad28a0..be93cb61e2 100644 --- a/docs/docbook/smbdotconf/protocol/unicode.xml +++ b/docs/docbook/smbdotconf/protocol/unicode.xml @@ -1,11 +1,13 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="UNICODE"/>unicode (G)</term> - <listitem><para>Specifies whether Samba should try - to use unicode on the wire by default. Note: This does NOT - mean that samba will assume that the unix machine uses unicode! - </para> +<samba:parameter name="unicode" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies whether Samba should try + to use unicode on the wire by default. Note: This does NOT + mean that samba will assume that the unix machine uses unicode! + </para> - <para>Default: <command moreinfo="none">unicode = yes</command></para> - - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">unicode = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/unixextensions.xml b/docs/docbook/smbdotconf/protocol/unixextensions.xml index d0adde9d27..2f68b9605e 100644 --- a/docs/docbook/smbdotconf/protocol/unixextensions.xml +++ b/docs/docbook/smbdotconf/protocol/unixextensions.xml @@ -1,12 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="UNIXEXTENSIONS"/>unix extensions(G)</term> - <listitem><para>This boolean parameter controls whether Samba - implments the CIFS UNIX extensions, as defined by HP. - These extensions enable Samba to better serve UNIX CIFS clients - by supporting features such as symbolic links, hard links, etc... - These extensions require a similarly enabled client, and are of - no current use to Windows clients.</para> +<samba:parameter name="unix extensions" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether Samba + implments the CIFS UNIX extensions, as defined by HP. + These extensions enable Samba to better serve UNIX CIFS clients + by supporting features such as symbolic links, hard links, etc... + These extensions require a similarly enabled client, and are of + no current use to Windows clients.</para> - <para>Default: <command moreinfo="none">unix extensions = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">unix extensions = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/usespnego.xml b/docs/docbook/smbdotconf/protocol/usespnego.xml index 9e3c873a4b..88c9f1df7a 100644 --- a/docs/docbook/smbdotconf/protocol/usespnego.xml +++ b/docs/docbook/smbdotconf/protocol/usespnego.xml @@ -1,11 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="USESPNEGO"/>use spnego (G)</term> - <listitem><para> This variable controls controls whether samba will try - to use Simple and Protected NEGOciation (as specified by rfc2478) with - WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. - Unless further issues are discovered with our SPNEGO - implementation, there is no reason this should ever be - disabled.</para> - <para>Default: <emphasis>use spnego = yes</emphasis></para> - </listitem> - </samba:parameter> +<samba:parameter name="use spnego" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> This variable controls controls whether samba will try + to use Simple and Protected NEGOciation (as specified by rfc2478) with + WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. + Unless further issues are discovered with our SPNEGO + implementation, there is no reason this should ever be + disabled.</para> + + <para>Default: <emphasis>use spnego = yes</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/writeraw.xml b/docs/docbook/smbdotconf/protocol/writeraw.xml index dbaad0130e..e71c54cabd 100644 --- a/docs/docbook/smbdotconf/protocol/writeraw.xml +++ b/docs/docbook/smbdotconf/protocol/writeraw.xml @@ -1,9 +1,12 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WRITERAW"/>write raw (G)</term> - <listitem><para>This parameter controls whether or not the server - will support raw write SMB's when transferring data from clients. - You should never need to change this parameter.</para> +<samba:parameter name="write raw" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether or not the server + will support raw write SMB's when transferring data from clients. + You should never need to change this parameter.</para> - <para>Default: <command moreinfo="none">write raw = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">write raw = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/serverschannel.xml b/docs/docbook/smbdotconf/security/serverschannel.xml index afbc458068..1747fbea66 100644 --- a/docs/docbook/smbdotconf/security/serverschannel.xml +++ b/docs/docbook/smbdotconf/security/serverschannel.xml @@ -17,7 +17,7 @@ <para>Please note that with this set to <parameter>no</parameter> you will have to apply the WindowsXP requireSignOrSeal-Registry patch found in - the docs/Registry subdirectory.</para + the docs/Registry subdirectory.</para> <para>Default: <command>server schannel = auto</command></para> <para>Example: <command>server schannel = yes</command></para> diff --git a/docs/docbook/smbdotconf/tuning/blocksize.xml b/docs/docbook/smbdotconf/tuning/blocksize.xml index da42ca9ece..eecf1925e8 100644 --- a/docs/docbook/smbdotconf/tuning/blocksize.xml +++ b/docs/docbook/smbdotconf/tuning/blocksize.xml @@ -1,19 +1,22 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="BLOCKSIZE"/>block size (S)</term> - <listitem><para>This parameter controls the behavior of <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> when reporting disk free - sizes. By default, this reports a disk block size of 1024 bytes. - </para> +<samba:parameter name="block size" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls the behavior of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when reporting disk free + sizes. By default, this reports a disk block size of 1024 bytes. + </para> - <para>Changing this parameter may have some effect on the - efficiency of client writes, this is not yet confirmed. This - parameter was added to allow advanced administrators to change - it (usually to a higher value) and test the effect it has on - client write performance without re-compiling the code. As this - is an experimental option it may be removed in a future release. - </para> + <para>Changing this parameter may have some effect on the + efficiency of client writes, this is not yet confirmed. This + parameter was added to allow advanced administrators to change + it (usually to a higher value) and test the effect it has on + client write performance without re-compiling the code. As this + is an experimental option it may be removed in a future release. + </para> - <para>Changing this option does not change the disk free reporting - size, just the block size unit reported to the client.</para> - </listitem> - </samba:parameter> + <para>Changing this option does not change the disk free reporting + size, just the block size unit reported to the client. + </para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml b/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml index 18c8b9a176..471798c269 100644 --- a/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml +++ b/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml @@ -1,15 +1,20 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="CHANGENOTIFYTIMEOUT"/>change notify timeout (G)</term> - <listitem><para>This SMB allows a client to tell a server to - "watch" a particular directory for any changes and only reply to - the SMB request when a change has occurred. Such constant scanning of - a directory is expensive under UNIX, hence an <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> daemon only performs such a scan - on each requested directory once every <parameter moreinfo="none">change notify - timeout</parameter> seconds.</para> +<samba:parameter name="change notify timeout" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This SMB allows a client to tell a server to + "watch" a particular directory for any changes and only reply to + the SMB request when a change has occurred. Such constant scanning of + a directory is expensive under UNIX, hence an <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon only performs such a scan + on each requested directory once every <parameter moreinfo="none">change notify + timeout</parameter> seconds.</para> - <para>Default: <command moreinfo="none">change notify timeout = 60</command></para> - <para>Example: <command moreinfo="none">change notify timeout = 300</command></para> + <para>Default: <command moreinfo="none">change notify timeout = 60</command></para> - <para>Would change the scan time to every 5 minutes.</para></listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">change notify timeout = 300</command></para> + + <para>Would change the scan time to every 5 minutes.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/deadtime.xml b/docs/docbook/smbdotconf/tuning/deadtime.xml index dbad06f25b..cbbf751862 100644 --- a/docs/docbook/smbdotconf/tuning/deadtime.xml +++ b/docs/docbook/smbdotconf/tuning/deadtime.xml @@ -1,23 +1,27 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DEADTIME"/>deadtime (G)</term> - <listitem><para>The value of the parameter (a decimal integer) - represents the number of minutes of inactivity before a connection - is considered dead, and it is disconnected. The deadtime only takes - effect if the number of open files is zero.</para> +<samba:parameter name="dead time" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a decimal integer) + represents the number of minutes of inactivity before a connection + is considered dead, and it is disconnected. The deadtime only takes + effect if the number of open files is zero.</para> - <para>This is useful to stop a server's resources being - exhausted by a large number of inactive connections.</para> + <para>This is useful to stop a server's resources being + exhausted by a large number of inactive connections.</para> - <para>Most clients have an auto-reconnect feature when a - connection is broken so in most cases this parameter should be - transparent to users.</para> + <para>Most clients have an auto-reconnect feature when a + connection is broken so in most cases this parameter should be + transparent to users.</para> - <para>Using this parameter with a timeout of a few minutes - is recommended for most systems.</para> + <para>Using this parameter with a timeout of a few minutes + is recommended for most systems.</para> - <para>A deadtime of zero indicates that no auto-disconnection - should be performed.</para> + <para>A deadtime of zero indicates that no auto-disconnection + should be performed.</para> - <para>Default: <command moreinfo="none">deadtime = 0</command></para> - <para>Example: <command moreinfo="none">deadtime = 15</command></para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">deadtime = 0</command></para> + <para>Example: <command moreinfo="none">deadtime = 15</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/getwdcache.xml b/docs/docbook/smbdotconf/tuning/getwdcache.xml index c797bad414..8c22be9fb5 100644 --- a/docs/docbook/smbdotconf/tuning/getwdcache.xml +++ b/docs/docbook/smbdotconf/tuning/getwdcache.xml @@ -1,11 +1,14 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="GETWDCACHE"/>getwd cache (G)</term> - <listitem><para>This is a tuning option. When this is enabled a - caching algorithm will be used to reduce the time taken for getwd() - calls. This can have a significant impact on performance, especially - when the <link linkend="WIDELINKS"><parameter moreinfo="none">wide links</parameter> - </link>parameter is set to <constant>no</constant>.</para> +<samba:parameter name="getwd cache" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a tuning option. When this is enabled a + caching algorithm will be used to reduce the time taken for getwd() + calls. This can have a significant impact on performance, especially + when the <link linkend="WIDELINKS"><parameter moreinfo="none">wide links</parameter> + </link> parameter is set to <constant>no</constant>.</para> - <para>Default: <command moreinfo="none">getwd cache = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">getwd cache = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/hostnamelookups.xml b/docs/docbook/smbdotconf/tuning/hostnamelookups.xml index daad09da8b..613fabe42f 100644 --- a/docs/docbook/smbdotconf/tuning/hostnamelookups.xml +++ b/docs/docbook/smbdotconf/tuning/hostnamelookups.xml @@ -1,14 +1,16 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="HOSTNAMELOOKUPS"/>hostname lookups (G)</term> - <listitem><para>Specifies whether samba should use (expensive) - hostname lookups or use the ip addresses instead. An example place - where hostname lookups are currently used is when checking - the <command moreinfo="none">hosts deny</command> and <command moreinfo="none">hosts allow</command>. - </para> +<samba:parameter name="hostname lookups" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies whether samba should use (expensive) + hostname lookups or use the ip addresses instead. An example place + where hostname lookups are currently used is when checking + the <command moreinfo="none">hosts deny</command> and <command moreinfo="none">hosts allow</command>. + </para> - <para>Default: <command moreinfo="none">hostname lookups = yes</command></para> + <para>Default: <command moreinfo="none">hostname lookups = yes</command></para> - <para>Example: <command moreinfo="none">hostname lookups = no</command></para> - - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">hostname lookups = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/keepalive.xml b/docs/docbook/smbdotconf/tuning/keepalive.xml index 746cda929e..1320dfab61 100644 --- a/docs/docbook/smbdotconf/tuning/keepalive.xml +++ b/docs/docbook/smbdotconf/tuning/keepalive.xml @@ -1,16 +1,21 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="KEEPALIVE"/>keepalive (G)</term> - <listitem><para>The value of the parameter (an integer) represents - the number of seconds between <parameter moreinfo="none">keepalive</parameter> - packets. If this parameter is zero, no keepalive packets will be - sent. Keepalive packets, if sent, allow the server to tell whether - a client is still present and responding.</para> +<samba:parameter name="keepalive" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (an integer) represents + the number of seconds between <parameter moreinfo="none">keepalive</parameter> + packets. If this parameter is zero, no keepalive packets will be + sent. Keepalive packets, if sent, allow the server to tell whether + a client is still present and responding.</para> - <para>Keepalives should, in general, not be needed if the socket - being used has the SO_KEEPALIVE attribute set on it (see <link linkend="SOCKETOPTIONS"><parameter moreinfo="none">socket options</parameter></link>). - Basically you should only use this option if you strike difficulties.</para> + <para>Keepalives should, in general, not be needed if the socket + being used has the SO_KEEPALIVE attribute set on it (see <link linkend="SOCKETOPTIONS"> + <parameter moreinfo="none">socket options</parameter></link>). + Basically you should only use this option if you strike difficulties.</para> - <para>Default: <command moreinfo="none">keepalive = 300</command></para> - <para>Example: <command moreinfo="none">keepalive = 600</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">keepalive = 300</command></para> + + <para>Example: <command moreinfo="none">keepalive = 600</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxconnections.xml b/docs/docbook/smbdotconf/tuning/maxconnections.xml index 24af886b60..5127df06f4 100644 --- a/docs/docbook/smbdotconf/tuning/maxconnections.xml +++ b/docs/docbook/smbdotconf/tuning/maxconnections.xml @@ -1,16 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXCONNECTIONS"/>max connections (S)</term> - <listitem><para>This option allows the number of simultaneous - connections to a service to be limited. If <parameter moreinfo="none">max connections - </parameter> is greater than 0 then connections will be refused if - this number of connections to the service are already open. A value - of zero mean an unlimited number of connections may be made.</para> +<samba:parameter name="max connections" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows the number of simultaneous connections to a service to be limited. + If <parameter moreinfo="none">max connections</parameter> is greater than 0 then connections + will be refused if this number of connections to the service are already open. A value + of zero mean an unlimited number of connections may be made.</para> - <para>Record lock files are used to implement this feature. The - lock files will be stored in the directory specified by the <link linkend="LOCKDIRECTORY"><parameter moreinfo="none">lock directory</parameter></link> - option.</para> + <para>Record lock files are used to implement this feature. The lock files will be stored in + the directory specified by the <link linkend="LOCKDIRECTORY"> + <parameter moreinfo="none">lock directory</parameter></link> option.</para> - <para>Default: <command moreinfo="none">max connections = 0</command></para> - <para>Example: <command moreinfo="none">max connections = 10</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max connections = 0</command></para> + + <para>Example: <command moreinfo="none">max connections = 10</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxdisksize.xml b/docs/docbook/smbdotconf/tuning/maxdisksize.xml index 8aebe91902..7d99b31e03 100644 --- a/docs/docbook/smbdotconf/tuning/maxdisksize.xml +++ b/docs/docbook/smbdotconf/tuning/maxdisksize.xml @@ -1,24 +1,28 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXDISKSIZE"/>max disk size (G)</term> - <listitem><para>This option allows you to put an upper limit - on the apparent size of disks. If you set this option to 100 - then all shares will appear to be not larger than 100 MB in - size.</para> +<samba:parameter name="max disk size" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to put an upper limit + on the apparent size of disks. If you set this option to 100 + then all shares will appear to be not larger than 100 MB in + size.</para> - <para>Note that this option does not limit the amount of - data you can put on the disk. In the above case you could still - store much more than 100 MB on the disk, but if a client ever asks - for the amount of free disk space or the total disk size then the - result will be bounded by the amount specified in <parameter moreinfo="none">max - disk size</parameter>.</para> + <para>Note that this option does not limit the amount of + data you can put on the disk. In the above case you could still + store much more than 100 MB on the disk, but if a client ever asks + for the amount of free disk space or the total disk size then the + result will be bounded by the amount specified in <parameter moreinfo="none">max + disk size</parameter>.</para> - <para>This option is primarily useful to work around bugs - in some pieces of software that can't handle very large disks, - particularly disks over 1GB in size.</para> + <para>This option is primarily useful to work around bugs + in some pieces of software that can't handle very large disks, + particularly disks over 1GB in size.</para> - <para>A <parameter moreinfo="none">max disk size</parameter> of 0 means no limit.</para> + <para>A <parameter moreinfo="none">max disk size</parameter> of 0 means no limit.</para> - <para>Default: <command moreinfo="none">max disk size = 0</command></para> - <para>Example: <command moreinfo="none">max disk size = 1000</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max disk size = 0</command></para> + + <para>Example: <command moreinfo="none">max disk size = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxopenfiles.xml b/docs/docbook/smbdotconf/tuning/maxopenfiles.xml index 85b76a3378..9505b2aaa5 100644 --- a/docs/docbook/smbdotconf/tuning/maxopenfiles.xml +++ b/docs/docbook/smbdotconf/tuning/maxopenfiles.xml @@ -1,16 +1,19 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXOPENFILES"/>max open files (G)</term> - <listitem><para>This parameter limits the maximum number of - open files that one <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> file - serving process may have open for a client at any one time. The - default for this parameter is set very high (10,000) as Samba uses - only one bit per unopened file.</para> +<samba:parameter name="max open files" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of + open files that one <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> file + serving process may have open for a client at any one time. The + default for this parameter is set very high (10,000) as Samba uses + only one bit per unopened file.</para> - <para>The limit of the number of open files is usually set - by the UNIX per-process file descriptor limit rather than - this parameter so you should never need to touch this parameter.</para> + <para>The limit of the number of open files is usually set + by the UNIX per-process file descriptor limit rather than + this parameter so you should never need to touch this parameter.</para> - <para>Default: <command moreinfo="none">max open files = 10000</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max open files = 10000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml b/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml index e46f0185ce..453818ab7d 100644 --- a/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml +++ b/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml @@ -1,17 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAXSMBDPROCESSES"/>max smbd processes (G)</term> - <listitem><para>This parameter limits the maximum number of - <ulink url="smbd.8.html"><command moreinfo="none">smbd(8)</command></ulink> - processes concurrently running on a system and is intended - as a stopgap to prevent degrading service to clients in the event - that the server has insufficient resources to handle more than this - number of connections. Remember that under normal operating - conditions, each user will have an <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> associated with him or her - to handle connections to all shares from a given host. - </para> +<samba:parameter name="max smbd processes" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> processes concurrently running on a system and is intended + as a stopgap to prevent degrading service to clients in the event that the server has insufficient + resources to handle more than this number of connections. Remember that under normal operating + conditions, each user will have an <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> associated with him or her to handle connections to all + shares from a given host.</para> - <para>Default: <command moreinfo="none">max smbd processes = 0</command> ## no limit</para> - <para>Example: <command moreinfo="none">max smbd processes = 1000</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">max smbd processes = 0</command> ## no limit</para> + + <para>Example: <command moreinfo="none">max smbd processes = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/minprintspace.xml b/docs/docbook/smbdotconf/tuning/minprintspace.xml index acbb65fa41..0df75af0ab 100644 --- a/docs/docbook/smbdotconf/tuning/minprintspace.xml +++ b/docs/docbook/smbdotconf/tuning/minprintspace.xml @@ -1,14 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MINPRINTSPACE"/>min print space (S)</term> - <listitem><para>This sets the minimum amount of free disk - space that must be available before a user will be able to spool - a print job. It is specified in kilobytes. The default is 0, which - means a user can always spool a print job.</para> +<samba:parameter name="min print space" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This sets the minimum amount of free disk + space that must be available before a user will be able to spool + a print job. It is specified in kilobytes. The default is 0, which + means a user can always spool a print job.</para> - <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing - </parameter></link> parameter.</para> + <para>See also the <link linkend="PRINTING"><parameter moreinfo="none">printing + </parameter></link> parameter.</para> - <para>Default: <command moreinfo="none">min print space = 0</command></para> - <para>Example: <command moreinfo="none">min print space = 2000</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">min print space = 0</command></para> + + <para>Example: <command moreinfo="none">min print space = 2000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/namecachetimeout.xml b/docs/docbook/smbdotconf/tuning/namecachetimeout.xml index 0500a75c8d..6330760915 100644 --- a/docs/docbook/smbdotconf/tuning/namecachetimeout.xml +++ b/docs/docbook/smbdotconf/tuning/namecachetimeout.xml @@ -1,12 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NAMECACHETIMEOUT"/>name cache timeout (G)</term> - <listitem><para>Specifies the number of seconds it takes before - entries in samba's hostname resolve cache time out. If - the timeout is set to 0. the caching is disabled. - </para> +<samba:parameter name="name cache timeout" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies the number of seconds it takes before + entries in samba's hostname resolve cache time out. If + the timeout is set to 0. the caching is disabled. + </para> + <para>Default: <command moreinfo="none">name cache timeout = 660</command></para> - <para>Default: <command moreinfo="none">name cache timeout = 660</command></para> - <para>Example: <command moreinfo="none">name cache timeout = 0</command></para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">name cache timeout = 0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml b/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml index d60f179176..3fababf01b 100644 --- a/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml +++ b/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml @@ -1,16 +1,18 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PARANOIDSERVERSECURITY"/>paranoid server security (G)</term> - <listitem><para>Some version of NT 4.x allow non-guest - users with a bad passowrd. When this option is enabled, samba will not - use a broken NT 4.x server as password server, but instead complain - to the logs and exit. - </para> +<samba:parameter name="paranoid server security" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Some version of NT 4.x allow non-guest + users with a bad passowrd. When this option is enabled, samba will not + use a broken NT 4.x server as password server, but instead complain + to the logs and exit. + </para> - <para>Disabling this option prevents Samba from making - this check, which involves deliberatly attempting a - bad logon to the remote server.</para> + <para>Disabling this option prevents Samba from making + this check, which involves deliberatly attempting a + bad logon to the remote server.</para> - <para>Default: <command moreinfo="none">paranoid server security = yes</command></para> - - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">paranoid server security = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/readsize.xml b/docs/docbook/smbdotconf/tuning/readsize.xml index 59c6848c76..c76b810225 100644 --- a/docs/docbook/smbdotconf/tuning/readsize.xml +++ b/docs/docbook/smbdotconf/tuning/readsize.xml @@ -1,25 +1,29 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="READSIZE"/>read size (G)</term> - <listitem><para>The option <parameter moreinfo="none">read size</parameter> - affects the overlap of disk reads/writes with network reads/writes. - If the amount of data being transferred in several of the SMB - commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger - than this value then the server begins writing the data before it - has received the whole packet from the network, or in the case of - SMBreadbraw, it begins writing to the network before all the data - has been read from disk.</para> +<samba:parameter name="read size" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The option <parameter moreinfo="none">read size</parameter> + affects the overlap of disk reads/writes with network reads/writes. + If the amount of data being transferred in several of the SMB + commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger + than this value then the server begins writing the data before it + has received the whole packet from the network, or in the case of + SMBreadbraw, it begins writing to the network before all the data + has been read from disk.</para> - <para>This overlapping works best when the speeds of disk and - network access are similar, having very little effect when the - speed of one is much greater than the other.</para> + <para>This overlapping works best when the speeds of disk and + network access are similar, having very little effect when the + speed of one is much greater than the other.</para> - <para>The default value is 16384, but very little experimentation - has been done yet to determine the optimal value, and it is likely - that the best value will vary greatly between systems anyway. - A value over 65536 is pointless and will cause you to allocate - memory unnecessarily.</para> + <para>The default value is 16384, but very little experimentation + has been done yet to determine the optimal value, and it is likely + that the best value will vary greatly between systems anyway. + A value over 65536 is pointless and will cause you to allocate + memory unnecessarily.</para> - <para>Default: <command moreinfo="none">read size = 16384</command></para> - <para>Example: <command moreinfo="none">read size = 8192</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">read size = 16384</command></para> + + <para>Example: <command moreinfo="none">read size = 8192</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/socketoptions.xml b/docs/docbook/smbdotconf/tuning/socketoptions.xml index 3acc259083..5684ac5bca 100644 --- a/docs/docbook/smbdotconf/tuning/socketoptions.xml +++ b/docs/docbook/smbdotconf/tuning/socketoptions.xml @@ -1,69 +1,75 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="SOCKETOPTIONS"/>socket options (G)</term> - <listitem><para>This option allows you to set socket options - to be used when talking with the client.</para> - - <para>Socket options are controls on the networking layer - of the operating systems which allow the connection to be - tuned.</para> - - <para>This option will typically be used to tune your Samba - server for optimal performance for your local network. There is - no way that Samba can know what the optimal parameters are for - your net, so you must experiment and choose them yourself. We - strongly suggest you read the appropriate documentation for your - operating system first (perhaps <command moreinfo="none">man setsockopt</command> - will help).</para> - - <para>You may find that on some systems Samba will say - "Unknown socket option" when you supply an option. This means you - either incorrectly typed it or you need to add an include file - to includes.h for your OS. If the latter is the case please - send the patch to <ulink url="mailto:samba@samba.org"> - samba@samba.org</ulink>.</para> - - <para>Any of the supported socket options may be combined - in any way you like, as long as your OS allows it.</para> - - <para>This is the list of socket options currently settable - using this option:</para> - - <itemizedlist> - <listitem><para>SO_KEEPALIVE</para></listitem> - <listitem><para>SO_REUSEADDR</para></listitem> - <listitem><para>SO_BROADCAST</para></listitem> - <listitem><para>TCP_NODELAY</para></listitem> - <listitem><para>IPTOS_LOWDELAY</para></listitem> - <listitem><para>IPTOS_THROUGHPUT</para></listitem> - <listitem><para>SO_SNDBUF *</para></listitem> - <listitem><para>SO_RCVBUF *</para></listitem> - <listitem><para>SO_SNDLOWAT *</para></listitem> - <listitem><para>SO_RCVLOWAT *</para></listitem> - </itemizedlist> - - <para>Those marked with a <emphasis>'*'</emphasis> take an integer - argument. The others can optionally take a 1 or 0 argument to enable - or disable the option, by default they will be enabled if you - don't specify 1 or 0.</para> - - <para>To specify an argument use the syntax SOME_OPTION = VALUE - for example <command moreinfo="none">SO_SNDBUF = 8192</command>. Note that you must - not have any spaces before or after the = sign.</para> - - <para>If you are on a local network then a sensible option - might be</para> - <para><command moreinfo="none">socket options = IPTOS_LOWDELAY</command></para> - - <para>If you have a local network then you could try:</para> - <para><command moreinfo="none">socket options = IPTOS_LOWDELAY TCP_NODELAY</command></para> - - <para>If you are on a wide area network then perhaps try - setting IPTOS_THROUGHPUT. </para> - - <para>Note that several of the options may cause your Samba - server to fail completely. Use these options with caution!</para> - - <para>Default: <command moreinfo="none">socket options = TCP_NODELAY</command></para> - <para>Example: <command moreinfo="none">socket options = IPTOS_LOWDELAY</command></para> - </listitem> - </samba:parameter> +<samba:parameter name="socket options" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option allows you to set socket options + to be used when talking with the client.</para> + + <para>Socket options are controls on the networking layer + of the operating systems which allow the connection to be + tuned.</para> + + <para>This option will typically be used to tune your Samba server + for optimal performance for your local network. There is no way + that Samba can know what the optimal parameters are for your net, + so you must experiment and choose them yourself. We strongly + suggest you read the appropriate documentation for your operating + system first (perhaps <command moreinfo="none">man + setsockopt</command> will help).</para> + + <para>You may find that on some systems Samba will say + "Unknown socket option" when you supply an option. This means you + either incorrectly typed it or you need to add an include file + to includes.h for your OS. If the latter is the case please + send the patch to <ulink url="mailto:samba-technical@samba.org"> + samba-technical@samba.org</ulink>.</para> + + <para>Any of the supported socket options may be combined + in any way you like, as long as your OS allows it.</para> + + <para>This is the list of socket options currently settable + using this option:</para> + + <itemizedlist> + <listitem><para>SO_KEEPALIVE</para></listitem> + <listitem><para>SO_REUSEADDR</para></listitem> + <listitem><para>SO_BROADCAST</para></listitem> + <listitem><para>TCP_NODELAY</para></listitem> + <listitem><para>IPTOS_LOWDELAY</para></listitem> + <listitem><para>IPTOS_THROUGHPUT</para></listitem> + <listitem><para>SO_SNDBUF *</para></listitem> + <listitem><para>SO_RCVBUF *</para></listitem> + <listitem><para>SO_SNDLOWAT *</para></listitem> + <listitem><para>SO_RCVLOWAT *</para></listitem> + </itemizedlist> + + <para>Those marked with a <emphasis>'*'</emphasis> take an integer + argument. The others can optionally take a 1 or 0 argument to enable + or disable the option, by default they will be enabled if you + don't specify 1 or 0.</para> + + <para>To specify an argument use the syntax SOME_OPTION = VALUE + for example <command moreinfo="none">SO_SNDBUF = 8192</command>. Note that you must + not have any spaces before or after the = sign.</para> + + <para>If you are on a local network then a sensible option + might be:</para> + + <para><command moreinfo="none">socket options = IPTOS_LOWDELAY</command></para> + + <para>If you have a local network then you could try:</para> + + <para><command moreinfo="none">socket options = IPTOS_LOWDELAY TCP_NODELAY</command></para> + + <para>If you are on a wide area network then perhaps try + setting IPTOS_THROUGHPUT. </para> + + <para>Note that several of the options may cause your Samba + server to fail completely. Use these options with caution!</para> + + <para>Default: <command moreinfo="none">socket options = TCP_NODELAY</command></para> + + <para>Example: <command moreinfo="none">socket options = IPTOS_LOWDELAY</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/statcachesize.xml b/docs/docbook/smbdotconf/tuning/statcachesize.xml index fe7d3a7be2..0c8d4e0c72 100644 --- a/docs/docbook/smbdotconf/tuning/statcachesize.xml +++ b/docs/docbook/smbdotconf/tuning/statcachesize.xml @@ -1,9 +1,12 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="STATCACHESIZE"/>stat cache size (G)</term> - <listitem><para>This parameter determines the number of - entries in the <parameter moreinfo="none">stat cache</parameter>. You should - never need to change this parameter.</para> +<samba:parameter name="stat cache size" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines the number of + entries in the <parameter moreinfo="none">stat cache</parameter>. You should + never need to change this parameter.</para> - <para>Default: <command moreinfo="none">stat cache size = 50</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">stat cache size = 50</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/strictallocate.xml b/docs/docbook/smbdotconf/tuning/strictallocate.xml index 7b33ef3fc3..0d11519b04 100644 --- a/docs/docbook/smbdotconf/tuning/strictallocate.xml +++ b/docs/docbook/smbdotconf/tuning/strictallocate.xml @@ -1,21 +1,23 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="STRICTALLOCATE"/>strict allocate (S)</term> - <listitem><para>This is a boolean that controls the handling of - disk space allocation in the server. When this is set to <constant>yes</constant> - the server will change from UNIX behaviour of not committing real - disk storage blocks when a file is extended to the Windows behaviour - of actually forcing the disk system to allocate real storage blocks - when a file is created or extended to be a given size. In UNIX - terminology this means that Samba will stop creating sparse files. - This can be slow on some systems.</para> +<samba:parameter name="strict allocate" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean that controls the handling of + disk space allocation in the server. When this is set to <constant>yes</constant> + the server will change from UNIX behaviour of not committing real + disk storage blocks when a file is extended to the Windows behaviour + of actually forcing the disk system to allocate real storage blocks + when a file is created or extended to be a given size. In UNIX + terminology this means that Samba will stop creating sparse files. + This can be slow on some systems.</para> - <para>When strict allocate is <constant>no</constant> the server does sparse - disk block allocation when a file is extended.</para> + <para>When strict allocate is <constant>no</constant> the server does sparse + disk block allocation when a file is extended.</para> - <para>Setting this to <constant>yes</constant> can help Samba return - out of quota messages on systems that are restricting the disk quota - of users.</para> + <para>Setting this to <constant>yes</constant> can help Samba return + out of quota messages on systems that are restricting the disk quota + of users.</para> - <para>Default: <command moreinfo="none">strict allocate = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">strict allocate = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/strictsync.xml b/docs/docbook/smbdotconf/tuning/strictsync.xml index b228f7cfcb..693806a503 100644 --- a/docs/docbook/smbdotconf/tuning/strictsync.xml +++ b/docs/docbook/smbdotconf/tuning/strictsync.xml @@ -1,23 +1,25 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="STRICTSYNC"/>strict sync (S)</term> - <listitem><para>Many Windows applications (including the Windows - 98 explorer shell) seem to confuse flushing buffer contents to - disk with doing a sync to disk. Under UNIX, a sync call forces - the process to be suspended until the kernel has ensured that - all outstanding data in kernel disk buffers has been safely stored - onto stable storage. This is very slow and should only be done - rarely. Setting this parameter to <constant>no</constant> (the - default) means that <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> ignores the Windows applications requests for - a sync call. There is only a possibility of losing data if the - operating system itself that Samba is running on crashes, so there is - little danger in this default setting. In addition, this fixes many - performance problems that people have reported with the new Windows98 - explorer shell file copies.</para> +<samba:parameter name="strict sync" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Many Windows applications (including the Windows 98 explorer + shell) seem to confuse flushing buffer contents to disk with doing + a sync to disk. Under UNIX, a sync call forces the process to be + suspended until the kernel has ensured that all outstanding data in + kernel disk buffers has been safely stored onto stable storage. + This is very slow and should only be done rarely. Setting this + parameter to <constant>no</constant> (the default) means that + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> ignores the Windows + applications requests for a sync call. There is only a possibility + of losing data if the operating system itself that Samba is running + on crashes, so there is little danger in this default setting. In + addition, this fixes many performance problems that people have + reported with the new Windows98 explorer shell file copies.</para> - <para>See also the <link linkend="SYNCALWAYS"><parameter moreinfo="none">sync - always></parameter></link> parameter.</para> + <para>See also the <link linkend="SYNCALWAYS"><parameter moreinfo="none">sync + always></parameter></link> parameter.</para> - <para>Default: <command moreinfo="none">strict sync = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">strict sync = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/syncalways.xml b/docs/docbook/smbdotconf/tuning/syncalways.xml index c5c32343a7..dca33eb802 100644 --- a/docs/docbook/smbdotconf/tuning/syncalways.xml +++ b/docs/docbook/smbdotconf/tuning/syncalways.xml @@ -1,19 +1,21 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="SYNCALWAYS"/>sync always (S)</term> - <listitem><para>This is a boolean parameter that controls - whether writes will always be written to stable storage before - the write call returns. If this is <constant>no</constant> then the server will be - guided by the client's request in each write call (clients can - set a bit indicating that a particular write should be synchronous). - If this is <constant>yes</constant> then every write will be followed by a <command moreinfo="none">fsync() - </command> call to ensure the data is written to disk. Note that - the <parameter moreinfo="none">strict sync</parameter> parameter must be set to - <constant>yes</constant> in order for this parameter to have - any affect.</para> +<samba:parameter name="sync always" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a boolean parameter that controls + whether writes will always be written to stable storage before + the write call returns. If this is <constant>no</constant> then the server will be + guided by the client's request in each write call (clients can + set a bit indicating that a particular write should be synchronous). + If this is <constant>yes</constant> then every write will be followed by a <command moreinfo="none">fsync() + </command> call to ensure the data is written to disk. Note that + the <parameter moreinfo="none">strict sync</parameter> parameter must be set to + <constant>yes</constant> in order for this parameter to have + any affect.</para> - <para>See also the <link linkend="STRICTSYNC"><parameter moreinfo="none">strict - sync</parameter></link> parameter.</para> + <para>See also the <link linkend="STRICTSYNC"><parameter moreinfo="none">strict + sync</parameter></link> parameter.</para> - <para>Default: <command moreinfo="none">sync always = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">sync always = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/usemmap.xml b/docs/docbook/smbdotconf/tuning/usemmap.xml index 46fa4600de..1e79e07ef3 100644 --- a/docs/docbook/smbdotconf/tuning/usemmap.xml +++ b/docs/docbook/smbdotconf/tuning/usemmap.xml @@ -1,14 +1,17 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="USEMMAP"/>use mmap (G)</term> - <listitem><para>This global parameter determines if the tdb internals of Samba can - depend on mmap working correctly on the running system. Samba requires a coherent - mmap/read-write system memory cache. Currently only HPUX does not have such a - coherent cache, and so this parameter is set to <constant>no</constant> by - default on HPUX. On all other systems this parameter should be left alone. This - parameter is provided to help the Samba developers track down problems with - the tdb internal code. - </para> +<samba:parameter name="use mmap" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This global parameter determines if the tdb internals of Samba can + depend on mmap working correctly on the running system. Samba requires a coherent + mmap/read-write system memory cache. Currently only HPUX does not have such a + coherent cache, and so this parameter is set to <constant>no</constant> by + default on HPUX. On all other systems this parameter should be left alone. This + parameter is provided to help the Samba developers track down problems with + the tdb internal code. + </para> - <para>Default: <command moreinfo="none">use mmap = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">use mmap = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/usesendfile.xml b/docs/docbook/smbdotconf/tuning/usesendfile.xml index 5f2dcb72a9..6bbd651549 100644 --- a/docs/docbook/smbdotconf/tuning/usesendfile.xml +++ b/docs/docbook/smbdotconf/tuning/usesendfile.xml @@ -1,14 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="USESENDFILE"/>use sendfile (S)</term> - <listitem><para>If this parameter is <constant>yes</constant>, and Samba - was built with the --with-sendfile-support option, and the underlying operating - system supports sendfile system call, then some SMB read calls (mainly ReadAndX - and ReadRaw) will use the more efficient sendfile system call for files that - are exclusively oplocked. This may make more efficient use of the system CPU's - and cause Samba to be faster. This is off by default as it's effects are unknown - as yet. - </para> +<samba:parameter name="use sendfile" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this parameter is <constant>yes</constant>, and Samba + was built with the --with-sendfile-support option, and the underlying operating + system supports sendfile system call, then some SMB read calls (mainly ReadAndX + and ReadRaw) will use the more efficient sendfile system call for files that + are exclusively oplocked. This may make more efficient use of the system CPU's + and cause Samba to be faster. This is off by default as it's effects are unknown + as yet.</para> - <para>Default: <command moreinfo="none">use sendfile = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">use sendfile = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/tuning/writecachesize.xml b/docs/docbook/smbdotconf/tuning/writecachesize.xml index b54a0e4fd6..8b5fbe66bd 100644 --- a/docs/docbook/smbdotconf/tuning/writecachesize.xml +++ b/docs/docbook/smbdotconf/tuning/writecachesize.xml @@ -1,27 +1,30 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WRITECACHESIZE"/>write cache size (S)</term> - <listitem><para>If this integer parameter is set to non-zero value, - Samba will create an in-memory cache for each oplocked file - (it does <emphasis>not</emphasis> do this for - non-oplocked files). All writes that the client does not request - to be flushed directly to disk will be stored in this cache if possible. - The cache is flushed onto disk when a write comes in whose offset - would not fit into the cache or when the file is closed by the client. - Reads for the file are also served from this cache if the data is stored - within it.</para> +<samba:parameter name="write cache size" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>If this integer parameter is set to non-zero value, + Samba will create an in-memory cache for each oplocked file + (it does <emphasis>not</emphasis> do this for + non-oplocked files). All writes that the client does not request + to be flushed directly to disk will be stored in this cache if possible. + The cache is flushed onto disk when a write comes in whose offset + would not fit into the cache or when the file is closed by the client. + Reads for the file are also served from this cache if the data is stored + within it.</para> - <para>This cache allows Samba to batch client writes into a more - efficient write size for RAID disks (i.e. writes may be tuned to - be the RAID stripe size) and can improve performance on systems - where the disk subsystem is a bottleneck but there is free - memory for userspace programs.</para> + <para>This cache allows Samba to batch client writes into a more + efficient write size for RAID disks (i.e. writes may be tuned to + be the RAID stripe size) and can improve performance on systems + where the disk subsystem is a bottleneck but there is free + memory for userspace programs.</para> - <para>The integer parameter specifies the size of this cache - (per oplocked file) in bytes.</para> + <para>The integer parameter specifies the size of this cache + (per oplocked file) in bytes.</para> - <para>Default: <command moreinfo="none">write cache size = 0</command></para> - <para>Example: <command moreinfo="none">write cache size = 262144</command></para> + <para>Default: <command moreinfo="none">write cache size = 0</command></para> - <para>for a 256k cache size per file.</para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">write cache size = 262144</command></para> + + <para>for a 256k cache size per file.</para> +</listitem> +</samba:parameter> |