diff options
| author | Gerald W. Carter <jerry@samba.org> | 2008-04-22 10:09:40 -0500 |
|---|---|---|
| committer | Gerald W. Carter <jerry@samba.org> | 2008-04-23 08:47:48 -0500 |
| commit | 8f8a9f01909ba29e2b781310baeeaaddc3f15f0d (patch) | |
| tree | 90c6b720ad3a7bc815245c0ef28820424f89d658 /docs-xml/smbdotconf/misc | |
| parent | 197238246389c40edc60c6630d18d6913086e630 (diff) | |
| download | samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.gz samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.bz2 samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.zip | |
Moving docs tree to docs-xml to make room for generated docs in the release tarball.
(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)
Diffstat (limited to 'docs-xml/smbdotconf/misc')
58 files changed, 1491 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/addsharecommand.xml b/docs-xml/smbdotconf/misc/addsharecommand.xml new file mode 100644 index 0000000000..9eb50f3dc3 --- /dev/null +++ b/docs-xml/smbdotconf/misc/addsharecommand.xml @@ -0,0 +1,68 @@ +<samba:parameter name="add share command" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server + Manager. The <parameter moreinfo="none">add share command</parameter> is used to define an external program + or script which will add a new service definition to <filename moreinfo="none">smb.conf</filename>. In order + to successfully execute the <parameter moreinfo="none">add share command</parameter>, <command + moreinfo="none">smbd</command> requires that the administrator be connected using a root account (i.e. uid == 0). + </para> + + <para> + If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in + <parameter moreinfo="none">change share</parameter> parameter are executed as root. + </para> + + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">add share command</parameter> with five parameters. + </para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location of the global <filename + moreinfo="none">smb.conf</filename> file. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of the new share. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">pathName</parameter> - path to an **existing** + directory on disk. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">comment</parameter> - comment string to associate with the new + share. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">max + connections</parameter> + Number of maximum simultaneous connections to this + share. + </para> + </listitem> + </itemizedlist> + + <para> + This parameter is only used for add file shares. To add printer shares, see the <smbconfoption + name="addprinter command"/>. + </para> +</description> + +<related>change share command</related> +<related>delete share command</related> +<value type="default"></value> +<value type="example">/usr/local/bin/addshare</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/afsshare.xml b/docs-xml/smbdotconf/misc/afsshare.xml new file mode 100644 index 0000000000..67d42d491f --- /dev/null +++ b/docs-xml/smbdotconf/misc/afsshare.xml @@ -0,0 +1,16 @@ +<samba:parameter name="afs share" + context="S" + type="boolean" + advanced="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter controls whether special AFS features are enabled + for this share. If enabled, it assumes that the directory exported via + the <parameter>path</parameter> parameter is a local AFS import. The + special AFS features include the attempt to hand-craft an AFS token + if you enabled --with-fake-kaserver in configure. + </para> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/afsusernamemap.xml b/docs-xml/smbdotconf/misc/afsusernamemap.xml new file mode 100644 index 0000000000..8e68ffec74 --- /dev/null +++ b/docs-xml/smbdotconf/misc/afsusernamemap.xml @@ -0,0 +1,20 @@ +<samba:parameter name="afs username map" + context="G" + type="string" + advanced="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para>If you are using the fake kaserver AFS feature, you might + want to hand-craft the usernames you are creating tokens for. + For example this is necessary if you have users from several domain + in your AFS Protection Database. One possible scheme to code users + as DOMAIN+User as it is done by winbind with the + as a separator. + </para> + + <para>The mapped user name must contain the cell name to log into, + so without setting this parameter there will be no token.</para> +</description> + +<value type="default"/> +<value type="example">%u@afs.samba.org</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/available.xml b/docs-xml/smbdotconf/misc/available.xml new file mode 100644 index 0000000000..4535bad1ce --- /dev/null +++ b/docs-xml/smbdotconf/misc/available.xml @@ -0,0 +1,14 @@ +<samba:parameter name="available" + context="S" + basic="1" advanced="1" print="1" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter lets you "turn off" 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> + +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/changenotify.xml b/docs-xml/smbdotconf/misc/changenotify.xml new file mode 100644 index 0000000000..9ff6f02f6f --- /dev/null +++ b/docs-xml/smbdotconf/misc/changenotify.xml @@ -0,0 +1,14 @@ +<samba:parameter name="change notify" + context="S" + type="boolean" + advanced="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies whether Samba should reply + to a client's file change notify requests. + </para> + + <para>You should never need to change this parameter</para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/changesharecommand.xml b/docs-xml/smbdotconf/misc/changesharecommand.xml new file mode 100644 index 0000000000..5a42e22559 --- /dev/null +++ b/docs-xml/smbdotconf/misc/changesharecommand.xml @@ -0,0 +1,70 @@ +<samba:parameter name="change share command" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server +Manager. The <parameter moreinfo="none">change share command</parameter> is used to define an external +program or script which will modify an existing service definition in <filename +moreinfo="none">smb.conf</filename>. In order to successfully execute the <parameter moreinfo="none">change +share command</parameter>, <command moreinfo="none">smbd</command> requires that the administrator be +connected using a root account (i.e. uid == 0). + </para> + + <para> + If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in + <parameter moreinfo="none">change share</parameter> parameter are executed as root. + </para> + + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">change share command</parameter> with five parameters. + </para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location + of the global <filename moreinfo="none">smb.conf</filename> file. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of the new + share. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">pathName</parameter> - path to an **existing** + directory on disk. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">comment</parameter> - comment string to associate + with the new share. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">max + connections</parameter> + Number of maximum simultaneous connections to this + share. + </para> + </listitem> + </itemizedlist> + + <para> + This parameter is only used modify existing file shares definitions. To modify + printer shares, use the "Printers..." folder as seen when browsing the Samba host. + </para> +</description> + +<related>add share command</related> +<related>delete share command</related> +<value type="default"></value> +<value type="example">/usr/local/bin/addshare</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/configfile.xml b/docs-xml/smbdotconf/misc/configfile.xml new file mode 100644 index 0000000000..b1dc0d1b29 --- /dev/null +++ b/docs-xml/smbdotconf/misc/configfile.xml @@ -0,0 +1,24 @@ +<samba:parameter name="config file" + context="G" + type="string" + hide="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This allows you to override the config file + to use, instead of the default (usually <filename moreinfo="none">smb.conf</filename>). + There is a chicken and egg problem here as this option is set + in the config file!</para> + + <para>For this reason, if the name of the config file has changed + when the parameters are loaded then it will reload them from + the new config file.</para> + + <para>This option takes the usual substitutions, which can + be very useful.</para> + + <para>If the config file doesn't exist then it won't be loaded + (allowing you to special case the config files of just a few + clients).</para> +</description> +<value type="example">/usr/local/samba/lib/smb.conf.%m</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/copy.xml b/docs-xml/smbdotconf/misc/copy.xml new file mode 100644 index 0000000000..608071e6e8 --- /dev/null +++ b/docs-xml/smbdotconf/misc/copy.xml @@ -0,0 +1,16 @@ +<samba:parameter name="copy" context="S" hide="1" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc" type="string"> +<description> + <para>This parameter allows you to "clone" service + entries. The specified service is simply duplicated under the + current service's name. Any parameters specified in the current + section will override those in the section being copied.</para> + + <para>This feature lets you set up a 'template' service and + create similar services easily. Note that the service being + copied must occur earlier in the configuration file than the + service doing the copying.</para> +</description> + +<value type="default"></value> +<value type="example">otherservice</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/defaultservice.xml b/docs-xml/smbdotconf/misc/defaultservice.xml new file mode 100644 index 0000000000..ca986d460a --- /dev/null +++ b/docs-xml/smbdotconf/misc/defaultservice.xml @@ -0,0 +1,30 @@ +<samba:parameter name="default service" + context="G" + advanced="1" developer="1" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<synonym>default</synonym> +<description> + <para>This parameter specifies the name of a service + which will be connected to if the service actually requested cannot + be found. Note that the square brackets are <emphasis>NOT</emphasis> + given in the parameter value (see example below).</para> + + <para>There is no default value for this parameter. If this + parameter is not given, attempting to connect to a nonexistent + service results in an error.</para> + + <para> + Typically the default service would be a <smbconfoption name="guest ok"/>, <smbconfoption + name="read-only"/> service.</para> <para>Also note that the apparent service name will be changed to equal + that of the requested service, this is very useful as it allows you to use macros like <parameter + moreinfo="none">%S</parameter> to make a wildcard service. + </para> + + <para>Note also that any "_" characters in the name of the service + used in the default service will get mapped to a "/". This allows for + interesting things.</para> +</description> +<value type="default"></value> +<value type="example">pub</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/deletereadonly.xml b/docs-xml/smbdotconf/misc/deletereadonly.xml new file mode 100644 index 0000000000..de4f566a0a --- /dev/null +++ b/docs-xml/smbdotconf/misc/deletereadonly.xml @@ -0,0 +1,14 @@ +<samba:parameter name="delete readonly" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter allows readonly files to be deleted. + This is not normal DOS semantics, but is allowed by UNIX.</para> + + <para>This option may be useful for running applications such + as rcs, where UNIX file ownership prevents changing file + permissions, and DOS semantics prevent deletion of a read only file.</para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/deletesharecommand.xml b/docs-xml/smbdotconf/misc/deletesharecommand.xml new file mode 100644 index 0000000000..40eb6495db --- /dev/null +++ b/docs-xml/smbdotconf/misc/deletesharecommand.xml @@ -0,0 +1,50 @@ +<samba:parameter name="delete share command" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server + Manager. The <parameter moreinfo="none">delete share command</parameter> is used to define an external + program or script which will remove an existing service definition from + <filename moreinfo="none">smb.conf</filename>. In order to successfully execute the + <parameter moreinfo="none">delete share command</parameter>, <command moreinfo="none">smbd</command> + requires that the administrator be connected using a root account (i.e. uid == 0). + </para> + + <para> + If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in + <parameter moreinfo="none">change share</parameter> parameter are executed as root. + </para> + + <para> + When executed, <command moreinfo="none">smbd</command> will automatically invoke the + <parameter moreinfo="none">delete share command</parameter> with two parameters. + </para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">configFile</parameter> - the location + of the global <filename moreinfo="none">smb.conf</filename> file. + </para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">shareName</parameter> - the name of + the existing service. + </para> + </listitem> + </itemizedlist> + + <para> + This parameter is only used to remove file shares. To delete printer shares, + see the <smbconfoption name="deleteprinter command"/>. + </para> +</description> + +<related>add share command</related> +<related>delete share command</related> +<value type="default"></value> +<value type="example">/usr/local/bin/delshare</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dfreecachetime.xml b/docs-xml/smbdotconf/misc/dfreecachetime.xml new file mode 100644 index 0000000000..2a8805e948 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dfreecachetime.xml @@ -0,0 +1,27 @@ +<samba:parameter name="dfree cache time" + context="S" + type="integer" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + + <para> + The <parameter moreinfo="none">dfree cache time</parameter> should only be used on systems where a problem + occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may occur + with other operating systems. The symptom that was seen was an error of "Abort Retry Ignore" at the + end of each directory listing. + </para> + + <para> + This is a new parameter introduced in Samba version 3.0.21. It specifies in seconds the time that smbd will + cache the output of a disk free query. If set to zero (the default) no caching is done. This allows a heavily + loaded server to prevent rapid spawning of <smbconfoption name="dfree command"/> scripts increasing the load. + </para> + + <para> + By default this parameter is zero, meaning no caching will be done. + </para> + +</description> +<value type="example">dfree cache time = 60</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dfreecommand.xml b/docs-xml/smbdotconf/misc/dfreecommand.xml new file mode 100644 index 0000000000..de60c5e076 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dfreecommand.xml @@ -0,0 +1,60 @@ +<samba:parameter name="dfree command" + context="S" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + + <para> + The <parameter moreinfo="none">dfree command</parameter> setting should only be used on systems where a + problem occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may + occur with other operating systems. The symptom that was seen was an error of "Abort Retry Ignore" + at the end of each directory listing. + </para> + + <para> + This setting allows the replacement of the internal routines to calculate the total disk space and amount + available with an external routine. The example below gives a possible script that might fulfill this + function. + </para> + + <para> + In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the + parameter <smbconfoption name="dfree cache time"/> was added to allow the output of this script to be cached + for systems under heavy load. + </para> + + <para> + The external program will be passed a single parameter indicating a directory in the filesystem being queried. + This will typically consist of the string <filename moreinfo="none">./</filename>. The script should return + two integers in ASCII. The first should be the total disk space in blocks, and the second should be the number + of available blocks. An optional third return value can give the block size in bytes. The default blocksize is + 1024 bytes. + </para> + + <para> + Note: Your script should <emphasis>NOT</emphasis> be setuid or setgid and should be owned by (and writeable + only by) root! + </para> + + <para> + Where the script dfree (which must be made executable) could be: +<programlisting format="linespecific"> +#!/bin/sh +df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}' +</programlisting> + or perhaps (on Sys V based systems): +<programlisting format="linespecific"> +#!/bin/sh +/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' +</programlisting> + Note that you may have to replace the command names with full path names on some systems. + </para> + + <para> + By default internal routines for determining the disk capacity and remaining space will be used. + </para> + +</description> +<value type="example">/usr/local/samba/bin/dfree</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dmapisupport.xml b/docs-xml/smbdotconf/misc/dmapisupport.xml new file mode 100644 index 0000000000..fbd145d048 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dmapisupport.xml @@ -0,0 +1,29 @@ +<samba:parameter name="dmapi support" + context="S" + type="boolean" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies whether Samba should use DMAPI to + determine whether a file is offline or not. This would typically + be used in conjunction with a hierarchical storage system that + automatically migrates files to tape. + </para> + + <para>Note that Samba infers the status of a file by examining the + events that a DMAPI application has registered interest in. This + heuristic is satisfactory for a number of hierarchical storage + systems, but there may be system for which it will fail. In this + case, Samba may erroneously report files to be offline. + </para> + + <para>This parameter is only available if a supported DMAPI + implementation was found at compilation time. It will only be used + if DMAPI is found to enabled on the system at run time. + </para> + + <para> + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dontdescend.xml b/docs-xml/smbdotconf/misc/dontdescend.xml new file mode 100644 index 0000000000..e12593939d --- /dev/null +++ b/docs-xml/smbdotconf/misc/dontdescend.xml @@ -0,0 +1,20 @@ +<samba:parameter name="dont descend" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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 "dont descend" 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> +</description> + +<value type="default"></value> +<value type="example">/proc,/dev</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dosfilemode.xml b/docs-xml/smbdotconf/misc/dosfilemode.xml new file mode 100644 index 0000000000..ae3b475107 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dosfilemode.xml @@ -0,0 +1,17 @@ +<samba:parameter name="dos filemode" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> The default behavior in Samba is to provide + UNIX-like behavior where only the owner of a file/directory is + able to change the permissions on it. However, this behavior + is often confusing to DOS/Windows users. Enabling this parameter + allows a user who has write access to the file (by whatever + means) to modify the permissions (including ACL) on it. Note that a user + belonging to the group owning the file will not be allowed to + change permissions if the group is only granted read access. + Ownership of the file/directory may also be changed.</para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dosfiletimeresolution.xml b/docs-xml/smbdotconf/misc/dosfiletimeresolution.xml new file mode 100644 index 0000000000..130f0fd91e --- /dev/null +++ b/docs-xml/smbdotconf/misc/dosfiletimeresolution.xml @@ -0,0 +1,25 @@ +<samba:parameter name="dos filetime resolution" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>Under the DOS and Windows FAT filesystem, the finest + granularity on time resolution is two seconds. Setting this parameter + for a share causes Samba to round the reported time down to the + nearest two second boundary when a query call that requires one second + resolution is made to <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> + + <para>This option is mainly used as a compatibility option for Visual + C++ when used against Samba shares. If oplocks are enabled on a + share, Visual C++ uses two different time reading calls to check if a + file has changed since it was last read. One of these calls uses a + one-second granularity, the other uses a two second granularity. As + the two second call rounds any odd second down, then if the file has a + timestamp of an odd number of seconds then the two timestamps will not + match and Visual C++ will keep reporting the file has changed. Setting + this option causes the two timestamps to match, and Visual C++ is + happy.</para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dosfiletimes.xml b/docs-xml/smbdotconf/misc/dosfiletimes.xml new file mode 100644 index 0000000000..90f93a03e8 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dosfiletimes.xml @@ -0,0 +1,22 @@ +<samba:parameter name="dos filetimes" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>Under DOS and Windows, if a user can write to a + file they can change the timestamp on it. Under POSIX semantics, + only the owner of the file or root may change the timestamp. By + default, Samba runs with POSIX semantics and refuses to change the + timestamp on a file if the user <command moreinfo="none">smbd</command> is acting + on behalf of is not the file owner. Setting this option to <constant> + yes</constant> allows DOS semantics and <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will change the file + timestamp as DOS requires. Due to changes in Microsoft Office 2000 and beyond, + the default for this parameter has been changed from "no" to "yes" in Samba 3.0.14 + and above. Microsoft Excel will display dialog box warnings about the file being + changed by another user if this parameter is not set to "yes" and files are being + shared between users. + </para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/fakedirectorycreatetimes.xml b/docs-xml/smbdotconf/misc/fakedirectorycreatetimes.xml new file mode 100644 index 0000000000..974b6f0f30 --- /dev/null +++ b/docs-xml/smbdotconf/misc/fakedirectorycreatetimes.xml @@ -0,0 +1,34 @@ +<samba:parameter name="fake directory create times" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>NTFS and Windows VFAT file systems keep a create + time for all files and directories. This is not the same as the + ctime - status change time - that Unix keeps, so Samba by default + reports the earliest of the various times Unix does keep. Setting + this parameter for a share causes Samba to always report midnight + 1-1-1980 as the create time for directories.</para> + + <para>This option is mainly used as a compatibility option for + Visual C++ when used against Samba shares. Visual C++ generated + makefiles have the object directory as a dependency for each object + file, and a make rule to create the directory. Also, when NMAKE + compares timestamps it uses the creation time when examining a + directory. Thus the object directory will be created if it does not + exist, but once it does exist it will always have an earlier + timestamp than the object files it contains.</para> + + <para>However, Unix time semantics mean that the create time + reported by Samba will be updated whenever a file is created or + or deleted in the directory. NMAKE finds all object files in + the object directory. The timestamp of the last one built is then + compared to the timestamp of the object directory. If the + directory's timestamp if newer, then all object files + will be rebuilt. Enabling this option + ensures directories always predate their contents and an NMAKE build + will proceed as expected.</para> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/followsymlinks.xml b/docs-xml/smbdotconf/misc/followsymlinks.xml new file mode 100644 index 0000000000..c0fd920bf9 --- /dev/null +++ b/docs-xml/smbdotconf/misc/followsymlinks.xml @@ -0,0 +1,20 @@ +<samba:parameter name="follow symlinks" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/fstype.xml b/docs-xml/smbdotconf/misc/fstype.xml new file mode 100644 index 0000000000..c7df18c38b --- /dev/null +++ b/docs-xml/smbdotconf/misc/fstype.xml @@ -0,0 +1,16 @@ +<samba:parameter name="fstype" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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> +</description> +<value type="default">NTFS</value> +<value type="example">Samba</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/homedirmap.xml b/docs-xml/smbdotconf/misc/homedirmap.xml new file mode 100644 index 0000000000..37b46ee0b6 --- /dev/null +++ b/docs-xml/smbdotconf/misc/homedirmap.xml @@ -0,0 +1,28 @@ +<samba:parameter name="homedir map" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + If <smbconfoption name="nis homedir"/> is <constant>yes</constant>, and <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> is also acting as a Win95/98 <parameter moreinfo="none">logon server</parameter> + then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted. + At present, only the Sun auto.home map format is understood. The form of the map is: +<programlisting> +<command moreinfo="none">username server:/some/file/system</command> +</programlisting> + and the program will extract the servername from before the first ':'. There should probably be a better parsing system + that copes with different map formats and also Amd (another automounter) maps. + </para> + + <note><para> + A working NIS client is required on the system for this option to work. + </para></note> +</description> +<related>nis homedir</related> +<related>domain logons</related> + +<value type="default"></value> +<value type="example">amd.homedir</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/include.xml b/docs-xml/smbdotconf/misc/include.xml new file mode 100644 index 0000000000..1a08b49464 --- /dev/null +++ b/docs-xml/smbdotconf/misc/include.xml @@ -0,0 +1,25 @@ +<samba:parameter name="include" + context="G" + type="string" + hide="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This allows you to include one config file inside another. The file is included literally, as though typed + in place. + </para> + + <para> + It takes the standard substitutions, except <parameter moreinfo="none">%u</parameter>, + <parameter moreinfo="none">%P</parameter> and <parameter moreinfo="none">%S</parameter>. + </para> +</description> + + <para> + Note: This option can not be set inside registry + configurations. + </para> + +<value type="default"></value> +<value type="example">/usr/local/samba/lib/admin_smb.conf</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/kernelchangenotify.xml b/docs-xml/smbdotconf/misc/kernelchangenotify.xml new file mode 100644 index 0000000000..ef932201a1 --- /dev/null +++ b/docs-xml/smbdotconf/misc/kernelchangenotify.xml @@ -0,0 +1,17 @@ +<samba:parameter name="kernel change notify" + context="S" + type="boolean" + advanced="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies whether Samba should ask the + kernel for change notifications in directories so that + SMB clients can refresh whenever the data on the server changes. + </para> + + <para>This parameter is only used when your kernel supports + change notification to user programs using the inotify interface. + </para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/lockdirectory.xml b/docs-xml/smbdotconf/misc/lockdirectory.xml new file mode 100644 index 0000000000..cbe10d5b8d --- /dev/null +++ b/docs-xml/smbdotconf/misc/lockdirectory.xml @@ -0,0 +1,21 @@ +<samba:parameter name="lock directory" + context="G" + advanced="1" developer="1" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<synonym>lock dir</synonym> +<description> + <para>This option specifies the directory where lock + files will be placed. The lock files are used to implement the + <smbconfoption name="max connections"/> option. + </para> + + <para> + Note: This option can not be set inside registry + configurations. + </para> +</description> + +<value type="default">${prefix}/var/locks</value> +<value type="example">/var/run/samba/locks</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/magicoutput.xml b/docs-xml/smbdotconf/misc/magicoutput.xml new file mode 100644 index 0000000000..47e514fdce --- /dev/null +++ b/docs-xml/smbdotconf/misc/magicoutput.xml @@ -0,0 +1,18 @@ +<samba:parameter name="magic output" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter specifies the name of a file which will contain output created by a magic script (see the + <smbconfoption name="magic script"/> parameter below). + </para> + + <warning><para>If two clients use the same <parameter moreinfo="none">magic script + </parameter> in the same directory the output file content is undefined. + </para></warning> +</description> + +<value type="default"><magic script name>.out</value> +<value type="example">myfile.txt</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/magicscript.xml b/docs-xml/smbdotconf/misc/magicscript.xml new file mode 100644 index 0000000000..b621f00c38 --- /dev/null +++ b/docs-xml/smbdotconf/misc/magicscript.xml @@ -0,0 +1,30 @@ +<samba:parameter name="magic script" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies the name of a file which, + if opened, will be executed by the server when the file is closed. + This allows a UNIX script to be sent to the Samba host and + executed on behalf of the connected user.</para> + + <para>Scripts executed in this way will be deleted upon + completion assuming that the user has the appropriate level + of privilege and the file permissions allow the deletion.</para> + + <para>If the script generates output, output will be sent to + the file specified by the <smbconfoption name="magic output"/> + parameter (see above).</para> + + <para>Note that some shells are unable to interpret scripts + containing CR/LF instead of CR as + the end-of-line marker. Magic scripts must be executable + <emphasis>as is</emphasis> on the host, which for some hosts and + some shells will require filtering at the DOS end.</para> + + <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and + should <emphasis>NOT</emphasis> be relied upon.</para> +</description> +<value type="default"></value> +<value type="example">user.csh</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/messagecommand.xml b/docs-xml/smbdotconf/misc/messagecommand.xml new file mode 100644 index 0000000000..91df58ab5d --- /dev/null +++ b/docs-xml/smbdotconf/misc/messagecommand.xml @@ -0,0 +1,79 @@ +<samba:parameter name="message command" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This specifies what command to run when the + server receives a WinPopup style message.</para> + + <para>This would normally be a command that would + deliver the message somehow. How this is to be done is + up to your imagination.</para> + + <para>An example is: +<programlisting> +<command moreinfo="none">message command = csh -c 'xedit %s;rm %s' &</command> +</programlisting> + </para> + + <para>This delivers the message using <command moreinfo="none">xedit</command>, then + removes it afterwards. <emphasis>NOTE THAT IT IS VERY IMPORTANT + THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I + have the '&' on the end. If it doesn't return immediately then + your PCs may freeze when sending messages (they should recover + after 30 seconds, hopefully).</para> + + <para>All messages are delivered as the global guest user. + The command takes the standard substitutions, although <parameter moreinfo="none"> + %u</parameter> won't work (<parameter moreinfo="none">%U</parameter> may be better + in this case).</para> + + <para>Apart from the standard substitutions, some additional + ones apply. In particular:</para> + + <itemizedlist> + <listitem> + <para><parameter moreinfo="none">%s</parameter> = the filename containing + the message.</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">%t</parameter> = the destination that + the message was sent to (probably the server name).</para> + </listitem> + + <listitem> + <para><parameter moreinfo="none">%f</parameter> = who the message + is from.</para> + </listitem> + </itemizedlist> + + <para>You could make this command send mail, or whatever else + takes your fancy. Please let us know of any really interesting + ideas you have.</para> + + <para> + Here's a way of sending the messages as mail to root: +<programlisting> +<command moreinfo="none">message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s</command> +</programlisting> + </para> + + <para>If you don't have a message command then the message + won't be delivered and Samba will tell the sender there was + an error. Unfortunately WfWg totally ignores the error code + and carries on regardless, saying that the message was delivered. + </para> + + <para> + If you want to silently delete it then try: +<programlisting> +<command moreinfo="none">message command = rm %s</command> +</programlisting> + </para> + +</description> +<value type="default"></value> +<value type="example">csh -c 'xedit %s; rm %s' &</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/nishomedir.xml b/docs-xml/smbdotconf/misc/nishomedir.xml new file mode 100644 index 0000000000..45c451197e --- /dev/null +++ b/docs-xml/smbdotconf/misc/nishomedir.xml @@ -0,0 +1,33 @@ +<samba:parameter name="nis homedir" + context="G" + type="boolean" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>Get the home share server from a NIS map. For + UNIX systems that use an automounter, the user's home directory + will often be mounted on a workstation on demand from a remote + server. </para> + + <para>When the Samba logon server is not the actual home directory + server, but is mounting the home directories via NFS then two + network hops would be required to access the users home directory + if the logon server told the client to use itself as the SMB server + for home directories (one over SMB and one over NFS). This can + be very slow.</para> + + <para>This option allows Samba to return the home share as + being on a different server to the logon server and as + long as a Samba daemon is running on the home directory server, + it will be mounted on the Samba client directly from the directory + server. When Samba is returning the home share to the client, it + will consult the NIS map specified in + <smbconfoption name="homedir map"/> and return the server + listed there.</para> + + <para>Note that for this option to work there must be a working + NIS system and the Samba server with this option must also + be a logon server.</para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/panicaction.xml b/docs-xml/smbdotconf/misc/panicaction.xml new file mode 100644 index 0000000000..b8ffa70458 --- /dev/null +++ b/docs-xml/smbdotconf/misc/panicaction.xml @@ -0,0 +1,17 @@ +<samba:parameter name="panic action" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This is a Samba developer option that allows a + system command to be called when either <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> or <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> crashes. This is usually used to + draw attention to the fact that a problem occurred. + </para> +</description> + +<value type="default"></value> +<value type="example">"/bin/sleep 90000"</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/piddirectory.xml b/docs-xml/smbdotconf/misc/piddirectory.xml new file mode 100644 index 0000000000..c9f05338ac --- /dev/null +++ b/docs-xml/smbdotconf/misc/piddirectory.xml @@ -0,0 +1,14 @@ +<samba:parameter name="pid directory" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This option specifies the directory where pid files will be placed. + </para> +</description> + +<value type="default">${prefix}/var/locks</value> +<value type="example">pid directory = /var/run/</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/postexec.xml b/docs-xml/smbdotconf/misc/postexec.xml new file mode 100644 index 0000000000..3f0cb5073a --- /dev/null +++ b/docs-xml/smbdotconf/misc/postexec.xml @@ -0,0 +1,21 @@ +<samba:parameter name="postexec" + context="S" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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><command moreinfo="none">postexec = /etc/umount /cdrom</command></para> +</description> +<related>preexec</related> + +<value type="default"></value> +<value type="example">echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/preexec.xml b/docs-xml/smbdotconf/misc/preexec.xml new file mode 100644 index 0000000000..6608c83050 --- /dev/null +++ b/docs-xml/smbdotconf/misc/preexec.xml @@ -0,0 +1,29 @@ +<samba:parameter name="preexec" + context="S" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <synonym>exec</synonym> +<description> + <para>This option specifies a command to be run whenever + the service is connected to. It takes the usual substitutions.</para> + + <para>An interesting example is to send the users a welcome + message every time they log in. Maybe a message of the day? Here + is an example:</para> + + <para> + <command moreinfo="none">preexec = csh -c 'echo \"Welcome to %S!\" | + /usr/local/samba/bin/smbclient -M %m -I %I' & </command> + </para> + + <para>Of course, this could get annoying after a while :-)</para> + + <para> + See also <smbconfoption name="preexec close"/> and <smbconfoption name="postexec"/>. + </para> +</description> + +<value type="default"></value> +<value type="example">echo \"%u connected to %S from %m (%I)\" >> /tmp/log</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/preexecclose.xml b/docs-xml/smbdotconf/misc/preexecclose.xml new file mode 100644 index 0000000000..7a477e16fe --- /dev/null +++ b/docs-xml/smbdotconf/misc/preexecclose.xml @@ -0,0 +1,14 @@ +<samba:parameter name="preexec close" + context="S" + type="boolean" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This boolean option controls whether a non-zero return code from <smbconfoption name="preexec"/> + should close the service being connected to. + </para> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/preload.xml b/docs-xml/smbdotconf/misc/preload.xml new file mode 100644 index 0000000000..94905a67ef --- /dev/null +++ b/docs-xml/smbdotconf/misc/preload.xml @@ -0,0 +1,22 @@ +<samba:parameter name="preload" + context="G" + advanced="1" developer="1" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<synonym>auto services</synonym> +<description> + <para>This is a list of services that you want to be + automatically added to the browse lists. This is most useful + for homes and printers services that would otherwise not be + visible.</para> + + <para> + Note that if you just want all printers in your + printcap file loaded then the <smbconfoption name="load printers"/> + option is easier. + </para> +</description> + +<value type="default"></value> +<value type="example">fred lp colorlp</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/registryshares.xml b/docs-xml/smbdotconf/misc/registryshares.xml new file mode 100644 index 0000000000..76c83e194c --- /dev/null +++ b/docs-xml/smbdotconf/misc/registryshares.xml @@ -0,0 +1,24 @@ +<samba:parameter name="registry shares" + context="G" + type="bool" + advanced="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This turns on or off support for share definitions read from + registry. Shares defined in <emphasis>smb.conf</emphasis> take + precedence over shares with the same name defined in + registry. See the section on registry-based configuration + for details. + </para> + + <para> + Note that this parameter defaults to <emphasis>no</emphasis>, + but it is set to <emphasis>yes</emphasis> when + <parameter>config backend</parameter> is set + to <emphasis>registry</emphasis>. + </para> +</description> +<value type="default">no</value> +<value type="example">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/remoteannounce.xml b/docs-xml/smbdotconf/misc/remoteannounce.xml new file mode 100644 index 0000000000..f23968b501 --- /dev/null +++ b/docs-xml/smbdotconf/misc/remoteannounce.xml @@ -0,0 +1,42 @@ +<samba:parameter name="remote announce" + context="G" + advanced="1" developer="1" + type="list" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This option allows you to setup <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>to periodically announce itself + to arbitrary IP addresses with an arbitrary workgroup name. + </para> + + <para> + This is useful if you want your Samba server to appear in a remote workgroup for + which the normal browse propagation rules don't work. The remote workgroup can be + anywhere that you can send IP packets to. + </para> + + <para> + For example: +<programlisting> +<command moreinfo="none">remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF</command> +</programlisting> + the above line would cause <command moreinfo="none">nmbd</command> to announce itself + to the two given IP addresses using the given workgroup names. If you leave out the + workgroup name then the one given in the <smbconfoption name="workgroup"/> parameter + is used instead. + </para> + + <para> + The IP addresses you choose would normally be the broadcast addresses of the remote + networks, but can also be the IP addresses of known browse masters if your network + config is that stable. + </para> + + <para> + See the chapter on Network Browsing in the Samba-HOWTO book. + </para> +</description> + +<value type="default"></value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/remotebrowsesync.xml b/docs-xml/smbdotconf/misc/remotebrowsesync.xml new file mode 100644 index 0000000000..c966c95be0 --- /dev/null +++ b/docs-xml/smbdotconf/misc/remotebrowsesync.xml @@ -0,0 +1,50 @@ +<samba:parameter name="remote browse sync" + context="G" + advanced="1" developer="1" + type="list" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This option allows you to setup <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to periodically request + synchronization of browse lists with the master browser of a Samba + server that is on a remote segment. This option will allow you to + gain browse lists for multiple workgroups across routed networks. This + is done in a manner that does not work with any non-Samba servers. + </para> + + <para> + This is useful if you want your Samba server and all local + clients to appear in a remote workgroup for which the normal browse + propagation rules don't work. The remote workgroup can be anywhere + that you can send IP packets to. + </para> + + <para> + For example: +<programlisting> +<parameter>remote browse sync = 192.168.2.255 192.168.4.255</parameter> +</programlisting> + the above line would cause <command>nmbd</command> to request the master browser on the + specified subnets or addresses to synchronize their browse lists with + the local server. + </para> + + <para> + The IP addresses you choose would normally be the broadcast + addresses of the remote networks, but can also be the IP addresses + of known browse masters if your network config is that stable. If + a machine IP address is given Samba makes NO attempt to validate + that the remote machine is available, is listening, nor that it + is in fact the browse master on its segment. + </para> + + <para> + The <smbconfoption name="remote browse sync"/> may be used on networks + where there is no WINS server, and may be used on disjoint networks where + each network has its own WINS server. + </para> +</description> + +<value type="default"></value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/resetonzerovc.xml b/docs-xml/smbdotconf/misc/resetonzerovc.xml new file mode 100644 index 0000000000..3276cf5143 --- /dev/null +++ b/docs-xml/smbdotconf/misc/resetonzerovc.xml @@ -0,0 +1,28 @@ +<samba:parameter name="reset on zero vc" + context="G" + type="boolean" + advanced="1" developer="0" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This boolean option controls whether an incoming session setup + should kill other connections coming from the same IP. This matches + the default Windows 2003 behaviour. + + Setting this parameter to yes becomes necessary when you have a flaky + network and windows decides to reconnect while the old connection + still has files with share modes open. These files become inaccessible + over the new connection. + + The client sends a zero VC on the new connection, and Windows 2003 + kills all other connections coming from the same IP. This way the + locked files are accessible again. + + Please be aware that enabling this option will kill connections behind + a masquerading router. + + </para> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/rootpostexec.xml b/docs-xml/smbdotconf/misc/rootpostexec.xml new file mode 100644 index 0000000000..4aff4f0334 --- /dev/null +++ b/docs-xml/smbdotconf/misc/rootpostexec.xml @@ -0,0 +1,16 @@ +<samba:parameter name="root postexec" + context="S" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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> +</description> + +<related>postexec</related> +<value type="default"></value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/rootpreexec.xml b/docs-xml/smbdotconf/misc/rootpreexec.xml new file mode 100644 index 0000000000..89d10ec53b --- /dev/null +++ b/docs-xml/smbdotconf/misc/rootpreexec.xml @@ -0,0 +1,18 @@ +<samba:parameter name="root preexec" + context="S" + type="string" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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> +</description> + +<related>preexec</related> +<related>preexec close</related> + +<value type="default"></value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/rootpreexecclose.xml b/docs-xml/smbdotconf/misc/rootpreexecclose.xml new file mode 100644 index 0000000000..e0f11b567a --- /dev/null +++ b/docs-xml/smbdotconf/misc/rootpreexecclose.xml @@ -0,0 +1,15 @@ +<samba:parameter name="root preexec close" + context="S" + type="boolean" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This is the same as the <parameter moreinfo="none">preexec close + </parameter> parameter except that the command is run as root.</para> +</description> + +<related>preexec</related> +<related>preexec close</related> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/setdirectory.xml b/docs-xml/smbdotconf/misc/setdirectory.xml new file mode 100644 index 0000000000..5e7b379a04 --- /dev/null +++ b/docs-xml/smbdotconf/misc/setdirectory.xml @@ -0,0 +1,19 @@ +<samba:parameter name="set directory" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/socketaddress.xml b/docs-xml/smbdotconf/misc/socketaddress.xml new file mode 100644 index 0000000000..7566380e70 --- /dev/null +++ b/docs-xml/smbdotconf/misc/socketaddress.xml @@ -0,0 +1,18 @@ +<samba:parameter name="socket address" + context="G" + type="string" + developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This option allows you to control what + address Samba will listen for connections on. This is used to + support multiple virtual interfaces on the one server, each + with a different configuration.</para> + + <para>By default Samba will accept connections on any + address.</para> +</description> + +<value type="default"></value> +<value type="example">192.168.2.20</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/timeoffset.xml b/docs-xml/smbdotconf/misc/timeoffset.xml new file mode 100644 index 0000000000..1afc514e60 --- /dev/null +++ b/docs-xml/smbdotconf/misc/timeoffset.xml @@ -0,0 +1,15 @@ +<samba:parameter name="time offset" + context="G" + type="integer" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter is a setting in minutes to add + to the normal GMT to local time conversion. This is useful if + you are serving a lot of PCs that have incorrect daylight + saving time handling.</para> +</description> + +<value type="default">0</value> +<value type="example">60</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usershareallowguests.xml b/docs-xml/smbdotconf/misc/usershareallowguests.xml new file mode 100644 index 0000000000..738f3a11ba --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareallowguests.xml @@ -0,0 +1,16 @@ +<samba:parameter name="usershare allow guests" + context="G" + basic="1" advanced="1" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter controls whether user defined shares are allowed + to be accessed by non-authenticated users or not. It is the equivalent + of allowing people who can create a share the option of setting + <parameter moreinfo="none">guest ok = yes</parameter> in a share + definition. Due to the security sensitive nature of this the default + is set to off.</para> + +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usersharemaxshares.xml b/docs-xml/smbdotconf/misc/usersharemaxshares.xml new file mode 100644 index 0000000000..ed76283e61 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usersharemaxshares.xml @@ -0,0 +1,14 @@ +<samba:parameter name="usershare max shares" + context="G" + basic="1" advanced="1" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies the number of user defined shares + that are allowed to be created by users belonging to the group owning the + usershare directory. If set to zero (the default) user defined shares are ignored. + </para> + +</description> +<value type="default">0</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usershareowneronly.xml b/docs-xml/smbdotconf/misc/usershareowneronly.xml new file mode 100644 index 0000000000..4aab43a0da --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareowneronly.xml @@ -0,0 +1,19 @@ +<samba:parameter name="usershare owner only" + context="G" + basic="1" advanced="1" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter controls whether the pathname exported by + a user defined shares must be owned by the user creating the + user defined share or not. If set to True (the default) then + smbd checks that the directory path being shared is owned by + the user who owns the usershare file defining this share and + refuses to create the share if not. If set to False then no + such check is performed and any directory path may be exported + regardless of who owns it. + </para> + +</description> +<value type="default">True</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usersharepath.xml b/docs-xml/smbdotconf/misc/usersharepath.xml new file mode 100644 index 0000000000..9e0bfe57d5 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usersharepath.xml @@ -0,0 +1,33 @@ +<samba:parameter name="usershare path" + context="G" + basic="1" advanced="1" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies the absolute path of the directory on the + filesystem used to store the user defined share definition files. + This directory must be owned by root, and have no access for + other, and be writable only by the group owner. In addition the + "sticky" bit must also be set, restricting rename and delete to + owners of a file (in the same way the /tmp directory is usually configured). + Members of the group owner of this directory are the users allowed to create + usershares. If this parameter is undefined then no user defined + shares are allowed. + </para> + <para> + For example, a valid usershare directory might be /usr/local/samba/lib/usershares, + set up as follows. + </para> + <para> + <programlisting> + ls -ld /usr/local/samba/lib/usershares/ + drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/ + </programlisting> + </para> + <para> + In this case, only members of the group "power_users" can create user defined shares. + </para> + +</description> +<value type="default">NULL</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usershareprefixallowlist.xml b/docs-xml/smbdotconf/misc/usershareprefixallowlist.xml new file mode 100644 index 0000000000..bacc2e9530 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareprefixallowlist.xml @@ -0,0 +1,24 @@ +<samba:parameter name="usershare prefix allow list" + context="G" + basic="1" advanced="1" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies a list of absolute pathnames + the root of which are allowed to be exported by user defined share definitions. + If the pathname exported doesn't start with one of the strings in this + list the user defined share will not be allowed. This allows the Samba + administrator to restrict the directories on the system that can be + exported by user defined shares. + </para> + <para> + If there is a "usershare prefix deny list" and also a + "usershare prefix allow list" the deny list is processed + first, followed by the allow list, thus leading to the most + restrictive interpretation. + </para> + +</description> +<value type="default">NULL</value> +<value type="example">/home /data /space</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usershareprefixdenylist.xml b/docs-xml/smbdotconf/misc/usershareprefixdenylist.xml new file mode 100644 index 0000000000..75d4ba9afc --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareprefixdenylist.xml @@ -0,0 +1,25 @@ +<samba:parameter name="usershare prefix deny list" + context="G" + basic="1" advanced="1" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies a list of absolute pathnames + the root of which are NOT allowed to be exported by user defined share definitions. + If the pathname exported starts with one of the strings in this + list the user defined share will not be allowed. Any pathname not + starting with one of these strings will be allowed to be exported + as a usershare. This allows the Samba administrator to restrict the + directories on the system that can be exported by user defined shares. + </para> + <para> + If there is a "usershare prefix deny list" and also a + "usershare prefix allow list" the deny list is processed + first, followed by the allow list, thus leading to the most + restrictive interpretation. + </para> + +</description> +<value type="default">NULL</value> +<value type="example">/etc /dev /private</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usersharetemplateshare.xml b/docs-xml/smbdotconf/misc/usersharetemplateshare.xml new file mode 100644 index 0000000000..efe2e81d22 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usersharetemplateshare.xml @@ -0,0 +1,24 @@ +<samba:parameter name="usershare template share" + context="G" + basic="1" advanced="1" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>User defined shares only have limited possible parameters + such as path, guest ok etc. This parameter allows usershares to + "cloned" from an existing share. If "usershare template share" + is set to the name of an existing share, then all usershares + created have their defaults set from the parameters set on this + share. + </para> + <para> + The target share may be set to be invalid for real file + sharing by setting the parameter "-valid = False" on the template + share definition. This causes it not to be seen as a real exported + share but to be able to be used as a template for usershares. + </para> + +</description> +<value type="default">NULL</value> +<value type="example">template_share</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/utmp.xml b/docs-xml/smbdotconf/misc/utmp.xml new file mode 100644 index 0000000000..67c02cc64c --- /dev/null +++ b/docs-xml/smbdotconf/misc/utmp.xml @@ -0,0 +1,25 @@ +<samba:parameter name="utmp" + context="G" + type="boolean" + developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This boolean parameter is only available if Samba has been configured and compiled + with the option <command moreinfo="none">--with-utmp</command>. If set to + <constant>yes</constant> then Samba will attempt to add utmp or utmpx records + (depending on the UNIX system) whenever a connection is made to a Samba server. + Sites may use this to record the user connecting to a Samba share. + </para> + + <para> + Due to the requirements of the utmp record, we are required to create a unique + identifier for the incoming user. Enabling this option creates an n^2 algorithm + to find this number. This may impede performance on large installations. + </para> +</description> + +<related>utmp directory</related> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/utmpdirectory.xml b/docs-xml/smbdotconf/misc/utmpdirectory.xml new file mode 100644 index 0000000000..b02fc93bf0 --- /dev/null +++ b/docs-xml/smbdotconf/misc/utmpdirectory.xml @@ -0,0 +1,21 @@ +<samba:parameter name="utmp directory" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter is only available if Samba has + been configured and compiled with the option <command moreinfo="none"> + --with-utmp</command>. It specifies a directory pathname that is + used to store the utmp or utmpx files (depending on the UNIX system) that + record user connections to a Samba server. By default this is + not set, meaning the system will use whatever utmp file the + native system is set to use (usually + <filename moreinfo="none">/var/run/utmp</filename> on Linux).</para> +</description> + +<related>utmp</related> + +<value type="default"><comment>Determined automatically</comment></value> +<value type="example">/var/run/utmp</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/valid.xml b/docs-xml/smbdotconf/misc/valid.xml new file mode 100644 index 0000000000..2f92f6367c --- /dev/null +++ b/docs-xml/smbdotconf/misc/valid.xml @@ -0,0 +1,18 @@ +<samba:parameter name="-valid" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> This parameter indicates whether a share is + valid and thus can be used. When this parameter is set to false, + the share will be in no way visible nor accessible. + </para> + + <para> + This option should not be + used by regular users but might be of help to developers. + Samba uses this option internally to mark shares as deleted. + </para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/volume.xml b/docs-xml/smbdotconf/misc/volume.xml new file mode 100644 index 0000000000..d3385e704c --- /dev/null +++ b/docs-xml/smbdotconf/misc/volume.xml @@ -0,0 +1,12 @@ +<samba:parameter name="volume" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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> +</description> + +<value type="default"><comment>the name of the share</comment></value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/widelinks.xml b/docs-xml/smbdotconf/misc/widelinks.xml new file mode 100644 index 0000000000..fb707c1950 --- /dev/null +++ b/docs-xml/smbdotconf/misc/widelinks.xml @@ -0,0 +1,18 @@ +<samba:parameter name="wide links" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <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> +</description> + +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/wtmpdirectory.xml b/docs-xml/smbdotconf/misc/wtmpdirectory.xml new file mode 100644 index 0000000000..f58b522573 --- /dev/null +++ b/docs-xml/smbdotconf/misc/wtmpdirectory.xml @@ -0,0 +1,23 @@ +<samba:parameter name="wtmp directory" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter is only available if Samba has been configured and compiled with the option <command moreinfo="none"> + --with-utmp</command>. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on + the UNIX system) that record user connections to a Samba server. The difference with the utmp directory is the fact + that user info is kept after a user has logged out. + </para> + + <para> + By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually + <filename moreinfo="none">/var/run/wtmp</filename> on Linux). + </para> +</description> + +<related>utmp</related> +<value type="default"/> +<value type="example">/var/log/wtmp</value> +</samba:parameter> |