summaryrefslogtreecommitdiff
path: root/docs/docbook
diff options
context:
space:
mode:
authorAlexander Bokovoy <ab@samba.org>2003-04-15 08:09:55 +0000
committerAlexander Bokovoy <ab@samba.org>2003-04-15 08:09:55 +0000
commit27eb9d97373c772a2a74d6b0fd27dbabbe7e5912 (patch)
tree925af3e5cc34754d56d3e0e34eb197a575427ed9 /docs/docbook
parent084684468dd99d0879843dd0c38db25e28c73937 (diff)
downloadsamba-27eb9d97373c772a2a74d6b0fd27dbabbe7e5912.tar.gz
samba-27eb9d97373c772a2a74d6b0fd27dbabbe7e5912.tar.bz2
samba-27eb9d97373c772a2a74d6b0fd27dbabbe7e5912.zip
Convert another group of options in Misc section
(This used to be commit 43f8ae46137ed653c5694a839a5e6757e4a89974)
Diffstat (limited to 'docs/docbook')
-rw-r--r--docs/docbook/smbdotconf/misc/available.xml22
-rw-r--r--docs/docbook/smbdotconf/misc/dontdescend.xml35
-rw-r--r--docs/docbook/smbdotconf/misc/followsymlinks.xml35
-rw-r--r--docs/docbook/smbdotconf/misc/fstype.xml30
-rw-r--r--docs/docbook/smbdotconf/misc/postexec.xml34
-rw-r--r--docs/docbook/smbdotconf/misc/preexecclose.xml19
-rw-r--r--docs/docbook/smbdotconf/misc/rootpostexec.xml26
-rw-r--r--docs/docbook/smbdotconf/misc/rootpreexec.xml28
-rw-r--r--docs/docbook/smbdotconf/misc/rootpreexecclose.xml23
-rw-r--r--docs/docbook/smbdotconf/misc/setdirectory.xml24
-rw-r--r--docs/docbook/smbdotconf/misc/sourceenvironment.xml42
-rw-r--r--docs/docbook/smbdotconf/misc/volume.xml18
-rw-r--r--docs/docbook/smbdotconf/misc/widelinks.xml28
13 files changed, 198 insertions, 166 deletions
diff --git a/docs/docbook/smbdotconf/misc/available.xml b/docs/docbook/smbdotconf/misc/available.xml
index 025c1c06fb..20931b3063 100644
--- a/docs/docbook/smbdotconf/misc/available.xml
+++ b/docs/docbook/smbdotconf/misc/available.xml
@@ -1,11 +1,13 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="AVAILABLE"/>available (S)</term>
- <listitem><para>This parameter lets you &quot;turn off&quot; a service. If
- <parameter moreinfo="none">available = no</parameter>, then <emphasis>ALL</emphasis>
- attempts to connect to the service will fail. Such failures are
- logged.</para>
+<samba:parameter name="available"
+ context="S"
+ basic="1" advanced="1" print="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter lets you &quot;turn off&quot; a service. If
+ <parameter moreinfo="none">available = no</parameter>, then <emphasis>ALL</emphasis>
+ attempts to connect to the service will fail. Such failures are
+ logged.</para>
- <para>Default: <command moreinfo="none">available = yes</command></para>
-
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">available = yes</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/dontdescend.xml b/docs/docbook/smbdotconf/misc/dontdescend.xml
index 8136f293df..d3e9fb2d5c 100644
--- a/docs/docbook/smbdotconf/misc/dontdescend.xml
+++ b/docs/docbook/smbdotconf/misc/dontdescend.xml
@@ -1,18 +1,21 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="DONTDESCEND"/>dont descend (S)</term>
- <listitem><para>There are certain directories on some systems
- (e.g., the <filename moreinfo="none">/proc</filename> tree under Linux) that are either not
- of interest to clients or are infinitely deep (recursive). This
- parameter allows you to specify a comma-delimited list of directories
- that the server should always show as empty.</para>
+<samba:parameter name="dont descend"
+ context="S"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>There are certain directories on some systems
+ (e.g., the <filename moreinfo="none">/proc</filename> tree under Linux) that are either not
+ of interest to clients or are infinitely deep (recursive). This
+ parameter allows you to specify a comma-delimited list of directories
+ that the server should always show as empty.</para>
- <para>Note that Samba can be very fussy about the exact format
- of the &quot;dont descend&quot; entries. For example you may need <filename moreinfo="none">
- ./proc</filename> instead of just <filename moreinfo="none">/proc</filename>.
- Experimentation is the best policy :-) </para>
+ <para>Note that Samba can be very fussy about the exact format
+ of the &quot;dont descend&quot; entries. For example you may need <filename moreinfo="none">
+ ./proc</filename> instead of just <filename moreinfo="none">/proc</filename>.
+ Experimentation is the best policy :-) </para>
- <para>Default: <emphasis>none (i.e., all directories are OK
- to descend)</emphasis></para>
- <para>Example: <command moreinfo="none">dont descend = /proc,/dev</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <emphasis>none (i.e., all directories are OK
+ to descend)</emphasis></para>
+
+ <para>Example: <command moreinfo="none">dont descend = /proc,/dev</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/followsymlinks.xml b/docs/docbook/smbdotconf/misc/followsymlinks.xml
index 88526da320..1b22eb9e64 100644
--- a/docs/docbook/smbdotconf/misc/followsymlinks.xml
+++ b/docs/docbook/smbdotconf/misc/followsymlinks.xml
@@ -1,18 +1,21 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="FOLLOWSYMLINKS"/>follow symlinks (S)</term>
- <listitem><para>This parameter allows the Samba administrator
- to stop <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> from following symbolic
- links in a particular share. Setting this
- parameter to <constant>no</constant> prevents any file or directory
- that is a symbolic link from being followed (the user will get an
- error). This option is very useful to stop users from adding a
- symbolic link to <filename moreinfo="none">/etc/passwd</filename> in their home
- directory for instance. However it will slow filename lookups
- down slightly.</para>
+<samba:parameter name="follow symlinks"
+ context="S"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter allows the Samba administrator
+ to stop <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> from following symbolic
+ links in a particular share. Setting this
+ parameter to <constant>no</constant> prevents any file or directory
+ that is a symbolic link from being followed (the user will get an
+ error). This option is very useful to stop users from adding a
+ symbolic link to <filename moreinfo="none">/etc/passwd</filename> in their home
+ directory for instance. However it will slow filename lookups
+ down slightly.</para>
- <para>This option is enabled (i.e. <command moreinfo="none">smbd</command> will
- follow symbolic links) by default.</para>
+ <para>This option is enabled (i.e. <command moreinfo="none">smbd</command> will
+ follow symbolic links) by default.</para>
- <para>Default: <command moreinfo="none">follow symlinks = yes</command></para></listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">follow symlinks = yes</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/fstype.xml b/docs/docbook/smbdotconf/misc/fstype.xml
index 566bccb465..4b9c67b202 100644
--- a/docs/docbook/smbdotconf/misc/fstype.xml
+++ b/docs/docbook/smbdotconf/misc/fstype.xml
@@ -1,14 +1,18 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="FSTYPE"/>fstype (S)</term>
- <listitem><para>This parameter allows the administrator to
- configure the string that specifies the type of filesystem a share
- is using that is reported by <citerefentry><refentrytitle>smbd</refentrytitle>
- <manvolnum>8</manvolnum></citerefentry> when a client queries the filesystem type
- for a share. The default type is <constant>NTFS</constant> for
- compatibility with Windows NT but this can be changed to other
- strings such as <constant>Samba</constant> or <constant>FAT
- </constant> if required.</para>
+<samba:parameter name="fstype"
+ context="S"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter allows the administrator to
+ configure the string that specifies the type of filesystem a share
+ is using that is reported by <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> when a client queries the filesystem type
+ for a share. The default type is <constant>NTFS</constant> for
+ compatibility with Windows NT but this can be changed to other
+ strings such as <constant>Samba</constant> or <constant>FAT
+ </constant> if required.</para>
- <para>Default: <command moreinfo="none">fstype = NTFS</command></para>
- <para>Example: <command moreinfo="none">fstype = Samba</command></para></listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">fstype = NTFS</command></para>
+
+ <para>Example: <command moreinfo="none">fstype = Samba</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/postexec.xml b/docs/docbook/smbdotconf/misc/postexec.xml
index 017177be3d..a6b65515ad 100644
--- a/docs/docbook/smbdotconf/misc/postexec.xml
+++ b/docs/docbook/smbdotconf/misc/postexec.xml
@@ -1,22 +1,22 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="POSTEXEC"/>postexec (S)</term>
- <listitem><para>This option specifies a command to be run
- whenever the service is disconnected. It takes the usual
- substitutions. The command may be run as the root on some
- systems.</para>
+<samba:parameter name="postexec"
+ context="S"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This option specifies a command to be run
+ whenever the service is disconnected. It takes the usual
+ substitutions. The command may be run as the root on some
+ systems.</para>
- <para>An interesting example may be to unmount server
- resources:</para>
+ <para>An interesting example may be to unmount server
+ resources:</para>
- <para><command moreinfo="none">postexec = /etc/umount /cdrom</command></para>
+ <para><command moreinfo="none">postexec = /etc/umount /cdrom</command></para>
- <para>See also <link linkend="PREEXEC"><parameter moreinfo="none">preexec</parameter>
- </link>.</para>
+ <para>See also <link linkend="PREEXEC"><parameter moreinfo="none">preexec</parameter></link>.</para>
- <para>Default: <emphasis>none (no command executed)</emphasis>
- </para>
+ <para>Default: <emphasis>none (no command executed)</emphasis></para>
- <para>Example: <command moreinfo="none">postexec = echo \&quot;%u disconnected from %S
- from %m (%I)\&quot; &gt;&gt; /tmp/log</command></para>
- </listitem>
- </samba:parameter>
+ <para>Example: <command moreinfo="none">postexec = echo \&quot;%u disconnected from %S from %m (%I)\&quot; &gt;&gt; /tmp/log</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/preexecclose.xml b/docs/docbook/smbdotconf/misc/preexecclose.xml
index c617a7f7fa..346d21dbd8 100644
--- a/docs/docbook/smbdotconf/misc/preexecclose.xml
+++ b/docs/docbook/smbdotconf/misc/preexecclose.xml
@@ -1,9 +1,12 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="PREEXECCLOSE"/>preexec close (S)</term>
- <listitem><para>This boolean option controls whether a non-zero
- return code from <link linkend="PREEXEC"><parameter moreinfo="none">preexec
- </parameter></link> should close the service being connected to.</para>
+<samba:parameter name="preexec close"
+ context="S"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This boolean option controls whether a non-zero
+ return code from <link linkend="PREEXEC"><parameter moreinfo="none">preexec
+ </parameter></link> should close the service being connected to.</para>
- <para>Default: <command moreinfo="none">preexec close = no</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">preexec close = no</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/rootpostexec.xml b/docs/docbook/smbdotconf/misc/rootpostexec.xml
index ed60646677..baed004327 100644
--- a/docs/docbook/smbdotconf/misc/rootpostexec.xml
+++ b/docs/docbook/smbdotconf/misc/rootpostexec.xml
@@ -1,14 +1,16 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="ROOTPOSTEXEC"/>root postexec (S)</term>
- <listitem><para>This is the same as the <parameter moreinfo="none">postexec</parameter>
- parameter except that the command is run as root. This
- is useful for unmounting filesystems
- (such as CDROMs) after a connection is closed.</para>
+<samba:parameter name="root postexec"
+ context="S"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This is the same as the <parameter moreinfo="none">postexec</parameter>
+ parameter except that the command is run as root. This
+ is useful for unmounting filesystems
+ (such as CDROMs) after a connection is closed.</para>
- <para>See also <link linkend="POSTEXEC"><parameter moreinfo="none">
- postexec</parameter></link>.</para>
+ <para>See also <link linkend="POSTEXEC"><parameter moreinfo="none">
+ postexec</parameter></link>.</para>
- <para>Default: <command moreinfo="none">root postexec = &lt;empty string&gt;
- </command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">root postexec = &lt;empty string&gt;</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/rootpreexec.xml b/docs/docbook/smbdotconf/misc/rootpreexec.xml
index 29802b6d63..4939d1ee48 100644
--- a/docs/docbook/smbdotconf/misc/rootpreexec.xml
+++ b/docs/docbook/smbdotconf/misc/rootpreexec.xml
@@ -1,15 +1,17 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="ROOTPREEXEC"/>root preexec (S)</term>
- <listitem><para>This is the same as the <parameter moreinfo="none">preexec</parameter>
- parameter except that the command is run as root. This
- is useful for mounting filesystems (such as CDROMs) when a
- connection is opened.</para>
+<samba:parameter name="root preexec"
+ context="S"
+ advanced="1" wizard="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This is the same as the <parameter moreinfo="none">preexec</parameter>
+ parameter except that the command is run as root. This
+ is useful for mounting filesystems (such as CDROMs) when a
+ connection is opened.</para>
- <para>See also <link linkend="PREEXEC"><parameter moreinfo="none">
- preexec</parameter></link> and <link linkend="PREEXECCLOSE">
- <parameter moreinfo="none">preexec close</parameter></link>.</para>
+ <para>See also <link linkend="PREEXEC"><parameter moreinfo="none">
+ preexec</parameter></link> and <link linkend="PREEXECCLOSE">
+ <parameter moreinfo="none">preexec close</parameter></link>.</para>
- <para>Default: <command moreinfo="none">root preexec = &lt;empty string&gt;
- </command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">root preexec = &lt;empty string&gt;</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/rootpreexecclose.xml b/docs/docbook/smbdotconf/misc/rootpreexecclose.xml
index d21b0dd7b5..b333cffe90 100644
--- a/docs/docbook/smbdotconf/misc/rootpreexecclose.xml
+++ b/docs/docbook/smbdotconf/misc/rootpreexecclose.xml
@@ -1,12 +1,15 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="ROOTPREEXECCLOSE"/>root preexec close (S)</term>
- <listitem><para>This is the same as the <parameter moreinfo="none">preexec close
- </parameter> parameter except that the command is run as root.</para>
+<samba:parameter name="root preexec close"
+ context="S"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This is the same as the <parameter moreinfo="none">preexec close
+ </parameter> parameter except that the command is run as root.</para>
- <para>See also <link linkend="PREEXEC"><parameter moreinfo="none">
- preexec</parameter></link> and <link linkend="PREEXECCLOSE">
- <parameter moreinfo="none">preexec close</parameter></link>.</para>
+ <para>See also <link linkend="PREEXEC"><parameter moreinfo="none">
+ preexec</parameter></link> and <link linkend="PREEXECCLOSE">
+ <parameter moreinfo="none">preexec close</parameter></link>.</para>
- <para>Default: <command moreinfo="none">root preexec close = no</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">root preexec close = no</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/setdirectory.xml b/docs/docbook/smbdotconf/misc/setdirectory.xml
index 860632cdaf..b4ff72d4d0 100644
--- a/docs/docbook/smbdotconf/misc/setdirectory.xml
+++ b/docs/docbook/smbdotconf/misc/setdirectory.xml
@@ -1,13 +1,15 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="SETDIRECTORY"/>set directory (S)</term>
- <listitem><para>If <command moreinfo="none">set directory = no</command>, then
- users of the service may not use the setdir command to change
- directory.</para>
+<samba:parameter name="set directory"
+ context="S"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>If <command moreinfo="none">set directory = no</command>, then
+ users of the service may not use the setdir command to change
+ directory.</para>
- <para>The <command moreinfo="none">setdir</command> command is only implemented
- in the Digital Pathworks client. See the Pathworks documentation
- for details.</para>
+ <para>The <command moreinfo="none">setdir</command> command is only implemented
+ in the Digital Pathworks client. See the Pathworks documentation
+ for details.</para>
- <para>Default: <command moreinfo="none">set directory = no</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">set directory = no</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/sourceenvironment.xml b/docs/docbook/smbdotconf/misc/sourceenvironment.xml
index 07a8abce4d..c6b4ce368f 100644
--- a/docs/docbook/smbdotconf/misc/sourceenvironment.xml
+++ b/docs/docbook/smbdotconf/misc/sourceenvironment.xml
@@ -1,23 +1,27 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="SOURCEENVIRONMENT"/>source environment (G)</term>
- <listitem><para>This parameter causes Samba to set environment
- variables as per the content of the file named.</para>
+<samba:parameter name="source environment"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter causes Samba to set environment
+ variables as per the content of the file named.</para>
- <para>If the value of this parameter starts with a &quot;|&quot; character
- then Samba will treat that value as a pipe command to open and
- will set the environment variables from the output of the pipe.</para>
+ <para>If the value of this parameter starts with a &quot;|&quot; character
+ then Samba will treat that value as a pipe command to open and
+ will set the environment variables from the output of the pipe.</para>
- <para>The contents of the file or the output of the pipe should
- be formatted as the output of the standard Unix <command moreinfo="none">env(1)
- </command> command. This is of the form :</para>
- <para>Example environment entry:</para>
- <para><command moreinfo="none">SAMBA_NETBIOS_NAME = myhostname</command></para>
+ <para>The contents of the file or the output of the pipe should
+ be formatted as the output of the standard Unix <command moreinfo="none">env(1)</command> command. This is of the form:</para>
- <para>Default: <emphasis>No default value</emphasis></para>
- <para>Examples: <command moreinfo="none">source environment = |/etc/smb.conf.sh
- </command></para>
+ <para>Example environment entry:</para>
- <para>Example: <command moreinfo="none">source environment =
- /usr/local/smb_env_vars</command></para>
- </listitem>
- </samba:parameter>
+ <para><command moreinfo="none">SAMBA_NETBIOS_NAME = myhostname</command></para>
+
+ <para>Default: <emphasis>No default value</emphasis></para>
+
+ <para>Examples: <command moreinfo="none">source environment = |/etc/smb.conf.sh</command></para>
+
+ <para>Example: <command moreinfo="none">source environment =
+ /usr/local/smb_env_vars</command></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/volume.xml b/docs/docbook/smbdotconf/misc/volume.xml
index f0a82c6f0c..0ab5edb522 100644
--- a/docs/docbook/smbdotconf/misc/volume.xml
+++ b/docs/docbook/smbdotconf/misc/volume.xml
@@ -1,9 +1,11 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="VOLUME"/>volume (S)</term>
- <listitem><para> This allows you to override the volume label
- returned for a share. Useful for CDROMs with installation programs
- that insist on a particular volume label.</para>
+<samba:parameter name="volume"
+ context="S"
+ xmlns:samba="http://samba.org/common">
+ <listitem>
+ <para> This allows you to override the volume label
+ returned for a share. Useful for CDROMs with installation programs
+ that insist on a particular volume label.</para>
- <para>Default: <emphasis>the name of the share</emphasis></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <emphasis>the name of the share</emphasis></para>
+</listitem>
+</samba:parameter>
diff --git a/docs/docbook/smbdotconf/misc/widelinks.xml b/docs/docbook/smbdotconf/misc/widelinks.xml
index b3474ce26c..ead3569fd9 100644
--- a/docs/docbook/smbdotconf/misc/widelinks.xml
+++ b/docs/docbook/smbdotconf/misc/widelinks.xml
@@ -1,15 +1,17 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
- <term><anchor id="WIDELINKS"/>wide links (S)</term>
- <listitem><para>This parameter controls whether or not links
- in the UNIX file system may be followed by the server. Links
- that point to areas within the directory tree exported by the
- server are always allowed; this parameter controls access only
- to areas that are outside the directory tree being exported.</para>
+<samba:parameter name="wide links"
+ context="S"
+ xmlns:samba="http://samba.org/common">
+ <listitem>
+ <para>This parameter controls whether or not links
+ in the UNIX file system may be followed by the server. Links
+ that point to areas within the directory tree exported by the
+ server are always allowed; this parameter controls access only
+ to areas that are outside the directory tree being exported.</para>
- <para>Note that setting this parameter can have a negative
- effect on your server performance due to the extra system calls
- that Samba has to do in order to perform the link checks.</para>
+ <para>Note that setting this parameter can have a negative
+ effect on your server performance due to the extra system calls
+ that Samba has to do in order to perform the link checks.</para>
- <para>Default: <command moreinfo="none">wide links = yes</command></para>
- </listitem>
- </samba:parameter>
+ <para>Default: <command moreinfo="none">wide links = yes</command></para>
+</listitem>
+</samba:parameter>