diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 17:47:29 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 17:47:29 +0000 |
| commit | 4f5791ebd03eaec1c7da0865a383175b05102712 (patch) | |
| tree | 8ce7b00f7a76baa386372422adebbe64510812d4 /docs-xml/smbdotconf/misc | |
| parent | Initial commit. (diff) | |
| download | samba-upstream.tar.xz samba-upstream.zip | |
Adding upstream version 2:4.17.12+dfsg.upstream/2%4.17.12+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs-xml/smbdotconf/misc')
93 files changed, 2180 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/addsharecommand.xml b/docs-xml/smbdotconf/misc/addsharecommand.xml new file mode 100644 index 0000000..484b591 --- /dev/null +++ b/docs-xml/smbdotconf/misc/addsharecommand.xml @@ -0,0 +1,72 @@ +<samba:parameter name="add share command" + context="G" + type="string" + substitution="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>. + </para> + + <para> + In order to successfully execute the + <parameter moreinfo="none">add share command</parameter>, + <command moreinfo="none">smbd</command> requires that the administrator + connects using a root account (i.e. uid == 0) or has the + <literal>SeDiskOperatorPrivilege</literal>. + Scripts defined in the <parameter moreinfo="none">add share command</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 to 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 0000000..fe97b58 --- /dev/null +++ b/docs-xml/smbdotconf/misc/afsshare.xml @@ -0,0 +1,15 @@ +<samba:parameter name="afs share" + context="S" + type="boolean" + 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/afstokenlifetime.xml b/docs-xml/smbdotconf/misc/afstokenlifetime.xml new file mode 100644 index 0000000..9d6e13a --- /dev/null +++ b/docs-xml/smbdotconf/misc/afstokenlifetime.xml @@ -0,0 +1,14 @@ +<samba:parameter name="afs token lifetime" + context="G" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter controls the lifetime of tokens that the AFS + fake-kaserver claims. In reality these never expire but this lifetime + controls when the afs client will forget the token. </para> + + <para>Set this parameter to 0 to get <constant>NEVERDATE</constant>.</para> +</description> + +<value type="default">604800</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/afsusernamemap.xml b/docs-xml/smbdotconf/misc/afsusernamemap.xml new file mode 100644 index 0000000..f3f7390 --- /dev/null +++ b/docs-xml/smbdotconf/misc/afsusernamemap.xml @@ -0,0 +1,19 @@ +<samba:parameter name="afs username map" + context="G" + type="string" + 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/allowinsecurewidelinks.xml b/docs-xml/smbdotconf/misc/allowinsecurewidelinks.xml new file mode 100644 index 0000000..29c25fc --- /dev/null +++ b/docs-xml/smbdotconf/misc/allowinsecurewidelinks.xml @@ -0,0 +1,37 @@ +<samba:parameter name="allow insecure wide links" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + In normal operation the option <smbconfoption name="wide links"/> + which allows the server to follow symlinks outside of a share path + is automatically disabled when <smbconfoption name="unix extensions"/> + are enabled on a Samba server. This is done for security purposes + to prevent UNIX clients creating symlinks to areas of the server + file system that the administrator does not wish to export. + </para> + <para> + Setting <smbconfoption name="allow insecure wide links"/> to + true disables the link between these two parameters, removing + this protection and allowing a site to configure + the server to follow symlinks (by setting <smbconfoption name="wide links"/> + to "true") even when <smbconfoption name="unix extensions"/> + is turned on. + </para> + <para> + It is not recommended to enable this option unless you + fully understand the implications of allowing the server to + follow symbolic links created by UNIX clients. For most + normal Samba configurations this would be considered a security + hole and setting this parameter is not recommended. + </para> + <para> + This option was added at the request of sites who had + deliberately set Samba up in this way and needed to continue + supporting this functionality without having to patch the + Samba code. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/allowunsafeclusterupgrade.xml b/docs-xml/smbdotconf/misc/allowunsafeclusterupgrade.xml new file mode 100644 index 0000000..02398ff --- /dev/null +++ b/docs-xml/smbdotconf/misc/allowunsafeclusterupgrade.xml @@ -0,0 +1,16 @@ +<samba:parameter name="allow unsafe cluster upgrade" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>If set to no (the default), smbd checks at startup if + other smbd versions are running in the cluster and refuses to + start if so. This is done to protect data corruption in + internal data structures due to incompatible Samba versions + running concurrently in the same cluster. Setting this + parameter to <value type="example">yes</value> disables this + safety check. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/asyncsmbechohandler.xml b/docs-xml/smbdotconf/misc/asyncsmbechohandler.xml new file mode 100644 index 0000000..26a4346 --- /dev/null +++ b/docs-xml/smbdotconf/misc/asyncsmbechohandler.xml @@ -0,0 +1,15 @@ +<samba:parameter name="async smb echo handler" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies whether Samba should fork the + async smb echo handler. It can be beneficial if your file + system can block syscalls for a very long time. In some + circumstances, it prolongs the timeout that Windows uses to + determine whether a connection is dead. This parameter is only for + SMB1. For SMB2 and above TCP keepalives can be used instead. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/auto_services.xml b/docs-xml/smbdotconf/misc/auto_services.xml new file mode 100644 index 0000000..d843d88 --- /dev/null +++ b/docs-xml/smbdotconf/misc/auto_services.xml @@ -0,0 +1,22 @@ +<samba:parameter name="auto services" + context="G" + type="string" + substitution="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<synonym>preload</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/available.xml b/docs-xml/smbdotconf/misc/available.xml new file mode 100644 index 0000000..6e3b70c --- /dev/null +++ b/docs-xml/smbdotconf/misc/available.xml @@ -0,0 +1,14 @@ +<samba:parameter name="available" + context="S" + type="boolean" + generated_function="0" + 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/cachedirectory.xml b/docs-xml/smbdotconf/misc/cachedirectory.xml new file mode 100644 index 0000000..480f31b --- /dev/null +++ b/docs-xml/smbdotconf/misc/cachedirectory.xml @@ -0,0 +1,24 @@ +<samba:parameter name="cache directory" + context="G" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>Usually, most of the TDB files are stored in the <parameter + moreinfo="none">lock directory</parameter>. Since Samba 3.4.0, it is + possible to differentiate between TDB files with persistent data and + TDB files with non-persistent data using the + <parameter moreinfo="none">state directory</parameter> and the + <parameter moreinfo="none">cache directory</parameter> options. + </para> + + <para>This option specifies the directory for storing TDB + files containing non-persistent data that will be kept across + service restarts. The directory should be placed on persistent + storage, but the data can be safely deleted by an + administrator. + </para> +</description> + +<value type="default">&pathconfig.CACHEDIR;</value> +<value type="example">/var/run/samba/locks/cache</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/changenotify.xml b/docs-xml/smbdotconf/misc/changenotify.xml new file mode 100644 index 0000000..9ded7ec --- /dev/null +++ b/docs-xml/smbdotconf/misc/changenotify.xml @@ -0,0 +1,13 @@ +<samba:parameter name="change notify" + context="G" + type="boolean" + 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 0000000..4cc7451 --- /dev/null +++ b/docs-xml/smbdotconf/misc/changesharecommand.xml @@ -0,0 +1,80 @@ +<samba:parameter name="change share command" + context="G" + type="string" + substitution="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>. + </para> + + <para> + In order to successfully execute the + <parameter moreinfo="none">change share command</parameter>, + <command moreinfo="none">smbd</command> requires that the administrator + connects using a root account (i.e. uid == 0) or has the + <literal>SeDiskOperatorPrivilege</literal>. + Scripts defined in the <parameter moreinfo="none">change share command</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 six 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> + + <listitem> + <para><parameter moreinfo="none">CSC policy</parameter> - client side caching + policy in string form. Valid values are: manual, documents, programs, disable. + </para> + </listitem> + </itemizedlist> + + <para> + This parameter is only used to modify existing file share 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/changeshare</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/clusteraddresses.xml b/docs-xml/smbdotconf/misc/clusteraddresses.xml new file mode 100644 index 0000000..66878cd --- /dev/null +++ b/docs-xml/smbdotconf/misc/clusteraddresses.xml @@ -0,0 +1,16 @@ +<samba:parameter name="cluster addresses" + context="G" + type="cmdlist" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>With this parameter you can add additional addresses that + nmbd will register with a WINS server. Similarly, these + addresses will be registered by default when + <emphasis>net ads dns register</emphasis> is called with + <smbconfoption name="clustering">yes</smbconfoption> + configured.</para> +</description> + +<value type="default"></value> +<value type="example">10.0.0.1 10.0.0.2 10.0.0.3</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/clustering.xml b/docs-xml/smbdotconf/misc/clustering.xml new file mode 100644 index 0000000..cf426ec --- /dev/null +++ b/docs-xml/smbdotconf/misc/clustering.xml @@ -0,0 +1,16 @@ +<samba:parameter name="clustering" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies whether Samba should contact + ctdb for accessing its tdb files and use ctdb as a backend + for its messaging backend. + </para> + + <para>Set this parameter to <value type="example">yes</value> only if + you have a cluster setup with ctdb running. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/configfile.xml b/docs-xml/smbdotconf/misc/configfile.xml new file mode 100644 index 0000000..3b67fb0 --- /dev/null +++ b/docs-xml/smbdotconf/misc/configfile.xml @@ -0,0 +1,25 @@ +<samba:parameter name="config file" + context="G" + type="string" + function="next_configfile" + substitution="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 0000000..53e899e --- /dev/null +++ b/docs-xml/smbdotconf/misc/copy.xml @@ -0,0 +1,21 @@ +<samba:parameter name="copy" + type="string" + context="S" + generated_function="0" + handler="handle_copy" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<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/ctdbdsocket.xml b/docs-xml/smbdotconf/misc/ctdbdsocket.xml new file mode 100644 index 0000000..2bc118b --- /dev/null +++ b/docs-xml/smbdotconf/misc/ctdbdsocket.xml @@ -0,0 +1,15 @@ +<samba:parameter name="ctdbd socket" + context="G" + type="string" + function="_ctdbd_socket" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>If you set <value type="example">clustering=yes</value>, + you need to tell Samba where ctdbd listens on its unix domain + socket. The default path as of ctdb 1.0 is /tmp/ctdb.socket which + you have to explicitly set for Samba in smb.conf. + </para> +</description> +<value type="default"></value> +<value type="example">/tmp/ctdb.socket</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml b/docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml new file mode 100644 index 0000000..f9da01f --- /dev/null +++ b/docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml @@ -0,0 +1,27 @@ +<samba:parameter name="ctdb locktime warn threshold" + context="G" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + + <para> + In a cluster environment using Samba and ctdb it is critical + that locks on central ctdb-hosted databases like locking.tdb + are not held for long. With the current Samba architecture + it happens that Samba takes a lock and while holding that + lock makes file system calls into the shared cluster file + system. This option makes Samba warn if it detects that it + has held locks for the specified number of milliseconds. If + this happens, <emphasis>smbd</emphasis> will emit a debug level 0 + message into its logs and potentially into syslog. The most likely + reason for such a log message is that an operation of the cluster + file system Samba exports is taking longer than expected. + The messages are meant as a debugging aid for potential + cluster problems. + </para> + + <para>The default value of 0 disables this logging.</para> + +</description> +<value type="default">0</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/ctdbtimeout.xml b/docs-xml/smbdotconf/misc/ctdbtimeout.xml new file mode 100644 index 0000000..b02b2c8 --- /dev/null +++ b/docs-xml/smbdotconf/misc/ctdbtimeout.xml @@ -0,0 +1,36 @@ +<samba:parameter name="ctdb timeout" + context="G" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies a timeout in milliseconds for the + connection between Samba and ctdb. It is only valid if you + have compiled Samba with clustering and if you have + set <parameter>clustering=yes</parameter>. + </para> + <para>When something in the cluster blocks, it can happen that + we wait indefinitely long for ctdb, just adding to the + blocking condition. In a well-running cluster this should + never happen, but there are too many components in a cluster + that might have hickups. Choosing the right balance for this + value is very tricky, because on a busy cluster long service + times to transfer something across the cluster might be + valid. Setting it too short will degrade the service your + cluster presents, setting it too long might make the cluster + itself not recover from something severely broken for too + long. + </para> + <para> + Be aware that if you set this parameter, this needs to be in + the file smb.conf, it is not really helpful to put this into + a registry configuration (typical on a cluster), because to + access the registry contact to ctdb is required. + </para> + <para>Setting <parameter>ctdb timeout</parameter> to n makes + any process waiting longer than n milliseconds for a reply by the + cluster panic. Setting it to 0 (the default) makes Samba + block forever, which is the highly recommended default. + </para> +</description> +<value type="default">0</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/defaultservice.xml b/docs-xml/smbdotconf/misc/defaultservice.xml new file mode 100644 index 0000000..2da968b --- /dev/null +++ b/docs-xml/smbdotconf/misc/defaultservice.xml @@ -0,0 +1,31 @@ +<samba:parameter name="default service" + context="G" + type="string" + function="defaultservice" + substitution="1" + 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 0000000..84390ed --- /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 0000000..f569cd2 --- /dev/null +++ b/docs-xml/smbdotconf/misc/deletesharecommand.xml @@ -0,0 +1,52 @@ +<samba:parameter name="delete share command" + context="G" + type="string" + substitution="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>. + </para> + + <para>In order to successfully execute the + <parameter moreinfo="none">delete share command</parameter>, + <command moreinfo="none">smbd</command> requires that the administrator + connects using a root account (i.e. uid == 0) or has the + <literal>SeDiskOperatorPrivilege</literal>. + Scripts defined in the <parameter moreinfo="none">delete share command</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>change 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 0000000..9679763 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dfreecachetime.xml @@ -0,0 +1,26 @@ +<samba:parameter name="dfree cache time" + context="S" + type="integer" + 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">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 0000000..b12ee0f --- /dev/null +++ b/docs-xml/smbdotconf/misc/dfreecommand.xml @@ -0,0 +1,62 @@ +<samba:parameter name="dfree command" + context="S" + type="string" + substitution="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. + Also note the arguments passed into the script should be quoted inside the script in case they + contain special characters such as spaces or newlines. + </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/directorynamecachesize.xml b/docs-xml/smbdotconf/misc/directorynamecachesize.xml new file mode 100644 index 0000000..22999a6 --- /dev/null +++ b/docs-xml/smbdotconf/misc/directorynamecachesize.xml @@ -0,0 +1,14 @@ +<samba:parameter name="directory name cache size" + context="S" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter specifies the size of the directory name cache for SMB1 + connections. It is not used for SMB2. It will be needed to turn this off + for *BSD systems. + </para> + +</description> +<value type="default">100</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dmapisupport.xml b/docs-xml/smbdotconf/misc/dmapisupport.xml new file mode 100644 index 0000000..de284ee --- /dev/null +++ b/docs-xml/smbdotconf/misc/dmapisupport.xml @@ -0,0 +1,28 @@ +<samba:parameter name="dmapi support" + context="S" + type="boolean" + 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 0000000..ca9c75f --- /dev/null +++ b/docs-xml/smbdotconf/misc/dontdescend.xml @@ -0,0 +1,21 @@ +<samba:parameter name="dont descend" + context="S" + type="string" + substitution="1" + 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 0000000..353f4bb --- /dev/null +++ b/docs-xml/smbdotconf/misc/dosfilemode.xml @@ -0,0 +1,24 @@ +<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, including an ACL permission) 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. + + Note that using the VFS modules acl_xattr or acl_tdb which store native + Windows as meta-data will automatically turn this option on for any + share for which they are loaded, as they require this option to emulate + Windows ACLs correctly. + </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 0000000..ccdfa6d --- /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 0000000..17fadd2 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dosfiletimes.xml @@ -0,0 +1,20 @@ +<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 emulates the DOS semantics and allows one to change the + timestamp on a file if the user <command moreinfo="none">smbd</command> is acting + on behalf has write permissions. + 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/dsdbeventnotification.xml b/docs-xml/smbdotconf/misc/dsdbeventnotification.xml new file mode 100644 index 0000000..279ac3d --- /dev/null +++ b/docs-xml/smbdotconf/misc/dsdbeventnotification.xml @@ -0,0 +1,29 @@ +<samba:parameter name="dsdb event notification" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>When enabled, this option causes Samba (acting as an + Active Directory Domain Controller) to stream Samba database + events across the internal message bus. Scripts built using + Samba's python bindings can listen to these events by + registering as the service + <filename moreinfo="none">dsdb_event</filename>.</para> + + <para>This is <emphasis>not</emphasis> needed for the audit + logging described in <smbconfoption name="log level"/>.</para> + + <para>Instead, this should instead be considered a developer + option (it assists in the Samba testsuite) rather than a + facility for external auditing, as message delivery is not + guaranteed (a feature that the testsuite works around).</para> + + <para>The Samba database events are also logged via the normal + logging methods when the <smbconfoption name="log level"/> is + set appropriately, say to + <command moreinfo="none">dsdb_json_audit:5</command>.</para> + +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dsdbgroupchangenotification.xml b/docs-xml/smbdotconf/misc/dsdbgroupchangenotification.xml new file mode 100644 index 0000000..3972e72 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dsdbgroupchangenotification.xml @@ -0,0 +1,29 @@ +<samba:parameter name="dsdb group change notification" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>When enabled, this option causes Samba (acting as an + Active Directory Domain Controller) to stream group membership change + events across the internal message bus. Scripts built using + Samba's python bindings can listen to these events by + registering as the service + <filename moreinfo="none">dsdb_group_event</filename>.</para> + + <para>This is <emphasis>not</emphasis> needed for the audit + logging described in <smbconfoption name="log level"/>.</para> + + <para>Instead, this should instead be considered a developer + option (it assists in the Samba testsuite) rather than a + facility for external auditing, as message delivery is not + guaranteed (a feature that the testsuite works around).</para> + + <para>The Samba database events are also logged via the normal + logging methods when the <smbconfoption name="log level"/> is + set appropriately, say to + <command moreinfo="none">dsdb_group_json_audit:5</command>.</para> + +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml b/docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml new file mode 100644 index 0000000..cd2cc98 --- /dev/null +++ b/docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml @@ -0,0 +1,29 @@ +<samba:parameter name="dsdb password event notification" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>When enabled, this option causes Samba (acting as an + Active Directory Domain Controller) to stream password change + and reset events across the internal message bus. + Scripts built using Samba's python bindings can listen to these + events by registering as the service + <filename moreinfo="none">password_event</filename>.</para> + + <para>This is <emphasis>not</emphasis> needed for the audit + logging described in <smbconfoption name="log level"/>.</para> + + <para>Instead, this should instead be considered a developer + option (it assists in the Samba testsuite) rather than a + facility for external auditing, as message delivery is not + guaranteed (a feature that the testsuite works around).</para> + + <para>The Samba database events are also logged via the normal + logging methods when the <smbconfoption name="log level"/> is + set appropriately, say to + <command moreinfo="none">dsdb_password_json_audit:5</command>.</para> + +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchaddress.xml b/docs-xml/smbdotconf/misc/elasticsearchaddress.xml new file mode 100644 index 0000000..6112546 --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchaddress.xml @@ -0,0 +1,14 @@ +<samba:parameter name="elasticsearch:address" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Specifies the name of the Elasticsearch server to use for Spotlight + queries when using the Elasticsearch backend. + </para> + </description> + + <value type="default">localhost</value> + <value type="example">needle.haystack.samba.org</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchignoreunknownattribute.xml b/docs-xml/smbdotconf/misc/elasticsearchignoreunknownattribute.xml new file mode 100644 index 0000000..86368d3 --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchignoreunknownattribute.xml @@ -0,0 +1,19 @@ +<samba:parameter name="elasticsearch:ignore unknown attribute" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Ignore unknown Spotlight attributes in search queries. An example query + using the unsupported attribute + <literal>"kMDItemTopic"</literal> would be + <literal>kMDItemTopic=="hotstuff"</literal>. By + default any query using such a type would completely fail. By enabling + this option, if the type match is a subexpression of a larger expression, + then this subexpression is just ignored. + </para> + </description> + + <value type="default">no</value> + <value type="example">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml b/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml new file mode 100644 index 0000000..ca1f873 --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml @@ -0,0 +1,19 @@ +<samba:parameter name="elasticsearch:ignore unknown type" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Ignore unknown Spotlight types in search queries. An example query using + the unsupported type <literal>"public.calendar-event"</literal> + would be + <literal>kMDItemContentType=="public.calendar-event"</literal>. By + default any query using such a type would completely fail. By enabling + this option, if the type match is a subexpression of a larger expression, + then this subexpression is just ignored. + </para> + </description> + + <value type="default">no</value> + <value type="example">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchindex.xml b/docs-xml/smbdotconf/misc/elasticsearchindex.xml new file mode 100644 index 0000000..7f394b2 --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchindex.xml @@ -0,0 +1,16 @@ +<samba:parameter name="elasticsearch:index" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Specifies the name of the Elasticsearch index to use for Spotlight queries + when using the Elasticsearch backend. The default value of "_all" is a + special Elasticsearch value that performs the search operation on all + indices. + </para> + </description> + + <value type="default">_all</value> + <value type="example">spotlight</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchmappings.xml b/docs-xml/smbdotconf/misc/elasticsearchmappings.xml new file mode 100644 index 0000000..d2502a6 --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchmappings.xml @@ -0,0 +1,14 @@ +<samba:parameter name="elasticsearch:mappings" + context="G" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Path to a file specifying metadata attribute mappings in JSON format. Use + by the Elasticsearch backend of the Spotlight RPC service. + </para> + </description> + + <value type="default">&pathconfig.SAMBA_DATADIR;/elasticsearch_mappings.json</value> + <value type="example">/usr/share/foo/mymappings.json</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchmaxresults.xml b/docs-xml/smbdotconf/misc/elasticsearchmaxresults.xml new file mode 100644 index 0000000..1086b89 --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchmaxresults.xml @@ -0,0 +1,15 @@ +<samba:parameter name="elasticsearch:max results" + context="S" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Path to a file specifying metadata attribute mappings in JSON format. Used + by the Elasticsearch backend of the Spotlight RPC service. A value of 0 + means no limit. + </para> + </description> + + <value type="default">100</value> + <value type="example">10</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchport.xml b/docs-xml/smbdotconf/misc/elasticsearchport.xml new file mode 100644 index 0000000..ea87daa --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchport.xml @@ -0,0 +1,14 @@ +<samba:parameter name="elasticsearch:port" + context="S" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Specifies the TCP port of the Elasticsearch server to use for Spotlight + queries when using the Elasticsearch backend. + </para> + </description> + + <value type="default">9200</value> + <value type="example">9201</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/elasticsearchusetls.xml b/docs-xml/smbdotconf/misc/elasticsearchusetls.xml new file mode 100644 index 0000000..e1aa8a3 --- /dev/null +++ b/docs-xml/smbdotconf/misc/elasticsearchusetls.xml @@ -0,0 +1,14 @@ +<samba:parameter name="elasticsearch:use tls" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + Specifies whether to use HTTPS when talking to the Elasticsearch server + used for Spotlight queries when using the Elasticsearch backend. + </para> + </description> + + <value type="default">no</value> + <value type="example">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 0000000..49f54a9 --- /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 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 0000000..deca634 --- /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/fssprunestale.xml b/docs-xml/smbdotconf/misc/fssprunestale.xml new file mode 100644 index 0000000..722cff5 --- /dev/null +++ b/docs-xml/smbdotconf/misc/fssprunestale.xml @@ -0,0 +1,15 @@ +<samba:parameter name="fss: prune stale" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + When enabled, Samba's File Server Remote VSS Protocol (FSRVP) server + checks all FSRVP initiated snapshots on startup, and removes any + corresponding state (including share definitions) for nonexistent + snapshot paths. + </para> +</description> +<value type="default">no</value> +<value type="example">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/fsssequencetimeout.xml b/docs-xml/smbdotconf/misc/fsssequencetimeout.xml new file mode 100644 index 0000000..12f1854 --- /dev/null +++ b/docs-xml/smbdotconf/misc/fsssequencetimeout.xml @@ -0,0 +1,15 @@ +<samba:parameter name="fss: sequence timeout" + context="G" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + The File Server Remote VSS Protocol (FSRVP) server includes a message + sequence timer to ensure cleanup on unexpected client disconnect. This + parameter overrides the default timeout between FSRVP operations. + FSRVP timeouts can be completely disabled via a value of 0. + </para> +</description> +<value type="default">180 or 1800, depending on operation</value> +<value type="example">0</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/fstype.xml b/docs-xml/smbdotconf/misc/fstype.xml new file mode 100644 index 0000000..437bd5c --- /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/honorchangenotifyprivilege.xml b/docs-xml/smbdotconf/misc/honorchangenotifyprivilege.xml new file mode 100644 index 0000000..a9c880c --- /dev/null +++ b/docs-xml/smbdotconf/misc/honorchangenotifyprivilege.xml @@ -0,0 +1,20 @@ +<samba:parameter name="honor change notify privilege" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This option can be used to make use of the change notify privilege. + By default notify results are not checked against the file system + permissions. + </para> + <para> + If "honor change notify privilege" is enabled, a user will only + receive notify results, if he has change notify privilege or + sufficient file system permissions. If a user has the change notify + privilege, he will receive all requested notify results, even if the + user does not have the permissions on the file system. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/include.xml b/docs-xml/smbdotconf/misc/include.xml new file mode 100644 index 0000000..cbda1ed --- /dev/null +++ b/docs-xml/smbdotconf/misc/include.xml @@ -0,0 +1,31 @@ +<samba:parameter name="include" + context="S" + type="string" + generated_function="0" + handler="handle_include" + 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> + + <para> + The parameter <parameter>include = registry</parameter> has + a special meaning: It does <emphasis>not</emphasis> include + a file named <emphasis>registry</emphasis> from the current working + directory, but instead reads the global configuration options + from the registry. See the section on registry-based + configuration for details. Note that this option + automatically activates registry shares. + </para> +</description> + +<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 0000000..d5551a9 --- /dev/null +++ b/docs-xml/smbdotconf/misc/kernelchangenotify.xml @@ -0,0 +1,16 @@ +<samba:parameter name="kernel change notify" + context="G" + type="boolean" + 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 0000000..cf0ea2b --- /dev/null +++ b/docs-xml/smbdotconf/misc/lockdirectory.xml @@ -0,0 +1,24 @@ +<samba:parameter name="lock directory" + context="G" + 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> + <para>The files placed in this directory are not required + across service restarts and can be safely placed on volatile + storage (e.g. tmpfs in Linux)</para> + +</description> + +<value type="default">&pathconfig.LOCKDIR;</value> +<value type="example">/var/run/samba/locks</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml b/docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml new file mode 100644 index 0000000..d95471a --- /dev/null +++ b/docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml @@ -0,0 +1,22 @@ +<samba:parameter name="log writeable files on exit" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + When the network connection between a CIFS client and Samba + dies, Samba has no option but to simply shut down the server + side of the network connection. If this happens, there is a + risk of data corruption because the Windows client did not + complete all write operations that the Windows application + requested. Setting this option to "yes" makes smbd log with + a level 0 message a list of all files that have been opened + for writing when the network connection died. Those are the + files that are potentially corrupted. It is meant as an aid + for the administrator to give him a list of files to do + consistency checks on. + </para> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/magicoutput.xml b/docs-xml/smbdotconf/misc/magicoutput.xml new file mode 100644 index 0000000..17b3c67 --- /dev/null +++ b/docs-xml/smbdotconf/misc/magicoutput.xml @@ -0,0 +1,19 @@ +<samba:parameter name="magic output" + context="S" + type="string" + substitution="1" + 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"><comment><magic script name>.out</comment></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 0000000..614f5ae --- /dev/null +++ b/docs-xml/smbdotconf/misc/magicscript.xml @@ -0,0 +1,31 @@ +<samba:parameter name="magic script" + context="S" + type="string" + substitution="1" + 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 0000000..ba39b9f --- /dev/null +++ b/docs-xml/smbdotconf/misc/messagecommand.xml @@ -0,0 +1,79 @@ +<samba:parameter name="message command" + context="G" + type="string" + substitution="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/nbtclientsocketaddress.xml b/docs-xml/smbdotconf/misc/nbtclientsocketaddress.xml new file mode 100644 index 0000000..12815dc --- /dev/null +++ b/docs-xml/smbdotconf/misc/nbtclientsocketaddress.xml @@ -0,0 +1,20 @@ +<samba:parameter name="nbt client socket address" + context="G" + type="string" + deprecated="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<synonym>socket address</synonym> +<description> + <para>This option allows you to control what address Samba + will send NBT client packets from, and process replies using, + including in nmbd. </para> + <para>Setting this option should never be necessary on usual Samba + servers running only one nmbd.</para> + + <para>By default Samba will send UDP packets from the OS default address for the destination, and accept replies on 0.0.0.0.</para> + <para>This parameter is deprecated. See <smbconfoption name="bind interfaces only">Yes</smbconfoption> and <smbconfoption name="interfaces"></smbconfoption> for the previous behaviour of controlling the normal listening sockets.</para> +</description> + +<value type="default">0.0.0.0</value> +<value type="example">192.168.2.20</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/ncalrpcdir.xml b/docs-xml/smbdotconf/misc/ncalrpcdir.xml new file mode 100644 index 0000000..4bbd222 --- /dev/null +++ b/docs-xml/smbdotconf/misc/ncalrpcdir.xml @@ -0,0 +1,12 @@ +<samba:parameter name="ncalrpc dir" + context="G" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This directory will hold a series of named pipes to allow RPC over inter-process communication.</para> + <para>This will allow Samba and other unix processes to interact over DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has restricted permissions, and allows a trusted communication channel between Samba processes</para> +</description> + +<value type="default">&pathconfig.NCALRPCDIR;</value> +<value type="example">/var/run/samba/ncalrpc</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/nmbdbindexplicitbroadcast.xml b/docs-xml/smbdotconf/misc/nmbdbindexplicitbroadcast.xml new file mode 100644 index 0000000..fd72f06 --- /dev/null +++ b/docs-xml/smbdotconf/misc/nmbdbindexplicitbroadcast.xml @@ -0,0 +1,16 @@ +<samba:parameter name="nmbd bind explicit broadcast" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This option causes <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to explicitly bind to the + broadcast address of the local subnets. This is needed to make nmbd + work correctly in combination with the <smbconfoption name="socket address"/> option. + You should not need to unset this option. + </para> +</description> + +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/panicaction.xml b/docs-xml/smbdotconf/misc/panicaction.xml new file mode 100644 index 0000000..01a97c3 --- /dev/null +++ b/docs-xml/smbdotconf/misc/panicaction.xml @@ -0,0 +1,17 @@ +<samba:parameter name="panic action" + context="G" + type="string" + substitution="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/perfcountmodule.xml b/docs-xml/smbdotconf/misc/perfcountmodule.xml new file mode 100644 index 0000000..e25105f --- /dev/null +++ b/docs-xml/smbdotconf/misc/perfcountmodule.xml @@ -0,0 +1,13 @@ +<samba:parameter name="perfcount module" + context="G" + type="string" + substitution="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter specifies the perfcount backend to be used when monitoring SMB + operations. Only one perfcount module may be used, and it must implement all of the + apis contained in the smb_perfcount_handler structure defined in smb.h. + </para> +</description> + +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/piddirectory.xml b/docs-xml/smbdotconf/misc/piddirectory.xml new file mode 100644 index 0000000..d006372 --- /dev/null +++ b/docs-xml/smbdotconf/misc/piddirectory.xml @@ -0,0 +1,13 @@ +<samba:parameter name="pid directory" + context="G" + type="string" + 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">&pathconfig.PIDDIR;</value> +<value type="example">/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 0000000..ca15221 --- /dev/null +++ b/docs-xml/smbdotconf/misc/postexec.xml @@ -0,0 +1,21 @@ +<samba:parameter name="postexec" + context="S" + type="string" + substitution="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 0000000..7faf89a --- /dev/null +++ b/docs-xml/smbdotconf/misc/preexec.xml @@ -0,0 +1,29 @@ +<samba:parameter name="preexec" + context="S" + type="string" + substitution="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 0000000..3d184e1 --- /dev/null +++ b/docs-xml/smbdotconf/misc/preexecclose.xml @@ -0,0 +1,13 @@ +<samba:parameter name="preexec close" + context="S" + type="boolean" + 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/registryshares.xml b/docs-xml/smbdotconf/misc/registryshares.xml new file mode 100644 index 0000000..0bdb1f6 --- /dev/null +++ b/docs-xml/smbdotconf/misc/registryshares.xml @@ -0,0 +1,23 @@ +<samba:parameter name="registry shares" + context="G" + type="boolean" + 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 0000000..0436898 --- /dev/null +++ b/docs-xml/smbdotconf/misc/remoteannounce.xml @@ -0,0 +1,42 @@ +<samba:parameter name="remote announce" + context="G" + type="string" + substitution="1" + 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 0000000..c0b106e --- /dev/null +++ b/docs-xml/smbdotconf/misc/remotebrowsesync.xml @@ -0,0 +1,50 @@ +<samba:parameter name="remote browse sync" + context="G" + type="string" + substitution="1" + 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 0000000..a991733 --- /dev/null +++ b/docs-xml/smbdotconf/misc/resetonzerovc.xml @@ -0,0 +1,28 @@ +<samba:parameter name="reset on zero vc" + context="G" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This boolean option controls whether an incoming SMB1 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, and will not trigger + for clients that only use SMB2 or SMB3. + + </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 0000000..4e74fc8 --- /dev/null +++ b/docs-xml/smbdotconf/misc/rootpostexec.xml @@ -0,0 +1,16 @@ +<samba:parameter name="root postexec" + context="S" + type="string" + substitution="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 0000000..32c4ef7 --- /dev/null +++ b/docs-xml/smbdotconf/misc/rootpreexec.xml @@ -0,0 +1,18 @@ +<samba:parameter name="root preexec" + context="S" + type="string" + substitution="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 0000000..35fd883 --- /dev/null +++ b/docs-xml/smbdotconf/misc/rootpreexecclose.xml @@ -0,0 +1,14 @@ +<samba:parameter name="root preexec close" + context="S" + type="boolean" + 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/smbdasyncdosmode.xml b/docs-xml/smbdotconf/misc/smbdasyncdosmode.xml new file mode 100644 index 0000000..03d902c --- /dev/null +++ b/docs-xml/smbdotconf/misc/smbdasyncdosmode.xml @@ -0,0 +1,13 @@ +<samba:parameter name="smbd async dosmode" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter control whether the fileserver will use sync or async + methods for fetching the DOS attributes when doing a directory listing. By default sync methods will be + used. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/smbdgetinfoasksharemode.xml b/docs-xml/smbdotconf/misc/smbdgetinfoasksharemode.xml new file mode 100644 index 0000000..1bef948 --- /dev/null +++ b/docs-xml/smbdotconf/misc/smbdgetinfoasksharemode.xml @@ -0,0 +1,14 @@ +<samba:parameter name="smbd getinfo ask sharemode" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter allows disabling fetching file write time from the open + file handle database locking.tdb when a client requests file or + directory metadata. It's a performance optimisation at the expense of + protocol correctness. + </para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/smbdmaxasyncdosmode.xml b/docs-xml/smbdotconf/misc/smbdmaxasyncdosmode.xml new file mode 100644 index 0000000..b375298 --- /dev/null +++ b/docs-xml/smbdotconf/misc/smbdmaxasyncdosmode.xml @@ -0,0 +1,12 @@ +<samba:parameter name="smbd max async dosmode" + context="S" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter controls how many async operations to fetch the DOS + attributes the fileserver will queue when doing directory listings. + </para> +</description> +<value type="default">aio max threads * 2</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/smbdmaxxattrsize.xml b/docs-xml/smbdotconf/misc/smbdmaxxattrsize.xml new file mode 100644 index 0000000..3ae91a3 --- /dev/null +++ b/docs-xml/smbdotconf/misc/smbdmaxxattrsize.xml @@ -0,0 +1,28 @@ +<samba:parameter name="smbd max xattr size" + context="S" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter controls the maximum size of extended attributes + that may be written to the server as EAs or as alternate data + streams if vfs_streams_xattr is enabled. The maximum size of + extended attributes depends on the Samba server's operating system + and the underlying filesystem. The Linux VFS currently sets an + upper boundary of 64 KiB per extended attribute. FreeBSD does not + set a practical upper limit, but since pread() and pwrite() are not + possible via the extattr on FreeBSD, it is not recommended to + increase this value above a few MiB. + + If a client attempts to write an overly-large alternate datastream, + the Samba server will return STATUS_FILESYSTEM_LIMITATION. + If this error is encountered, users may try increasing the maximum + size supported for xattr writes. If this is not possible, and + writes are from a MacOS client and to an AFP_Resource extended + attribute, the user may enable the vfs_fruit module and configure + to allow stream writes for AFP_Resource to an alternative storage + location. See vfs_fruit documentation for further details. + </para> +</description> +<value type="default">65536</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/smbdprofilinglevel.xml b/docs-xml/smbdotconf/misc/smbdprofilinglevel.xml new file mode 100644 index 0000000..54dccf0 --- /dev/null +++ b/docs-xml/smbdotconf/misc/smbdprofilinglevel.xml @@ -0,0 +1,17 @@ +<samba:parameter name="smbd profiling level" + context="G" + type="enum" + enumlist="enum_smbd_profiling_level" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter allows the administrator to enable profiling support. + </para> + <para> + Possible values are <constant>off</constant>, + <constant>count</constant> and <constant>on</constant>. + </para> +</description> +<value type="default">off</value> +<value type="example">on</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/smbdsearchasksharemode.xml b/docs-xml/smbdotconf/misc/smbdsearchasksharemode.xml new file mode 100644 index 0000000..de78818 --- /dev/null +++ b/docs-xml/smbdotconf/misc/smbdsearchasksharemode.xml @@ -0,0 +1,13 @@ +<samba:parameter name="smbd search ask sharemode" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter allows disabling fetching file write time from the open + file handle database locking.tdb. It's a performance optimisation at + the expense of protocol correctness. + </para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/spotlight.xml b/docs-xml/smbdotconf/misc/spotlight.xml new file mode 100644 index 0000000..04631d3 --- /dev/null +++ b/docs-xml/smbdotconf/misc/spotlight.xml @@ -0,0 +1,31 @@ +<samba:parameter name="spotlight" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter controls whether Samba allows Spotlight + queries on a share. For controlling indexing of filesystems + you also have to use Tracker's own configuration system. + </para> + + <para> + Spotlight has several prerequisites: + </para> + + <itemizedlist> + <listitem><para> + Samba must be configured and built with Spotlight support. + </para></listitem> + + <listitem><para> Tracker integration must be setup and the + share must be indexed by Tracker.</para></listitem> + </itemizedlist> + + <para>For a detailed set of instructions please see <ulink + url="https://wiki.samba.org/index.php/Spotlight">https://wiki.samba.org/index.php/Spotlight</ulink>. + </para> + +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/spotlight_backend.xml b/docs-xml/smbdotconf/misc/spotlight_backend.xml new file mode 100644 index 0000000..0643fc1 --- /dev/null +++ b/docs-xml/smbdotconf/misc/spotlight_backend.xml @@ -0,0 +1,30 @@ +<samba:parameter name="spotlight backend" + context="S" + type="enum" + enumlist="enum_spotlight_backend" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + Spotlight search backend. Available backends: + + <itemizedlist> + <listitem><para><constant>noindex</constant> - + a backend that returns no results. + </para></listitem> + + </itemizedlist> + + <itemizedlist> + <listitem><para><constant>tracker</constant> - + Gnome Tracker. + </para></listitem> + + <listitem><para><constant>elasticsearch</constant> - + a backend that uses JSON and REST over HTTP(s) to query an + Elasticsearch server. + </para></listitem> + </itemizedlist> + </para> +</description> +<value type="default">noindex</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/statedirectory.xml b/docs-xml/smbdotconf/misc/statedirectory.xml new file mode 100644 index 0000000..12481fc --- /dev/null +++ b/docs-xml/smbdotconf/misc/statedirectory.xml @@ -0,0 +1,21 @@ +<samba:parameter name="state directory" + context="G" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>Usually, most of the TDB files are stored in the + <parameter moreinfo="none">lock directory</parameter>. Since + Samba 3.4.0, it is possible to differentiate between TDB files + with persistent data and TDB files with non-persistent data using + the <parameter moreinfo="none">state directory</parameter> and the + <parameter moreinfo="none">cache directory</parameter> options. + </para> + + <para> This option specifies the directory where TDB files containing + important persistent data will be stored. + </para> +</description> + +<value type="default">&pathconfig.STATEDIR;</value> +<value type="example">/var/run/samba/locks/state</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usershareallowguests.xml b/docs-xml/smbdotconf/misc/usershareallowguests.xml new file mode 100644 index 0000000..be210bf --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareallowguests.xml @@ -0,0 +1,15 @@ +<samba:parameter name="usershare allow guests" + context="G" + 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 its security sensitive nature, 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 0000000..0d69bb8 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usersharemaxshares.xml @@ -0,0 +1,13 @@ +<samba:parameter name="usershare max shares" + context="G" + 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 0000000..5b33492 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareowneronly.xml @@ -0,0 +1,18 @@ +<samba:parameter name="usershare owner only" + context="G" + 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">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usersharepath.xml b/docs-xml/smbdotconf/misc/usersharepath.xml new file mode 100644 index 0000000..99fea94 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usersharepath.xml @@ -0,0 +1,32 @@ +<samba:parameter name="usershare path" + context="G" + type="string" + substitution="1" + 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. + </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">&pathconfig.STATEDIR;/usershares</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/usershareprefixallowlist.xml b/docs-xml/smbdotconf/misc/usershareprefixallowlist.xml new file mode 100644 index 0000000..4c236fe --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareprefixallowlist.xml @@ -0,0 +1,23 @@ +<samba:parameter name="usershare prefix allow list" + context="G" + type="cmdlist" + 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 to be 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"></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 0000000..c0e18a7 --- /dev/null +++ b/docs-xml/smbdotconf/misc/usershareprefixdenylist.xml @@ -0,0 +1,24 @@ +<samba:parameter name="usershare prefix deny list" + context="G" + type="cmdlist" + 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"></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 0000000..3a74dcb --- /dev/null +++ b/docs-xml/smbdotconf/misc/usersharetemplateshare.xml @@ -0,0 +1,23 @@ +<samba:parameter name="usershare template share" + context="G" + 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"></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 0000000..6382d46 --- /dev/null +++ b/docs-xml/smbdotconf/misc/utmp.xml @@ -0,0 +1,24 @@ +<samba:parameter name="utmp" + context="G" + type="boolean" + 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 0000000..96b45db --- /dev/null +++ b/docs-xml/smbdotconf/misc/utmpdirectory.xml @@ -0,0 +1,20 @@ +<samba:parameter name="utmp directory" + context="G" + type="string" + 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 0000000..8d86f9c --- /dev/null +++ b/docs-xml/smbdotconf/misc/valid.xml @@ -0,0 +1,20 @@ +<samba:parameter name="-valid" + context="S" + type="boolean" + generated_function="0" + function="valid" + 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 0000000..4f1be6a --- /dev/null +++ b/docs-xml/smbdotconf/misc/volume.xml @@ -0,0 +1,13 @@ +<samba:parameter name="volume" + context="S" + type="string" + substitution="1" + 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/volumeserialnumber.xml b/docs-xml/smbdotconf/misc/volumeserialnumber.xml new file mode 100644 index 0000000..41cf2c2 --- /dev/null +++ b/docs-xml/smbdotconf/misc/volumeserialnumber.xml @@ -0,0 +1,14 @@ +<samba:parameter name="volume serial number" + context="S" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This allows to override the volume serial number + (a 32bit value) reported for a share.</para> + <para>The special value <emphasis>-1</emphasis> (default) stands for + a unique number that is calculated for each share.</para> +</description> + +<value type="default">-1</value> +<value type="example">0xabcdefgh</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/widelinks.xml b/docs-xml/smbdotconf/misc/widelinks.xml new file mode 100644 index 0000000..09f8aa5 --- /dev/null +++ b/docs-xml/smbdotconf/misc/widelinks.xml @@ -0,0 +1,27 @@ +<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: Turning this parameter on when UNIX extensions are enabled + will allow UNIX clients to create symbolic links on the share that + can point to files or directories outside restricted path exported + by the share definition. This can cause access to areas outside of + the share. Due to this problem, this parameter will be automatically + disabled (with a message in the log file) if the + <smbconfoption name="unix extensions"/> option is on. + </para> + <para> + See the parameter <smbconfoption name="allow insecure wide links"/> + if you wish to change this coupling between the two parameters. + </para> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/misc/wtmpdirectory.xml b/docs-xml/smbdotconf/misc/wtmpdirectory.xml new file mode 100644 index 0000000..f1b5359 --- /dev/null +++ b/docs-xml/smbdotconf/misc/wtmpdirectory.xml @@ -0,0 +1,22 @@ +<samba:parameter name="wtmp directory" + context="G" + type="string" + 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> |