diff options
Diffstat (limited to 'docs/htmldocs/manpages')
71 files changed, 10315 insertions, 0 deletions
diff --git a/docs/htmldocs/manpages/eventlogadm.8.html b/docs/htmldocs/manpages/eventlogadm.8.html new file mode 100644 index 0000000000..f9c6cf859b --- /dev/null +++ b/docs/htmldocs/manpages/eventlogadm.8.html @@ -0,0 +1,109 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>eventlogadm</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="eventlogadm.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>eventlogadm — push records into the Samba event log store</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">eventlogadm</code> [<code class="option">-d</code>] [<code class="option">-h</code>] <code class="option">-o</code> + <code class="literal">addsource</code> + <em class="replaceable"><code>EVENTLOG</code></em> + <em class="replaceable"><code>SOURCENAME</code></em> + <em class="replaceable"><code>MSGFILE</code></em> + </p></div><div class="cmdsynopsis"><p><code class="literal">eventlogadm</code> [<code class="option">-d</code>] [<code class="option">-h</code>] <code class="option">-o</code> + <code class="literal">write</code> + <em class="replaceable"><code>EVENTLOG</code></em> + </p></div></div><div class="refsect1" lang="en"><a name="id299251"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.1.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(1)</span></a> suite.</p><p><code class="literal">eventlogadm</code> is a filter that accepts + formatted event log records on standard input and writes them + to the Samba event log store. Windows client can then manipulate + these record using the usual administration tools.</p></div><div class="refsect1" lang="en"><a name="id266714"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">-d</code></span></dt><dd><p> + The <code class="literal">-d</code> option causes <code class="literal">eventlogadm</code> to emit debugging + information. + </p></dd><dt><span class="term"> + <code class="option">-o</code> + <code class="literal">addsource</code> + <em class="replaceable"><code>EVENTLOG</code></em> + <em class="replaceable"><code>SOURCENAME</code></em> + <em class="replaceable"><code>MSGFILE</code></em> + </span></dt><dd><p> + The <code class="literal">-o addsource</code> option creates a + new event log source. + </p></dd><dt><span class="term"> + <code class="option">-o</code> + <code class="literal">write</code> + <em class="replaceable"><code>EVENTLOG</code></em> + </span></dt><dd><p> + The <code class="literal">-o write</code> reads event log + records from standard input and writes them to theSamba + event log store named by EVENTLOG. + </p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p> + Print usage information. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266828"></a><h2>EVENTLOG RECORD FORMAT</h2><p>For the write operation, <code class="literal">eventlogadm</code> + expects to be able to read structured records from standard + input. These records are a sequence of lines, with the record key + and data separated by a colon character. Records are separated + by at least one or more blank line.</p><p>The event log record field are:</p><div class="itemizedlist"><ul type="disc"><li><p> + <code class="literal">LEN</code> - This field should be 0, since <code class="literal">eventlogadm</code> will calculate this value. + </p></li><li><p> + <code class="literal">RS1</code> - This must be the value 1699505740. + </p></li><li><p> + <code class="literal">RCN</code> - This field should be 0. + </p></li><li><p> + <code class="literal">TMG</code> - The time the eventlog record + was generated; format is the number of seconds since + 00:00:00 January 1, 1970, UTC. + </p></li><li><p> + <code class="literal">TMW</code> - The time the eventlog record was + written; format is the number of seconds since 00:00:00 + January 1, 1970, UTC. + </p></li><li><p> + <code class="literal">EID</code> - The eventlog ID. + </p></li><li><p> + <code class="literal">ETP</code> - The event type -- one of + "INFO", + "ERROR", "WARNING", "AUDIT + SUCCESS" or "AUDIT FAILURE". + </p></li><li><p> + <code class="literal">ECT</code> - The event category; this depends + on the message file. It is primarily used as a means of + filtering in the eventlog viewer. + </p></li><li><p> + <code class="literal">RS2</code> - This field should be 0. + </p></li><li><p> + <code class="literal">CRN</code> - This field should be 0. + </p></li><li><p> + <code class="literal">USL</code> - This field should be 0. + </p></li><li><p> + <code class="literal">SRC</code> - This field contains the source + name associated with the event log. If a message file is + used with an event log, there will be a registry entry + for associating this source name with a message file DLL. + </p></li><li><p> + <code class="literal">SRN</code> - he name of the machine on + which the eventlog was generated. This is typically the + host name. + </p></li><li><p> + <code class="literal">STR</code> - The text associated with the + eventlog. There may be more than one string in a record. + </p></li><li><p> + <code class="literal">DAT</code> - This field should be left unset. + </p></li></ul></div></div><div class="refsect1" lang="en"><a name="id307897"></a><h2>EXAMPLES</h2><p>An example of the record format accepted by <code class="literal">eventlogadm</code>:</p><pre class="programlisting"> + LEN: 0 + RS1: 1699505740 + RCN: 0 + TMG: 1128631322 + TMW: 1128631322 + EID: 1000 + ETP: INFO + ECT: 0 + RS2: 0 + CRN: 0 + USL: 0 + SRC: cron + SRN: dmlinux + STR: (root) CMD ( rm -f /var/spool/cron/lastrun/cron.hourly) + DAT: + </pre><p>Set up an eventlog source, specifying a message file DLL:</p><pre class="programlisting"> + eventlogadm -o addsource Application MyApplication | \\ + %SystemRoot%/system32/MyApplication.dll + </pre><p>Filter messages from the system log into an event log:</p><pre class="programlisting"> + tail -f /var/log/messages | \\ + my_program_to_parse_into_eventlog_records | \\ + eventlogadm SystemLogEvents + </pre></div><div class="refsect1" lang="en"><a name="id307938"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id307948"></a><h2>AUTHOR</h2><p> The original Samba software and related utilities were + created by Andrew Tridgell. Samba is now developed by the + Samba Team as an Open Source project similar to the way the + Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/findsmb.1.html b/docs/htmldocs/manpages/findsmb.1.html new file mode 100644 index 0000000000..84c97977b8 --- /dev/null +++ b/docs/htmldocs/manpages/findsmb.1.html @@ -0,0 +1,62 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>findsmb</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="findsmb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>findsmb — list info about machines that respond to SMB + name queries on a subnet</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">findsmb</code> [subnet broadcast address]</p></div></div><div class="refsect1" lang="en"><a name="id267679"></a><h2>DESCRIPTION</h2><p>This perl script is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> + suite.</p><p><code class="literal">findsmb</code> is a perl script that + prints out several pieces of information about machines + on a subnet that respond to SMB name query requests. + It uses <a href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a> + and <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a> + to obtain this information. + </p></div><div class="refsect1" lang="en"><a name="id299210"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-r</span></dt><dd><p>Controls whether <code class="literal">findsmb</code> takes + bugs in Windows95 into account when trying to find a Netbios name + registered of the remote machine. This option is disabled by default + because it is specific to Windows 95 and Windows 95 machines only. + If set, <a href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a> + will be called with <code class="constant">-B</code> option.</p></dd><dt><span class="term">subnet broadcast address</span></dt><dd><p>Without this option, <code class="literal">findsmb + </code> will probe the subnet of the machine where + <a href="findsmb.1.html"><span class="citerefentry"><span class="refentrytitle">findsmb</span>(1)</span></a> + is run. This value is passed to + <a href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a> + as part of the <code class="constant">-B</code> option.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266719"></a><h2>EXAMPLES</h2><p>The output of <code class="literal">findsmb</code> lists the following + information for all machines that respond to the initial + <code class="literal">nmblookup</code> for any name: IP address, NetBIOS name, + Workgroup name, operating system, and SMB server version.</p><p>There will be a '+' in front of the workgroup name for + machines that are local master browsers for that workgroup. There + will be an '*' in front of the workgroup name for + machines that are the domain master browser for that workgroup. + Machines that are running Windows for Workgroups, Windows 95 or + Windows 98 will + not show any information about the operating system or server + version.</p><p>The command with <code class="constant">-r</code> option + must be run on a system without <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> running. + + If <code class="literal">nmbd</code> is running on the system, you will + only get the IP address and the DNS name of the machine. To + get proper responses from Windows 95 and Windows 98 machines, + the command must be run as root and with <code class="constant">-r</code> + option on a machine without <code class="literal">nmbd</code> running.</p><p>For example, running <code class="literal">findsmb</code> + without <code class="constant">-r</code> option set would yield output similar + to the following</p><pre class="programlisting"> +IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION +--------------------------------------------------------------------- +192.168.35.10 MINESET-TEST1 [DMVENGR] +192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6] +192.168.35.56 HERBNT2 [HERB-NT] +192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX] +192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10] +192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX] +192.168.35.78 HERBDHCP1 +[HERB] +192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0] +192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager] +192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0] +</pre></div><div class="refsect1" lang="en"><a name="id266812"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266822"></a><h2>SEE ALSO</h2><p><a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, + <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, and <a href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a> + </p></div><div class="refsect1" lang="en"><a name="id266878"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">ftp://ftp.icce.rug.nl/pub/unix/</a>) + and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/idmap_ad.8.html b/docs/htmldocs/manpages/idmap_ad.8.html new file mode 100644 index 0000000000..14477cc5fc --- /dev/null +++ b/docs/htmldocs/manpages/idmap_ad.8.html @@ -0,0 +1,41 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>idmap_ad</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="idmap_ad.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>idmap_ad — Samba's idmap_ad Backend for Winbind</p></div><div class="refsynopsisdiv"><h2>DESCRIPTION</h2><p>The idmap_ad plugin provides a way for Winbind to read + id mappings from an AD server that uses RFC2307/SFU schema + extensions. This module implements only the "idmap" + API, and is READONLY. Mappings must be provided in advance + by the administrator by adding the posixAccount/posixGroup + classess and relative attribute/value pairs to the users and + groups objects in AD</p></div><div class="refsect1" lang="en"><a name="id267675"></a><h2>IDMAP OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">range = low - high</span></dt><dd><p> + Defines the available matching uid and gid range for which the + backend is authoritative. Note that the range acts as a filter. + If specified any UID or GID stored in AD that fall outside the + range is ignored and the corresponding map is discarded. + It is intended as a way to avoid accidental UID/GID overlaps + between local and remotely defined IDs. + </p></dd><dt><span class="term">schema_mode = <rfc2307 | sfu ></span></dt><dd><p> + Defines the schema that idmap_ad should use when querying + Active Directory regarding user and group information. + This can either the RFC2307 schema support included + in Windows 2003 R2 or the Service for Unix (SFU) schema. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299200"></a><h2>EXAMPLES</h2><p> + The following example shows how to retrieve idmappings from our principal and + and trusted AD domains. All is needed is to set default to yes. If trusted + domains are present id conflicts must be resolved beforehand, there is no + guarantee on the order conflicting mappings would be resolved at this point. + + This example also shows how to leave a small non conflicting range for local + id allocation that may be used in internal backends like BUILTIN. + </p><pre class="programlisting"> + [global] + idmap domains = ALLDOMAINS + idmap config ALLDOMAINS:backend = ad + idmap config ALLDOMAINS:default = yes + idmap config ALLDOMAINS:range = 10000 - 300000000 + + idmap alloc backend = tdb + idmap alloc config:range = 5000 - 9999 + </pre></div><div class="refsect1" lang="en"><a name="id299221"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/idmap_ldap.8.html b/docs/htmldocs/manpages/idmap_ldap.8.html new file mode 100644 index 0000000000..9510f2a7ac --- /dev/null +++ b/docs/htmldocs/manpages/idmap_ldap.8.html @@ -0,0 +1,69 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>idmap_ldap</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="idmap_ldap.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>idmap_ldap — Samba's idmap_ldap Backend for Winbind</p></div><div class="refsynopsisdiv"><h2>DESCRIPTION</h2><p>The idmap_ldap plugin provides a means for Winbind to + store and retrieve SID/uid/gid mapping tables in an LDAP directory + service. The module implements both the "idmap" and + "idmap alloc" APIs. + </p></div><div class="refsect1" lang="en"><a name="id267671"></a><h2>IDMAP OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">ldap_base_dn = DN</span></dt><dd><p> + Defines the directory base suffix to use when searching for + SID/uid/gid mapping entries. If not defined, idmap_ldap will default + to using the "ldap idmap suffix" option from smb.conf. + </p></dd><dt><span class="term">ldap_user_dn = DN</span></dt><dd><p> + Defines the user DN to be used for authentication. If absent an + anonymous bind will be performed. + </p></dd><dt><span class="term">ldap_url = ldap://server/</span></dt><dd><p> + Specifies the LDAP server to use when searching for existing + SID/uid/gid map entries. If not defined, idmap_ldap will + assume that ldap://localhost/ should be used. + </p></dd><dt><span class="term">range = low - high</span></dt><dd><p> + Defines the available matching uid and gid range for which the + backend is authoritative. Note that the range commonly matches + the allocation range due to the fact that the same backend will + store and retrieve SID/uid/gid mapping entries. If the parameter + is absent, Winbind fail over to use the "idmap uid" and + "idmap gid" options from smb.conf. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299222"></a><h2>IDMAP ALLOC OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">ldap_base_dn = DN</span></dt><dd><p> + Defines the directory base suffix under which new SID/uid/gid mapping + entries should be stored. If not defined, idmap_ldap will default + to using the "ldap idmap suffix" option from smb.conf. + </p></dd><dt><span class="term">ldap_user_dn = DN</span></dt><dd><p> + Defines the user DN to be used for authentication. If absent an + anonymous bind will be performed. + </p></dd><dt><span class="term">ldap_url = ldap://server/</span></dt><dd><p> + Specifies the LDAP server to which modify/add/delete requests should + be sent. If not defined, idmap_ldap will assume that ldap://localhost/ + should be used. + </p></dd><dt><span class="term">range = low - high</span></dt><dd><p> + Defines the available matching uid and gid range from which + winbindd can allocate for users and groups. If the parameter + is absent, Winbind fail over to use the "idmap uid" + and "idmap gid" options from smb.conf. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266718"></a><h2>EXAMPLES</h2><p> + The follow sets of a LDAP configuration which uses a slave server + running on localhost for fast fetching SID/gid/uid mappings, it + implies correct configuration of referrals. + The idmap alloc backend is pointed directly to the master to skip + the referral (and consequent reconnection to the master) that the + slave would return as allocation requires writing on the master. + </p><pre class="programlisting"> + [global] + idmap domains = ALLDOMAINS + idmap config ALLDOMAINS:default = yes + idmap config ALLDOMAINS:backend = ldap + idmap config ALLDOMAINS:ldap_base_dn = ou=idmap,dc=example,dc=com + idmap config ALLDOMAINS:ldap_url = ldap://localhost/ + idmap config ALLDOMAINS:range = 10000 - 50000 + + idmap alloc backend = ldap + idmap alloc config:ldap_base_dn = ou=idmap,dc=example,dc=com + idmap alloc config:ldap_url = ldap://master.example.com/ + idmap alloc config:range = 10000 - 50000 + </pre></div><div class="refsynopsisdiv"><h2>NOTE</h2><p>In order to use authentication against ldap servers you may + need to provide a DN and a password. To avoid exposing the password + in plain text in the configuration file we store it into a security + store. The "net idmap " command is used to store a secret + for the DN specified in a specific idmap domain. + </p></div><div class="refsect1" lang="en"><a name="id266753"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/idmap_nss.8.html b/docs/htmldocs/manpages/idmap_nss.8.html new file mode 100644 index 0000000000..b1aedf900b --- /dev/null +++ b/docs/htmldocs/manpages/idmap_nss.8.html @@ -0,0 +1,28 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>idmap_nss</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="idmap_nss.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>idmap_nss — Samba's idmap_nss Backend for Winbind</p></div><div class="refsynopsisdiv"><h2>DESCRIPTION</h2><p>The idmap_nss plugin provides a means to map Unix users and groups + to Windows accounts and obseletes the "winbind trusted domains only" + smb.conf option. This provides a simple means of ensuring that the SID + for a Unix user named jsmith is reported as the one assigned to + DOMAIN\jsmith which is necessary for reporting ACLs on files and printers + stored on a Samba member server. + </p></div><div class="refsect1" lang="en"><a name="id267675"></a><h2>EXAMPLES</h2><p> + This example shows how to use idmap_nss to check the local accounts for its + own domain while using allocation to create new mappings for trusted domains + </p><pre class="programlisting"> + [global] + idmap domains = SAMBA TRUSTEDDOMAINS + + idmap config SAMBA:backend = nss + idmap config SAMBA:readonly = yes + + idmap config TRUSTEDDOMAINS:default = yes + idmap config TRUSTEDDOMAINS:backend = tdb + idmap config TRUSTEDDOMAINS:range = 10000 - 50000 + + idmap alloc backend = tdb + idmap alloc config:range = 10000 - 50000 + </pre></div><div class="refsect1" lang="en"><a name="id267694"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/idmap_rid.8.html b/docs/htmldocs/manpages/idmap_rid.8.html new file mode 100644 index 0000000000..dbab83a449 --- /dev/null +++ b/docs/htmldocs/manpages/idmap_rid.8.html @@ -0,0 +1,32 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>idmap_rid</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="idmap_rid.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>idmap_rid — Samba's idmap_rid Backend for Winbind</p></div><div class="refsynopsisdiv"><h2>DESCRIPTION</h2><p>The idmap_rid backend provides a way to use an algorithmic + mapping scheme to map UIDs/GIDs and SIDs. No database is required + in this case as the mapping is deterministic.</p></div><div class="refsect1" lang="en"><a name="id267671"></a><h2>IDMAP OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">range = low - high</span></dt><dd><p> + Defines the available matching uid and gid range for which the + backend is authoritative. Note that the range acts as a filter. + If algorithmically determined UID or GID fall outside the + range, they are ignored and the corresponding map is discarded. + It is intended as a way to avoid accidental UID/GID overlaps + between local and remotely defined IDs. + </p></dd><dt><span class="term">base_rid = INTEGER</span></dt><dd><p> + Defines the base integer used to build SIDs out of an UID or a GID, + and to rebase the UID or GID to be obtained from a SID. User RIDs + by default start at 1000 (512 hexadecimal), this means a good value + for base_rid can be 1000 as the resulting ID is calculated this way: + ID = RID - BASE_RID + LOW RANGE ID. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299199"></a><h2>EXAMPLES</h2><p>This example shows how to configure 2 domains with idmap_rid</p><pre class="programlisting"> + [global] + idmap domains = MAIN TRUSTED1 + + idmap config MAIN:backend = rid + idmap config MAIN:base_rid = 0 + idmap config MAIN:range = 10000 - 49999 + + idmap config TRUSTED1:backend = rid + idmap config TRUSTED1:base_rid = 1000 + idmap config TRUSTED1:range = 50000 - 99999 + </pre></div><div class="refsect1" lang="en"><a name="id299217"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/idmap_tdb.8.html b/docs/htmldocs/manpages/idmap_tdb.8.html new file mode 100644 index 0000000000..6ab21584f9 --- /dev/null +++ b/docs/htmldocs/manpages/idmap_tdb.8.html @@ -0,0 +1,33 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>idmap_tdb</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="idmap_tdb.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>idmap_tdb — Samba's idmap_tdb Backend for Winbind</p></div><div class="refsynopsisdiv"><h2>DESCRIPTION</h2><p>The idmap_tdb plugin is the default backend used by winbindd + for storing SID/uid/gid mapping tables and implements + both the "idmap" and "idmap alloc" APIs. + </p></div><div class="refsect1" lang="en"><a name="id267671"></a><h2>IDMAP OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">range = low - high</span></dt><dd><p> + Defines the available matching uid and gid range for which the + backend is authoritative. Note that the range commonly matches + the allocation range due to the fact that the same backend will + store and retrieve SID/uid/gid mapping entries. If the parameter + is absent, Winbind fail over to use the "idmap uid" and + "idmap gid" options from smb.conf. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id267696"></a><h2>IDMAP ALLOC OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">range = low - high</span></dt><dd><p> + Defines the available matching uid and gid range from which + winbindd can allocate for users and groups. If the parameter + is absent, Winbind fail over to use the "idmap uid" + and "idmap gid" options from smb.conf. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299208"></a><h2>EXAMPLES</h2><p> + The following example is equivalent to the pre-3.0.25 default idmap + configuration using the "idmap backend = tdb" setting. + </p><pre class="programlisting"> + [global] + idmap domains = ALLDOMAINS + idmap config ALLDOMAINS:default = yes + idmap config ALLDOMAINS:backend = tdb + idmap config ALLDOMAINS:range = 10000 - 50000 + + idmap alloc backend = tdb + idmap alloc config:range = 10000 - 50000 + </pre></div><div class="refsect1" lang="en"><a name="id299226"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/index.html b/docs/htmldocs/manpages/index.html new file mode 100644 index 0000000000..ca031be3eb --- /dev/null +++ b/docs/htmldocs/manpages/index.html @@ -0,0 +1,84 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><hr></div><div class="variablelist"><dl><dt><span class="term"><a href="eventlogadm.8.html" target="_top">eventlogadm(8)</a></span></dt><dd><p>push records into the Samba event log store +</p></dd><dt><span class="term"><a href="findsmb.1.html" target="_top">findsmb(1)</a></span></dt><dd><p>list info about machines that respond to SMB + name queries on a subnet +</p></dd><dt><span class="term"><a href="idmap_ad.8.html" target="_top">idmap_ad(8)</a></span></dt><dd><p>Samba's idmap_ad Backend for Winbind +</p></dd><dt><span class="term"><a href="idmap_ldap.8.html" target="_top">idmap_ldap(8)</a></span></dt><dd><p>Samba's idmap_ldap Backend for Winbind +</p></dd><dt><span class="term"><a href="idmap_nss.8.html" target="_top">idmap_nss(8)</a></span></dt><dd><p>Samba's idmap_nss Backend for Winbind +</p></dd><dt><span class="term"><a href="idmap_rid.8.html" target="_top">idmap_rid(8)</a></span></dt><dd><p>Samba's idmap_rid Backend for Winbind +</p></dd><dt><span class="term"><a href="idmap_tdb.8.html" target="_top">idmap_tdb(8)</a></span></dt><dd><p>Samba's idmap_tdb Backend for Winbind +</p></dd><dt><span class="term"><a href="ldb.3.html" target="_top">ldb(3)</a></span></dt><dd><p>A light-weight database library +</p></dd><dt><span class="term"><a href="ldbadd.1.html" target="_top">ldbadd(1)</a></span></dt><dd><p>Command-line utility for adding records to an LDB +</p></dd><dt><span class="term"><a href="ldbdel.1.html" target="_top">ldbdel(1)</a></span></dt><dd><p>Command-line program for deleting LDB records +</p></dd><dt><span class="term"><a href="ldbedit.1.html" target="_top">ldbedit(1)</a></span></dt><dd><p>Edit LDB databases using your preferred editor +</p></dd><dt><span class="term"><a href="ldbmodify.1.html" target="_top">ldbmodify(1)</a></span></dt><dd><p>Modify records in a LDB database +</p></dd><dt><span class="term"><a href="ldbsearch.1.html" target="_top">ldbsearch(1)</a></span></dt><dd><p>Search for records in a LDB database +</p></dd><dt><span class="term"><a href="libsmbclient.7.html" target="_top">libsmbclient(7)</a></span></dt><dd><p>An extension library for browsers and that can be used as a generic browsing API. +</p></dd><dt><span class="term"><a href="lmhosts.5.html" target="_top">lmhosts(5)</a></span></dt><dd><p>The Samba NetBIOS hosts file +</p></dd><dt><span class="term"><a href="log2pcap.1.html" target="_top">log2pcap(1)</a></span></dt><dd><p>Extract network traces from Samba log files +</p></dd><dt><span class="term"><a href="mount.cifs.8.html" target="_top">mount.cifs(8)</a></span></dt><dd><p>mount using the Common Internet File System (CIFS) +</p></dd><dt><span class="term"><a href="net.8.html" target="_top">net(8)</a></span></dt><dd><p>Tool for administration of Samba and remote + CIFS servers. + +</p></dd><dt><span class="term"><a href="nmbd.8.html" target="_top">nmbd(8)</a></span></dt><dd><p>NetBIOS name server to provide NetBIOS + over IP naming services to clients +</p></dd><dt><span class="term"><a href="nmblookup.1.html" target="_top">nmblookup(1)</a></span></dt><dd><p>NetBIOS over TCP/IP client used to lookup NetBIOS + names +</p></dd><dt><span class="term"><a href="ntlm_auth.1.html" target="_top">ntlm_auth(1)</a></span></dt><dd><p>tool to allow external access to Winbind's NTLM authentication function +</p></dd><dt><span class="term"><a href="pam_winbind.7.html" target="_top">pam_winbind(7)</a></span></dt><dd><p>PAM module for Winbind +</p></dd><dt><span class="term"><a href="pdbedit.8.html" target="_top">pdbedit(8)</a></span></dt><dd><p>manage the SAM database (Database of Samba Users) +</p></dd><dt><span class="term"><a href="profiles.1.html" target="_top">profiles(1)</a></span></dt><dd><p>A utility to report and change SIDs in registry files + +</p></dd><dt><span class="term"><a href="rpcclient.1.html" target="_top">rpcclient(1)</a></span></dt><dd><p>tool for executing client side + MS-RPC functions +</p></dd><dt><span class="term"><a href="samba.7.html" target="_top">samba(7)</a></span></dt><dd><p>A Windows SMB/CIFS fileserver for UNIX +</p></dd><dt><span class="term"><a href="smb.conf.5.html" target="_top">smb.conf(5)</a></span></dt><dd><p>The configuration file for the Samba suite +</p></dd><dt><span class="term"><a href="smbcacls.1.html" target="_top">smbcacls(1)</a></span></dt><dd><p>Set or get ACLs on an NT file or directory names +</p></dd><dt><span class="term"><a href="smbclient.1.html" target="_top">smbclient(1)</a></span></dt><dd><p>ftp-like client to access SMB/CIFS resources + on servers +</p></dd><dt><span class="term"><a href="smbcontrol.1.html" target="_top">smbcontrol(1)</a></span></dt><dd><p>send messages to smbd, nmbd or winbindd processes +</p></dd><dt><span class="term"><a href="smbcquotas.1.html" target="_top">smbcquotas(1)</a></span></dt><dd><p>Set or get QUOTAs of NTFS 5 shares +</p></dd><dt><span class="term"><a href="smbd.8.html" target="_top">smbd(8)</a></span></dt><dd><p>server to provide SMB/CIFS services to clients +</p></dd><dt><span class="term"><a href="smbget.1.html" target="_top">smbget(1)</a></span></dt><dd><p>wget-like utility for download files over SMB +</p></dd><dt><span class="term"><a href="smbgetrc.5.html" target="_top">smbgetrc(5)</a></span></dt><dd><p>configuration file for smbget +</p></dd><dt><span class="term"><a href="smbmnt.8.html" target="_top">smbmnt(8)</a></span></dt><dd><p>helper utility for mounting SMB filesystems +</p></dd><dt><span class="term"><a href="smbmount.8.html" target="_top">smbmount(8)</a></span></dt><dd><p>mount an smbfs filesystem +</p></dd><dt><span class="term"><a href="smbpasswd.5.html" target="_top">smbpasswd(5)</a></span></dt><dd><p>The Samba encrypted password file +</p></dd><dt><span class="term"><a href="smbpasswd.8.html" target="_top">smbpasswd(8)</a></span></dt><dd><p>change a user's SMB password +</p></dd><dt><span class="term"><a href="smbsh.1.html" target="_top">smbsh(1)</a></span></dt><dd><p>Allows access to remote SMB shares + using UNIX commands +</p></dd><dt><span class="term"><a href="smbspool.8.html" target="_top">smbspool(8)</a></span></dt><dd><p>send a print file to an SMB printer +</p></dd><dt><span class="term"><a href="smbstatus.1.html" target="_top">smbstatus(1)</a></span></dt><dd><p>report on current Samba connections +</p></dd><dt><span class="term"><a href="smbtar.1.html" target="_top">smbtar(1)</a></span></dt><dd><p>shell script for backing up SMB/CIFS shares + directly to UNIX tape drives +</p></dd><dt><span class="term"><a href="smbtree.1.html" target="_top">smbtree(1)</a></span></dt><dd><p>A text based smb network browser + +</p></dd><dt><span class="term"><a href="smbumount.8.html" target="_top">smbumount(8)</a></span></dt><dd><p>smbfs umount for normal users +</p></dd><dt><span class="term"><a href="swat.8.html" target="_top">swat(8)</a></span></dt><dd><p>Samba Web Administration Tool +</p></dd><dt><span class="term"><a href="tdbbackup.8.html" target="_top">tdbbackup(8)</a></span></dt><dd><p>tool for backing up and for validating the integrity of samba .tdb files +</p></dd><dt><span class="term"><a href="tdbdump.8.html" target="_top">tdbdump(8)</a></span></dt><dd><p>tool for printing the contents of a TDB file +</p></dd><dt><span class="term"><a href="tdbtool.8.html" target="_top">tdbtool(8)</a></span></dt><dd><p>manipulate the contents TDB files +</p></dd><dt><span class="term"><a href="testparm.1.html" target="_top">testparm(1)</a></span></dt><dd><p>check an smb.conf configuration file for + internal correctness +</p></dd><dt><span class="term"><a href="umount.cifs.8.html" target="_top">umount.cifs(8)</a></span></dt><dd><p>for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts +</p></dd><dt><span class="term"><a href="vfs_audit.8.html" target="_top">vfs_audit(8)</a></span></dt><dd><p>record selected Samba VFS operations in the system log +</p></dd><dt><span class="term"><a href="vfs_cacheprime.8.html" target="_top">vfs_cacheprime(8)</a></span></dt><dd><p>prime the kernel file data cache +</p></dd><dt><span class="term"><a href="vfs_cap.8.html" target="_top">vfs_cap(8)</a></span></dt><dd><p>CAP encode filenames +</p></dd><dt><span class="term"><a href="vfs_catia.8.html" target="_top">vfs_catia(8)</a></span></dt><dd><p>translate illegal characters in Catia filenames +</p></dd><dt><span class="term"><a href="vfs_commit.8.html" target="_top">vfs_commit(8)</a></span></dt><dd><p>flush dirty data at specified intervals +</p></dd><dt><span class="term"><a href="vfs_default_quota.8.html" target="_top">vfs_default_quota(8)</a></span></dt><dd><p>store default quota records for Windows clients +</p></dd><dt><span class="term"><a href="vfs_extd_audit.8.html" target="_top">vfs_extd_audit(8)</a></span></dt><dd><p>record selected Samba VFS operations +</p></dd><dt><span class="term"><a href="vfs_fake_perms.8.html" target="_top">vfs_fake_perms(8)</a></span></dt><dd><p>enable read only Roaming Profiles +</p></dd><dt><span class="term"><a href="vfs_full_audit.8.html" target="_top">vfs_full_audit(8)</a></span></dt><dd><p>record Samba VFS operations in the system log +</p></dd><dt><span class="term"><a href="vfs_gpfs.8.html" target="_top">vfs_gpfs(8)</a></span></dt><dd><p>gpfs specific samba extensions like acls and prealloc +</p></dd><dt><span class="term"><a href="vfs_netatalk.8.html" target="_top">vfs_netatalk(8)</a></span></dt><dd><p>hide .AppleDouble files from CIFS clients +</p></dd><dt><span class="term"><a href="vfs_notify_fam.8.html" target="_top">vfs_notify_fam(8)</a></span></dt><dd><p>FAM support for file change notifications +</p></dd><dt><span class="term"><a href="vfs_prealloc.8.html" target="_top">vfs_prealloc(8)</a></span></dt><dd><p>preallocate matching files to a predetermined size +</p></dd><dt><span class="term"><a href="vfs_readahead.8.html" target="_top">vfs_readahead(8)</a></span></dt><dd><p>pre-load the kernel buffer cache +</p></dd><dt><span class="term"><a href="vfs_readonly.8.html" target="_top">vfs_readonly(8)</a></span></dt><dd><p>make a Samba share read only for a specified time period +</p></dd><dt><span class="term"><a href="vfs_recycle.8.html" target="_top">vfs_recycle(8)</a></span></dt><dd><p>Samba VFS recycle bin +</p></dd><dt><span class="term"><a href="vfs_shadow_copy.8.html" target="_top">vfs_shadow_copy(8)</a></span></dt><dd><p>Make a Samba share read only for a specified time period +</p></dd><dt><span class="term"><a href="vfstest.1.html" target="_top">vfstest(1)</a></span></dt><dd><p>tool for testing samba VFS modules +</p></dd><dt><span class="term"><a href="wbinfo.1.html" target="_top">wbinfo(1)</a></span></dt><dd><p>Query information from winbind daemon +</p></dd><dt><span class="term"><a href="winbindd.8.html" target="_top">winbindd(8)</a></span></dt><dd><p>Name Service Switch daemon for resolving names + from NT servers +</p></dd></dl></div></div></body></html> diff --git a/docs/htmldocs/manpages/ldb.3.html b/docs/htmldocs/manpages/ldb.3.html new file mode 100644 index 0000000000..dbf44dd31e --- /dev/null +++ b/docs/htmldocs/manpages/ldb.3.html @@ -0,0 +1,137 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ldb</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ldb.3"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ldb<p><b>The Samba Project</b></p> — A light-weight database library</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">#include <ldb.h></pre></div><div class="refsect1" lang="en"><a name="id267383"></a><h2>description</h2><p> +ldb is a light weight embedded database library and API. With a +programming interface that is very similar to LDAP, ldb can store its +data either in a tdb(3) database or in a real LDAP database. + </p><p> +When used with the tdb backend ldb does not require any database +daemon. Instead, ldb function calls are processed immediately by the +ldb library, which does IO directly on the database, while allowing +multiple readers/writers using operating system byte range locks. This +leads to an API with very low overheads, often resulting in speeds of +more than 10x what can be achieved with a more traditional LDAP +architecture. + </p><p> +In a taxonomy of databases ldb would sit half way between key/value +pair databases (such as berkley db or tdb) and a full LDAP +database. With a structured attribute oriented API like LDAP and good +indexing capabilities, ldb can be used for quite sophisticated +applications that need a light weight database, without the +administrative overhead of a full LDAP installation. + </p><p> +Included with ldb are a number of useful command line tools for +manipulating a ldb database. These tools are similar in style to the +equivalent ldap command line tools. + </p><p> +In its default mode of operation with a tdb backend, ldb can also be +seen as a "schema-less LDAP". By default ldb does not require a +schema, which greatly reduces the complexity of getting started with +ldb databases. As the complexity of you application grows you can take +advantage of some of the optional schema-like attributes that ldb +offers, or you can migrate to using the full LDAP api while keeping +your exiting ldb code. + </p><p> +If you are new to ldb, then I suggest starting with the manual pages +for ldbsearch(1) and ldbedit(1), and experimenting with a local +database. Then I suggest you look at the ldb_connect(3) and +ldb_search(3) manual pages. + </p></div><div class="refsect1" lang="en"><a name="id267706"></a><h2>TOOLS</h2><div class="itemizedlist"><ul type="disc"><li><p> + <span class="application">ldbsearch(1)</span> + - command line ldb search utility + </p></li><li><p> + <span class="application">ldbedit(1)</span> + - edit all or part of a ldb database using your favourite editor + </p></li><li><p> + <span class="application">ldbadd(1)</span> + - add records to a ldb database using LDIF formatted input + </p></li><li><p> + <span class="application">ldbdel(1)</span> + - delete records from a ldb database + </p></li><li><p> + <span class="application">ldbmodify(1)</span> + - modify records in a ldb database using LDIF formatted input + </p></li></ul></div></div><div class="refsect1" lang="en"><a name="id267087"></a><h2>FUNCTIONS</h2><div class="itemizedlist"><ul type="disc"><li><p> + <code class="function">ldb_connect(3)</code> + - connect to a ldb backend + </p></li><li><p> + <code class="function">ldb_search(3)</code> + - perform a database search + </p></li><li><p> + <code class="function">ldb_add(3)</code> + - add a record to the database + </p></li><li><p> + <code class="function">ldb_delete(3)</code> + - delete a record from the database + </p></li><li><p> + <code class="function">ldb_modify(3)</code> + - modify a record in the database + </p></li><li><p> + <code class="function">ldb_errstring(3)</code> + - retrieve extended error information from the last operation + </p></li><li><p> + <code class="function">ldb_ldif_write(3)</code> + - write a LDIF formatted message + </p></li><li><p> + <code class="function">ldb_ldif_write_file(3)</code> + - write a LDIF formatted message to a file + </p></li><li><p> + <code class="function">ldb_ldif_read(3)</code> + - read a LDIF formatted message + </p></li><li><p> + <code class="function">ldb_ldif_read_free(3)</code> + - free the result of a ldb_ldif_read() + </p></li><li><p> + <code class="function">ldb_ldif_read_file(3)</code> + - read a LDIF message from a file + </p></li><li><p> + <code class="function">ldb_ldif_read_string(3)</code> + - read a LDIF message from a string + </p></li><li><p> + <code class="function">ldb_msg_find_element(3)</code> + - find an element in a ldb_message + </p></li><li><p> + <code class="function">ldb_val_equal_exact(3)</code> + - compare two ldb_val structures + </p></li><li><p> + <code class="function">ldb_msg_find_val(3)</code> + - find an element by value + </p></li><li><p> + <code class="function">ldb_msg_add_empty(3)</code> + - add an empty message element to a ldb_message + </p></li><li><p> + <code class="function">ldb_msg_add(3)</code> + - add a non-empty message element to a ldb_message + </p></li><li><p> + <code class="function">ldb_msg_element_compare(3)</code> + - compare two ldb_message_element structures + </p></li><li><p> + <code class="function">ldb_msg_find_int(3)</code> + - return an integer value from a ldb_message + </p></li><li><p> + <code class="function">ldb_msg_find_uint(3)</code> + - return an unsigned integer value from a ldb_message + </p></li><li><p> + <code class="function">ldb_msg_find_double(3)</code> + - return a double value from a ldb_message + </p></li><li><p> + <code class="function">ldb_msg_find_string(3)</code> + - return a string value from a ldb_message + </p></li><li><p> + <code class="function">ldb_set_alloc(3)</code> + - set the memory allocation function to be used by ldb + </p></li><li><p> + <code class="function">ldb_set_debug(3)</code> + - set a debug handler to be used by ldb + </p></li><li><p> + <code class="function">ldb_set_debug_stderr(3)</code> + - set a debug handler for stderr output + </p></li></ul></div></div><div class="refsect1" lang="en"><a name="id266894"></a><h2>Author</h2><p> + ldb was written by + <a href="http://samba.org/~tridge/" target="_top">Andrew Tridgell</a>. + </p><p> +If you wish to report a problem or make a suggestion then please see +the <a href="http://ldb.samba.org/" target="_top">http://ldb.samba.org/</a> web site for +current contact and maintainer information. + </p><p> +ldb is released under the GNU Lesser General Public License version 2 +or later. Please see the file COPYING for license details. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/ldbadd.1.html b/docs/htmldocs/manpages/ldbadd.1.html new file mode 100644 index 0000000000..d2b1b7f7be --- /dev/null +++ b/docs/htmldocs/manpages/ldbadd.1.html @@ -0,0 +1,16 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ldbadd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ldbadd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ldbadd — Command-line utility for adding records to an LDB</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">ldbadd</code> [-h] [-H LDB-URL] [ldif-file1] [ldif-file2] [...]</p></div></div><div class="refsect1" lang="en"><a name="id299200"></a><h2>DESCRIPTION</h2><p>ldbadd adds records to an ldb(7) database. It reads + the ldif(5) files specified on the command line and adds + the records from these files to the LDB database, which is specified + by the -H option or the LDB_URL environment variable. + </p><p>If - is specified as a ldb file, the ldif input is read from + standard input.</p></div><div class="refsect1" lang="en"><a name="id299215"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h</span></dt><dd><p> + Show list of available options.</p></dd><dt><span class="term">-H <ldb-url></span></dt><dd><p> + LDB URL to connect to. See ldb(7) for details. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299247"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term">LDB_URL</span></dt><dd><p>LDB URL to connect to (can be overrided by using the + -H command-line option.)</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299267"></a><h2>VERSION</h2><p>This man page is correct for version 4.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266712"></a><h2>SEE ALSO</h2><p>ldb(7), ldbmodify, ldbdel, ldif(5)</p></div><div class="refsect1" lang="en"><a name="id266722"></a><h2>AUTHOR</h2><p> ldb was written by + <a href="http://samba.org/~tridge/" target="_top">Andrew Tridgell</a>. + </p><p> +If you wish to report a problem or make a suggestion then please see +the <a href="http://ldb.samba.org/" target="_top">http://ldb.samba.org/</a> web site for +current contact and maintainer information. + </p><p>This manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/ldbdel.1.html b/docs/htmldocs/manpages/ldbdel.1.html new file mode 100644 index 0000000000..5d9b9165ea --- /dev/null +++ b/docs/htmldocs/manpages/ldbdel.1.html @@ -0,0 +1,15 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ldbdel</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ldbdel.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ldbdel — Command-line program for deleting LDB records</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">ldbdel</code> [-h] [-H LDB-URL] [dn] [...]</p></div></div><div class="refsect1" lang="en"><a name="id267702"></a><h2>DESCRIPTION</h2><p>ldbdel deletes records from an ldb(7) database. + It deletes the records identified by the dn's specified + on the command-line. </p><p>ldbdel uses either the database that is specified with + the -H option or the database specified by the LDB_URL environment + variable.</p></div><div class="refsect1" lang="en"><a name="id299208"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h</span></dt><dd><p> + Show list of available options.</p></dd><dt><span class="term">-H <ldb-url></span></dt><dd><p> + LDB URL to connect to. See ldb(7) for details. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299240"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term">LDB_URL</span></dt><dd><p>LDB URL to connect to (can be overrided by using the + -H command-line option.)</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299259"></a><h2>VERSION</h2><p>This man page is correct for version 4.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id299270"></a><h2>SEE ALSO</h2><p>ldb(7), ldbmodify, ldbadd, ldif(5)</p></div><div class="refsect1" lang="en"><a name="id266716"></a><h2>AUTHOR</h2><p> ldb was written by + <a href="http://samba.org/~tridge/" target="_top">Andrew Tridgell</a>. + </p><p> +If you wish to report a problem or make a suggestion then please see +the <a href="http://ldb.samba.org/" target="_top">http://ldb.samba.org/</a> web site for +current contact and maintainer information. + </p><p>ldbdel was written by Andrew Tridgell.</p><p>This manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/ldbedit.1.html b/docs/htmldocs/manpages/ldbedit.1.html new file mode 100644 index 0000000000..eda5125f48 --- /dev/null +++ b/docs/htmldocs/manpages/ldbedit.1.html @@ -0,0 +1,54 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ldbedit</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ldbedit.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ldbedit — Edit LDB databases using your preferred editor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">ldbedit</code> [-?] [--usage] [-s base|one|sub] [-b basedn] [-a] [-e editor] [-H LDB-URL] [expression] [attributes...]</p></div></div><div class="refsect1" lang="en"><a name="id299231"></a><h2>DESCRIPTION</h2><p>ldbedit is a utility that allows you to edit LDB entries (in + tdb files, sqlite files or LDAP servers) using your preferred editor. + ldbedit generates an LDIF file based on your query, allows you to edit + the LDIF, and then merges that LDIF back into the LDB backend. + </p></div><div class="refsect1" lang="en"><a name="id299243"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-?, </span><span class="term">--help</span></dt><dd><p> + Show list of available options, and a phrase describing what that option + does. + </p></dd><dt><span class="term">--usage</span></dt><dd><p> + Show list of available options. This is similar to the help option, + however it does not provide any description, and is hence shorter. + </p></dd><dt><span class="term">-H <ldb-url></span></dt><dd><p> + LDB URL to connect to. For a tdb database, + this will be of the form + tdb://<em class="replaceable"><code>filename</code></em>. + For a LDAP connection over unix domain + sockets, this will be of the form + ldapi://<em class="replaceable"><code>socket</code></em>. For + a (potentially remote) LDAP connection over + TCP, this will be of the form + ldap://<em class="replaceable"><code>hostname</code></em>. For + an SQLite database, this will be of the form + sqlite://<em class="replaceable"><code>filename</code></em>. + </p></dd><dt><span class="term">-s one|sub|base</span></dt><dd><p>Search scope to use. One-level, subtree or base.</p></dd><dt><span class="term">-a, </span><span class="term">-all</span></dt><dd><p>Edit all records. This allows you to + apply the same change to a number of records + at once. You probably want to combine this + with an expression of the form + "objectclass=*". + </p></dd><dt><span class="term">-e editor, </span><span class="term">--editor editor</span></dt><dd><p>Specify the editor that should be used (overrides + the VISUAL and EDITOR environment + variables). If this option is not used, and + neither VISUAL nor EDITOR environment variables + are set, then the vi editor will be used. + </p></dd><dt><span class="term">-b basedn</span></dt><dd><p>Specify Base Distinguished Name to use.</p></dd><dt><span class="term">-v, </span><span class="term">--verbose</span></dt><dd><p>Make ldbedit more verbose about the + operations that are being performed. Without + this option, ldbedit will only provide a + summary change line. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266826"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term">LDB_URL</span></dt><dd><p>LDB URL to connect to. This can be + overridden by using the -H command-line option.) + </p></dd><dt><span class="term">VISUAL and EDITOR</span></dt><dd><p> + Environment variables used to determine what + editor to use. VISUAL takes precedence over + EDITOR, and both are overridden by the + -e command-line option. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266886"></a><h2>VERSION</h2><p>This man page is correct for version 4.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266896"></a><h2>SEE ALSO</h2><p>ldb(7), ldbmodify(1), ldbdel(1), ldif(5), vi(1)</p></div><div class="refsect1" lang="en"><a name="id266906"></a><h2>AUTHOR</h2><p> + ldb was written by + <a href="http://samba.org/~tridge/" target="_top">Andrew Tridgell</a>. + </p><p> + If you wish to report a problem or make a suggestion then please see + the <a href="http://ldb.samba.org/" target="_top">http://ldb.samba.org/</a> web site for + current contact and maintainer information. + </p><p> + This manpage was written by Jelmer Vernooij and updated + by Brad Hards. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/ldbmodify.1.html b/docs/htmldocs/manpages/ldbmodify.1.html new file mode 100644 index 0000000000..7f079f0942 --- /dev/null +++ b/docs/htmldocs/manpages/ldbmodify.1.html @@ -0,0 +1,14 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ldbmodify</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ldbmodify.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ldbmodify — Modify records in a LDB database</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">ldbmodify</code> [-H LDB-URL] [ldif-file]</p></div></div><div class="refsect1" lang="en"><a name="id267687"></a><h2>DESCRIPTION</h2><p> + ldbmodify changes, adds and deletes records in a LDB database. + The changes that should be made to the LDB database are read from + the specified LDIF-file. If - is specified as the filename, input is read from stdin. + </p><p>For now, see ldapmodify(1) for details on the LDIF file format.</p></div><div class="refsect1" lang="en"><a name="id267703"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-H <ldb-url></span></dt><dd><p> + LDB URL to connect to. See ldb(7) for details. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299214"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term">LDB_URL</span></dt><dd><p>LDB URL to connect to (can be overrided by using the + -H command-line option.)</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299234"></a><h2>VERSION</h2><p>This man page is correct for version 4.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id299245"></a><h2>SEE ALSO</h2><p>ldb(7), ldbedit</p></div><div class="refsect1" lang="en"><a name="id299255"></a><h2>AUTHOR</h2><p> ldb was written by + <a href="http://samba.org/~tridge/" target="_top">Andrew Tridgell</a>. + </p><p> +If you wish to report a problem or make a suggestion then please see +the <a href="http://ldb.samba.org/" target="_top">http://ldb.samba.org/</a> web site for +current contact and maintainer information. + </p><p>This manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/ldbsearch.1.html b/docs/htmldocs/manpages/ldbsearch.1.html new file mode 100644 index 0000000000..3a4969b9a0 --- /dev/null +++ b/docs/htmldocs/manpages/ldbsearch.1.html @@ -0,0 +1,15 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ldbsearch</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ldbsearch.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ldbsearch — Search for records in a LDB database</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">ldbsearch</code> [-h] [-s base|one|sub] [-b basedn] [-i] [-H LDB-URL] [expression] [attributes]</p></div></div><div class="refsect1" lang="en"><a name="id299218"></a><h2>DESCRIPTION</h2><p>ldbsearch searches a LDB database for records matching the + specified expression (see the ldapsearch(1) manpage for + a description of the expression format). For each + record, the specified attributes are printed. + </p></div><div class="refsect1" lang="en"><a name="id299230"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h</span></dt><dd><p> + Show list of available options.</p></dd><dt><span class="term">-H <ldb-url></span></dt><dd><p> + LDB URL to connect to. See ldb(7) for details. + </p></dd><dt><span class="term">-s one|sub|base</span></dt><dd><p>Search scope to use. One-level, subtree or base.</p></dd><dt><span class="term">-i</span></dt><dd><p>Read search expressions from stdin. </p></dd><dt><span class="term">-b basedn</span></dt><dd><p>Specify Base DN to use.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266729"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term">LDB_URL</span></dt><dd><p>LDB URL to connect to (can be overrided by using the + -H command-line option.)</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266749"></a><h2>VERSION</h2><p>This man page is correct for version 4.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266760"></a><h2>SEE ALSO</h2><p>ldb(7), ldbedit(1)</p></div><div class="refsect1" lang="en"><a name="id266770"></a><h2>AUTHOR</h2><p> ldb was written by + <a href="http://samba.org/~tridge/" target="_top">Andrew Tridgell</a>. + </p><p> +If you wish to report a problem or make a suggestion then please see +the <a href="http://ldb.samba.org/" target="_top">http://ldb.samba.org/</a> web site for +current contact and maintainer information. + </p><p>This manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/libsmbclient.7.html b/docs/htmldocs/manpages/libsmbclient.7.html new file mode 100644 index 0000000000..703bdf7eb7 --- /dev/null +++ b/docs/htmldocs/manpages/libsmbclient.7.html @@ -0,0 +1,57 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>libsmbclient</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="libsmbclient.7"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>libsmbclient — An extension library for browsers and that can be used as a generic browsing API.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">Browser URL:</code><p> + smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options] + </p></p></div></div><div class="refsect1" lang="en"><a name="id267676"></a><h2>DESCRIPTION</h2><p> + This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite. + </p><p> + <code class="literal">libsmbclient</code> is a library toolset that permits applications to manipulate CIFS/SMB network + resources using many of the standards POSIX functions available for manipulating local UNIX/Linux files. It + permits much more than just browsing, files can be opened and read or written, permissions changed, file times + modified, attributes and ACL's can be manipulated, and so on. Of course, its functionality includes all the + capabilities commonly called browsing. + </p><p> + <code class="literal">libsmbclient</code> can not be used directly from the command line, instead it provides an + extension of the capabilities of tools such as file managers and browsers. This man page describes the + configuration options for this tool so that the user may obtain greatest utility of use. + </p></div><div class="refsect1" lang="en"><a name="id299208"></a><h2>OPTIONS</h2><p> + What the URLs mean: + </p><div class="variablelist"><dl><dt><span class="term">smb://</span></dt><dd><p> + Shows all workgroups or domains that are visible in the network. The behavior matches + that of the Microsoft Windows Explorer. + </p><p> + The method of locating the list of workgroups (domains also) varies depending on the setting of + the context variable <code class="literal">(context->options.browse_max_lmb_count)</code>. It is the + responsibility of the application that calls this library to set this to a sensible value. This + is a compile-time option. This value determines the maximum number of local master browsers to + query for the list of workgroups. In order to ensure that the list is complete for those present + on the network, all master browsers must be querried. If there are a large number of workgroups + on the network, the time spent querying will be significant. For small networks (just a few + workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local + master browsers. In an environment that has many workgroups a more reasonable setting may be around 3. + </p></dd><dt><span class="term">smb://name/</span></dt><dd><p> + This command causes libsmbclient to perform a name look-up. If the NAME<1D> or + NAME<1B> exists (workgroup name), libsmbclient will list all servers in the + workgroup (or domain). Otherwise, a name look-up for the NAME<20> (machine name) + will be performed, and the list of shared resources on the server will be displayed. + </p></dd></dl></div><p> + When libsmbclient is invoked by an application it searches for a directory called + <code class="filename">.smb</code> in the $HOME directory that is specified in the users shell + environment. It then searches for a file called <code class="filename">smb.conf</code> which, + if present, will fully over-ride the system <code class="filename">/etc/samba/smb.conf</code> file. If + instead libsmbclient finds a file called <code class="filename">~/.smb/smb.conf.append</code>, + it will read the system <code class="filename">/etc/samba/smb.conf</code> and then append the + contents of the <code class="filename">~/.smb/smb.conf.append</code> to it. + </p><p> + <code class="literal">libsmbclient</code> will check the users shell environment for the <code class="literal">USER</code> + parameter and will use its value when if the <code class="literal">user</code> parameter was not included + in the URL. + </p></div><div class="refsect1" lang="en"><a name="id266763"></a><h2>PROGRAMMERS GUIDE</h2><p> + Watch this space for future updates. + </p></div><div class="refsect1" lang="en"><a name="id266773"></a><h2>VERSION</h2><p> + This man page is correct for version 3.0 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266784"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities were created by Andrew Tridgell. + Samba is now developed by the Samba Team as an Open Source project similar to the way + the Linux kernel is developed. + </p><p> + The libsmbclient manpage page was written by John H Terpstra. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/lmhosts.5.html b/docs/htmldocs/manpages/lmhosts.5.html new file mode 100644 index 0000000000..8915e7d3d8 --- /dev/null +++ b/docs/htmldocs/manpages/lmhosts.5.html @@ -0,0 +1,41 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>lmhosts</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="lmhosts.5"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>lmhosts — The Samba NetBIOS hosts file</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename">lmhosts</code> is the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> NetBIOS name to IP address mapping file.</p></div><div class="refsect1" lang="en"><a name="id267678"></a><h2>DESCRIPTION</h2><p>This file is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="filename">lmhosts</code> is the <span class="emphasis"><em>Samba + </em></span> NetBIOS name to IP address mapping file. It + is very similar to the <code class="filename">/etc/hosts</code> file + format, except that the hostname component must correspond + to the NetBIOS naming format.</p></div><div class="refsect1" lang="en"><a name="id299203"></a><h2>FILE FORMAT</h2><p>It is an ASCII file containing one line for NetBIOS name. + The two fields on each line are separated from each other by + white space. Any entry beginning with '#' is ignored. Each line + in the lmhosts file contains the following information:</p><div class="itemizedlist"><ul type="disc"><li><p>IP Address - in dotted decimal format.</p></li><li><p>NetBIOS Name - This name format is a + maximum fifteen character host name, with an optional + trailing '#' character followed by the NetBIOS name type + as two hexadecimal digits.</p><p>If the trailing '#' is omitted then the given IP + address will be returned for all names that match the given + name, whatever the NetBIOS name type in the lookup.</p></li></ul></div><p>An example follows: +</p><pre class="programlisting"> +# +# Sample Samba lmhosts file. +# +192.9.200.1 TESTPC +192.9.200.20 NTSERVER#20 +192.9.200.21 SAMBASERVER +</pre><p> + </p><p>Contains three IP to NetBIOS name mappings. The first + and third will be returned for any queries for the names "TESTPC" + and "SAMBASERVER" respectively, whatever the type component of + the NetBIOS name requested.</p><p>The second mapping will be returned only when the "0x20" name + type for a name "NTSERVER" is queried. Any other name type will not + be resolved.</p><p>The default location of the <code class="filename">lmhosts</code> file + is in the same directory as the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file.</p></div><div class="refsect1" lang="en"><a name="id299273"></a><h2>FILES</h2><p>lmhosts is loaded from the configuration directory. This is + usually <code class="filename">/etc/samba</code> or <code class="filename">/usr/local/samba/lib</code>. + </p></div><div class="refsect1" lang="en"><a name="id266730"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266740"></a><h2>SEE ALSO</h2><p><a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, and <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> + </p></div><div class="refsect1" lang="en"><a name="id266774"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at + <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/log2pcap.1.html b/docs/htmldocs/manpages/log2pcap.1.html new file mode 100644 index 0000000000..59de004aa8 --- /dev/null +++ b/docs/htmldocs/manpages/log2pcap.1.html @@ -0,0 +1,29 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>log2pcap</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="log2pcap.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>log2pcap — Extract network traces from Samba log files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">log2pcap</code> [-h] [-q] [logfile] [pcap_file]</p></div></div><div class="refsect1" lang="en"><a name="id267702"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">log2pcap</code> reads in a + samba log file and generates a pcap file (readable + by most sniffers, such as ethereal or tcpdump) based on the packet + dumps in the log file.</p><p>The log file must have a <em class="parameter"><code>log level</code></em> + of at least <code class="constant">5</code> to get the SMB header/parameters + right, <code class="constant">10</code> to get the first 512 data bytes of the + packet and <code class="constant">50</code> to get the whole packet. + </p></div><div class="refsect1" lang="en"><a name="id299240"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h</span></dt><dd><p>If this parameter is + specified the output file will be a + hex dump, in a format that is readable + by the <span class="application">text2pcap</span> utility.</p></dd><dt><span class="term">-q</span></dt><dd><p>Be quiet. No warning messages about missing + or incomplete data will be given.</p></dd><dt><span class="term">logfile</span></dt><dd><p> + Samba log file. log2pcap will try to read the log from stdin + if the log file is not specified. + </p></dd><dt><span class="term">pcap_file</span></dt><dd><p> + Name of the output file to write the pcap (or hexdump) data to. + If this argument is not specified, output data will be written + to stdout. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266749"></a><h2>EXAMPLES</h2><p>Extract all network traffic from all samba log files:</p><pre class="programlisting"> + <code class="prompt">$</code> log2pcap < /var/log/* > trace.pcap + </pre><p>Convert to pcap using text2pcap:</p><pre class="programlisting"> + <code class="prompt">$</code> log2pcap -h samba.log | text2pcap -T 139,139 - trace.pcap + </pre></div><div class="refsect1" lang="en"><a name="id266787"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266798"></a><h2>BUGS</h2><p>Only SMB data is extracted from the samba logs, no LDAP, + NetBIOS lookup or other data.</p><p>The generated TCP and IP headers don't contain a valid + checksum.</p></div><div class="refsect1" lang="en"><a name="id266813"></a><h2>SEE ALSO</h2><p><a href="text2pcap.1.html"><span class="citerefentry"><span class="refentrytitle">text2pcap</span>(1)</span></a>, <a href="ethereal.1.html"><span class="citerefentry"><span class="refentrytitle">ethereal</span>(1)</span></a></p></div><div class="refsect1" lang="en"><a name="id266835"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>This manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/mount.cifs.8.html b/docs/htmldocs/manpages/mount.cifs.8.html new file mode 100644 index 0000000000..b9498dfa5f --- /dev/null +++ b/docs/htmldocs/manpages/mount.cifs.8.html @@ -0,0 +1,206 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>mount.cifs</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="mount.cifs.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>mount.cifs — mount using the Common Internet File System (CIFS)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">mount.cifs</code> {service} {mount-point} [-o options]</p></div></div><div class="refsect1" lang="en"><a name="id267695"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>mount.cifs mounts a Linux CIFS filesystem. It +is usually invoked indirectly by +the <a href="mount.8.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> command when using the +"-t cifs" option. This command only works in Linux, and the kernel must +support the cifs filesystem. The CIFS protocol is the successor to the +SMB protocol and is supported by most Windows servers and many other +commercial servers and Network Attached Storage appliances as well as +by the popular Open Source server Samba. + </p><p> + The mount.cifs utility attaches the UNC name (exported network resource) to + the local directory <span class="emphasis"><em>mount-point</em></span>. It is possible to set the mode for mount.cifs to +setuid root to allow non-root users to mount shares to directories for which they +have write permission. + </p><p> + Options to <span class="emphasis"><em>mount.cifs</em></span> are specified as a comma-separated +list of key=value pairs. It is possible to send options other +than those listed here, assuming that the cifs filesystem kernel module (cifs.ko) supports them. +Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the +kernel log. + + </p><p><span class="emphasis"><em>mount.cifs</em></span> causes the cifs vfs to launch a thread named cifsd. After mounting it keeps running until + the mounted resource is unmounted (usually via the umount utility). + </p></div><div class="refsect1" lang="en"><a name="id299241"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">user=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>specifies the username to connect as. If + this is not given, then the environment variable <span class="emphasis"><em>USER</em></span> is used. This option can also take the +form "user%password" or "workgroup/user" or +"workgroup/user%password" to allow the password and workgroup +to be specified as part of the username. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + The cifs vfs accepts the parameter <em class="parameter"><code>user=</code></em>, or for users familiar with smbfs it accepts the longer form of the parameter <em class="parameter"><code>username=</code></em>. Similarly the longer smbfs style parameter names may be accepted as synonyms for the shorter cifs parameters <em class="parameter"><code>pass=</code></em>,<em class="parameter"><code>dom=</code></em> and <em class="parameter"><code>cred=</code></em>. + </p></div></dd><dt><span class="term">password=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>specifies the CIFS password. If this +option is not given then the environment variable +<span class="emphasis"><em>PASSWD</em></span> is used. If the password is not specified +directly or indirectly via an argument to mount <span class="emphasis"><em>mount.cifs</em></span> will prompt +for a password, unless the guest option is specified. +</p><p>Note that a password which contains the delimiter +character (i.e. a comma ',') will fail to be parsed correctly +on the command line. However, the same password defined +in the PASSWD environment variable or via a credentials file (see +below) or entered at the password prompt will be read correctly. +</p></dd><dt><span class="term">credentials=<em class="replaceable"><code>filename</code></em></span></dt><dd><p> + specifies a file that contains a username + and/or password. The format of the file is: + </p><pre class="programlisting"> + username=<em class="replaceable"><code>value</code></em> + password=<em class="replaceable"><code>value</code></em> +</pre><p> +This is preferred over having passwords in plaintext in a +shared file, such as <code class="filename">/etc/fstab</code>. Be sure to protect any +credentials file properly. + </p></dd><dt><span class="term">uid=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the uid that will own all files on + the mounted filesystem. + It may be specified as either a username or a numeric uid. + This parameter is ignored when the target server supports + the CIFS Unix extensions.</p></dd><dt><span class="term">gid=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the gid that will own all files on +the mounted filesystem. +It may be specified as either a groupname or a numeric +gid. This parameter is ignored when the target server supports +the CIFS Unix extensions. + </p></dd><dt><span class="term">port=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the port number on the server to attempt to contact to negotiate +CIFS support. If the CIFS server is not listening on this port or +if it is not specified, the default ports will be tried i.e. +port 445 is tried and if no response then port 139 is tried. + </p></dd><dt><span class="term">netbiosname=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>When mounting to servers via port 139, specifies the RFC1001 + source name to use to represent the client netbios machine + name when doing the RFC1001 netbios session initialize. + </p></dd><dt><span class="term">file_mode=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>If the server does not support the CIFS Unix extensions this + overrides the default file mode.</p></dd><dt><span class="term">dir_mode=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>If the server does not support the CIFS Unix extensions this + overrides the default mode for directories. </p></dd><dt><span class="term">ip=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the destination IP address.</p></dd><dt><span class="term">domain=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the domain (workgroup) of the user </p></dd><dt><span class="term">guest</span></dt><dd><p>don't prompt for a password </p></dd><dt><span class="term">iocharset</span></dt><dd><p>Charset used to convert local path names to and from + Unicode. Unicode is used by default for network path + names if the server supports it. If iocharset is + not specified then the nls_default specified + during the local client kernel build will be used. + If server does not support Unicode, this parameter is + unused. </p></dd><dt><span class="term">ro</span></dt><dd><p>mount read-only</p></dd><dt><span class="term">rw</span></dt><dd><p>mount read-write</p></dd><dt><span class="term">setuids</span></dt><dd><p>If the CIFS Unix extensions are negotiated with the server + the client will attempt to set the effective uid and gid of + the local process on newly created files, directories, and + devices (create, mkdir, mknod). If the CIFS Unix Extensions + are not negotiated, for newly created files and directories + instead of using the default uid and gid specified on the + the mount, cache the new file's uid and gid locally which means + that the uid for the file can change when the inode is + reloaded (or the user remounts the share).</p></dd><dt><span class="term">nosetuids</span></dt><dd><p>The client will not attempt to set the uid and gid on + on newly created files, directories, and devices (create, + mkdir, mknod) which will result in the server setting the + uid and gid to the default (usually the server uid of the + user who mounted the share). Letting the server (rather than + the client) set the uid and gid is the default.If the CIFS + Unix Extensions are not negotiated then the uid and gid for + new files will appear to be the uid (gid) of the mounter or the + uid (gid) parameter specified on the mount.</p></dd><dt><span class="term">perm</span></dt><dd><p>Client does permission checks (vfs_permission check of uid + and gid of the file against the mode and desired operation), + Note that this is in addition to the normal ACL check on the + target machine done by the server software. + Client permission checking is enabled by default.</p></dd><dt><span class="term">noperm</span></dt><dd><p>Client does not do permission checks. This can expose + files on this mount to access by other users on the local + client system. It is typically only needed when the server + supports the CIFS Unix Extensions but the UIDs/GIDs on the + client and server system do not match closely enough to allow + access by the user doing the mount. + Note that this does not affect the normal ACL check on the + target machine done by the server software (of the server + ACL against the user name provided at mount time).</p></dd><dt><span class="term">directio</span></dt><dd><p>Do not do inode data caching on files opened on this mount. + This precludes mmaping files on this mount. In some cases + with fast networks and little or no caching benefits on the + client (e.g. when the application is doing large sequential + reads bigger than page size without rereading the same data) + this can provide better performance than the default + behavior which caches reads (readahead) and writes + (writebehind) through the local Linux client pagecache + if oplock (caching token) is granted and held. Note that + direct allows write operations larger than page size + to be sent to the server. On some kernels this requires the cifs.ko module + to be built with the CIFS_EXPERIMENTAL configure option.</p></dd><dt><span class="term">mapchars</span></dt><dd><p>Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterik, greater than and less than characters) + to the remap range (above 0xF000), which also + allows the CIFS client to recognize files created with + such characters by Windows's POSIX emulation. This can + also be useful when mounting to most versions of Samba + (which also forbids creating and opening files + whose names contain any of these seven characters). + This has no effect if the server does not support + Unicode on the wire.</p></dd><dt><span class="term">nomapchars</span></dt><dd><p>Do not translate any of these seven characters (default)</p></dd><dt><span class="term">intr</span></dt><dd><p>currently unimplemented</p></dd><dt><span class="term">nointr</span></dt><dd><p>(default) currently unimplemented </p></dd><dt><span class="term">hard</span></dt><dd><p>The program accessing a file on the cifs mounted file system will hang when the + server crashes.</p></dd><dt><span class="term">soft</span></dt><dd><p>(default) The program accessing a file on the cifs mounted file system will not hang when the server crashes and will return errors to the user application.</p></dd><dt><span class="term">noacl</span></dt><dd><p>Do not allow POSIX ACL operations even if server would support them.</p><p> + The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers + version 3.10 and later. Setting POSIX ACLs requires enabling both XATTR and + then POSIX support in the CIFS configuration options when building the cifs + module. POSIX ACL support can be disabled on a per mount basic by specifying + "noacl" on mount.</p></dd><dt><span class="term">nocase</span></dt><dd><p>Request case insensitive path name matching (case + sensitive is the default if the server suports it). + </p></dd><dt><span class="term">sec=</span></dt><dd><p>Security mode. Allowed values are:</p><div class="itemizedlist"><ul type="disc"><li><p>none attempt to connection as a null user (no name) </p></li><li><p>krb5 Use Kerberos version 5 authentication</p></li><li><p>krb5i Use Kerberos authentication and packet signing</p></li><li><p>ntlm Use NTLM password hashing (default)</p></li><li><p>ntlmi Use NTLM password hashing with signing (if + /proc/fs/cifs/PacketSigningEnabled on or if + server requires signing also can be the default)</p></li><li><p>ntlmv2 Use NTLMv2 password hashing</p></li><li><p>ntlmv2i Use NTLMv2 password hashing with packet signing</p></li></ul></div><p>[NB This [sec parameter] is under development and expected to be available in cifs kernel module 1.40 and later] + </p></dd><dt><span class="term">nobrl</span></dt><dd><p>Do not send byte range lock requests to the server. + This is necessary for certain applications that break + with cifs style mandatory byte range locks (and most + cifs servers do not yet support requesting advisory + byte range locks). + </p></dd><dt><span class="term">sfu</span></dt><dd><p> + When the CIFS Unix Extensions are not negotiated, attempt to + create device files and fifos in a format compatible with + Services for Unix (SFU). In addition retrieve bits 10-12 + of the mode via the SETFILEBITS extended attribute (as + SFU does). In the future the bottom 9 bits of the mode + mode also will be emulated using queries of the security + descriptor (ACL). [NB: requires version 1.39 or later + of the CIFS VFS. To recognize symlinks and be able + to create symlinks in an SFU interoperable form + requires version 1.40 or later of the CIFS VFS kernel module. + </p></dd><dt><span class="term">serverino</span></dt><dd><p>Use inode numbers (unique persistent file identifiers) + returned by the server instead of automatically generating + temporary inode numbers on the client. Although server inode numbers + make it easier to spot hardlinked files (as they will have + the same inode numbers) and inode numbers may be persistent (which is + userful for some sofware), + the server does not guarantee that the inode numbers + are unique if multiple server side mounts are exported under a + single share (since inode numbers on the servers might not + be unique if multiple filesystems are mounted under the same + shared higher level directory). Note that not all + servers support returning server inode numbers, although + those that support the CIFS Unix Extensions, and Windows 2000 and + later servers typically do support this (although not necessarily + on every local server filesystem). Parameter has no effect if + the server lacks support for returning inode numbers or equivalent. + </p></dd><dt><span class="term">noserverino</span></dt><dd><p>client generates inode numbers (rather than using the actual one + from the server) by default. + </p></dd><dt><span class="term">nouser_xattr</span></dt><dd><p>(default) Do not allow getfattr/setfattr to get/set xattrs, even if server would support it otherwise. </p></dd><dt><span class="term">rsize=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>default network read size</p></dd><dt><span class="term">wsize=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>default network write size</p></dd><dt><span class="term">--verbose</span></dt><dd><p>Print additional debugging information for the mount. Note that this parameter must be specified before the -o. For example:</p><p>mount -t cifs //server/share /mnt --verbose -o user=username</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308221"></a><h2>ENVIRONMENT VARIABLES</h2><p> + The variable <span class="emphasis"><em>USER</em></span> may contain the username of the +person to be used to authenticate to the server. +The variable can be used to set both username and +password by using the format username%password. + </p><p> + The variable <span class="emphasis"><em>PASSWD</em></span> may contain the password of the +person using the client. + </p><p> + The variable <span class="emphasis"><em>PASSWD_FILE</em></span> may contain the pathname +of a file to read the password from. A single line of input is +read and used as the password. + </p></div><div class="refsect1" lang="en"><a name="id308252"></a><h2>NOTES</h2><p>This command may be used only by root, unless installed setuid, in which case the noeexec and nosuid mount flags are enabled.</p></div><div class="refsect1" lang="en"><a name="id308263"></a><h2>CONFIGURATION</h2><p> +The primary mechanism for making configuration changes and for reading +debug information for the cifs vfs is via the Linux /proc filesystem. +In the directory <code class="filename">/proc/fs/cifs</code> are various +configuration files and pseudo files which can display debug information. +There are additional startup options such as maximum buffer size and number +of buffers which only may be set when the kernel cifs vfs (cifs.ko module) is +loaded. These can be seen by running the modinfo utility against the file +cifs.ko which will list the options that may be passed to cifs during module +installation (device driver load). +For more information see the kernel file <code class="filename">fs/cifs/README</code>. +</p></div><div class="refsect1" lang="en"><a name="id308290"></a><h2>BUGS</h2><p>Mounting using the CIFS URL specification is currently not supported. + </p><p>The credentials file does not handle usernames or passwords with + leading space.</p><p> +Note that the typical response to a bug report is a suggestion +to try the latest version first. So please try doing that first, +and always include which versions you use of relevant software +when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and +server type you are trying to contact. +</p></div><div class="refsect1" lang="en"><a name="id308311"></a><h2>VERSION</h2><p>This man page is correct for version 1.39 of + the cifs vfs filesystem (roughly Linux kernel 2.6.15).</p></div><div class="refsect1" lang="en"><a name="id308322"></a><h2>SEE ALSO</h2><p> + Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel + source tree may contain additional options and information. +</p><p><a href="umount.cifs.8.html"><span class="citerefentry"><span class="refentrytitle">umount.cifs</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id308342"></a><h2>AUTHOR</h2><p>Steve French</p><p>The syntax and manpage were loosely based on that of smbmount. It + was converted to Docbook/XML by Jelmer Vernooij.</p><p>The maintainer of the Linux cifs vfs and the userspace + tool <span class="emphasis"><em>mount.cifs</em></span> is <a href="mailto:sfrench@samba.org" target="_top">Steve French</a>. + The <a href="mailto:linux-cifs-client@lists.samba.org" target="_top">Linux CIFS Mailing list</a> + is the preferred place to ask questions regarding these programs. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/net.8.html b/docs/htmldocs/manpages/net.8.html new file mode 100644 index 0000000000..76fbae251b --- /dev/null +++ b/docs/htmldocs/manpages/net.8.html @@ -0,0 +1,416 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>net</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="net.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>net — Tool for administration of Samba and remote + CIFS servers. + </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">net</code> {<ads|rap|rpc>} [-h] [-w workgroup] [-W myworkgroup] [-U user] [-I ip-address] [-p port] [-n myname] [-s conffile] [-S server] [-l] [-P] [-d debuglevel] [-V]</p></div></div><div class="refsect1" lang="en"><a name="id267094"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The Samba net utility is meant to work just like the net utility + available for windows and DOS. The first argument should be used + to specify the protocol to use when executing a certain command. + ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) + clients and RPC can be used for NT4 and Windows 2000. If this + argument is omitted, net will try to determine it automatically. + Not all commands are available on all protocols. + </p></div><div class="refsect1" lang="en"><a name="id299215"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-w target-workgroup</span></dt><dd><p> + Sets target workgroup or domain. You have to specify + either this option or the IP address or the name of a server. + </p></dd><dt><span class="term">-W workgroup</span></dt><dd><p> + Sets client workgroup or domain + </p></dd><dt><span class="term">-U user</span></dt><dd><p> + User name to use + </p></dd><dt><span class="term">-I ip-address</span></dt><dd><p> + IP address of target server to use. You have to + specify either this option or a target workgroup or + a target server. + </p></dd><dt><span class="term">-p port</span></dt><dd><p> + Port on the target server to connect to (usually 139 or 445). + Defaults to trying 445 first, then 139. + </p></dd><dt><span class="term">-n <primary NetBIOS name></span></dt><dd><p>This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the <a class="indexterm" name="id266742"></a> parameter in the <code class="filename">smb.conf</code> file. +However, a command +line setting will take precedence over settings in +<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-S server</span></dt><dd><p> + Name of target server. You should specify either + this option or a target workgroup or a target IP address. + </p></dd><dt><span class="term">-l</span></dt><dd><p> + When listing data, give more information on each item. + </p></dd><dt><span class="term">-P</span></dt><dd><p> + Make queries to the external server using the machine account of the local server. + </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266844"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266861"></a><h2>COMMANDS</h2><div class="refsect2" lang="en"><a name="id266866"></a><h3>CHANGESECRETPW</h3><p>This command allows the Samba machine account password to be set from an external application +to a machine account password that has already been stored in Active Directory. DO NOT USE this command +unless you know exactly what you are doing. The use of this command requires that the force flag (-f) +be used also. There will be NO command prompt. Whatever information is piped into stdin, either by +typing at the command line or otherwise, will be stored as the literal machine password. Do NOT use +this without care and attention as it will overwrite a legitimate machine password without warning. +YOU HAVE BEEN WARNED. +</p></div><div class="refsect2" lang="en"><a name="id266882"></a><h3>TIME</h3><p>The <code class="literal">NET TIME</code> command allows you to view the time on a remote server + or synchronise the time on the local server with the time on the remote server.</p><div class="refsect3" lang="en"><a name="id266898"></a><h4>TIME</h4><p>Without any options, the <code class="literal">NET TIME</code> command +displays the time on the remote server. +</p></div><div class="refsect3" lang="en"><a name="id266914"></a><h4>TIME SYSTEM</h4><p>Displays the time on the remote server in a format ready for <code class="literal">/bin/date</code>.</p></div><div class="refsect3" lang="en"><a name="id307883"></a><h4>TIME SET</h4><p>Tries to set the date and time of the local server to that on +the remote server using <code class="literal">/bin/date</code>. </p></div><div class="refsect3" lang="en"><a name="id307898"></a><h4>TIME ZONE</h4><p>Displays the timezone in hours from GMT on the remote computer.</p></div></div><div class="refsect2" lang="en"><a name="id307909"></a><h3>[RPC|ADS] JOIN [TYPE] [-U username[%password]] [createupn=UPN] [createcomputer=OU] [options]</h3><p> +Join a domain. If the account already exists on the server, and +[TYPE] is MEMBER, the machine will attempt to join automatically. +(Assuming that the machine has been created in server manager) +Otherwise, a password will be prompted for, and a new account may +be created.</p><p> +[TYPE] may be PDC, BDC or MEMBER to specify the type of server +joining the domain. +</p><p> +[UPN] (ADS only) set the principalname attribute during the join. The default +format is host/netbiosname@REALM. +</p><p> +[OU] (ADS only) Precreate the computer account in a specific OU. The +OU string reads from top to bottom without RDNs, and is delimited by +a '/'. Please note that '\' is used for escape by both the shell +and ldap, so it may need to be doubled or quadrupled to pass through, +and it is not used as a delimiter. +</p></div><div class="refsect2" lang="en"><a name="id307939"></a><h3>[RPC] OLDJOIN [options]</h3><p>Join a domain. Use the OLDJOIN option to join the domain +using the old style of domain joining - you need to create a trust +account in server manager first.</p></div><div class="refsect2" lang="en"><a name="id307950"></a><h3>[RPC|ADS] USER</h3><div class="refsect3" lang="en"><a name="id307956"></a><h4>[RPC|ADS] USER</h4><p>List all users</p></div><div class="refsect3" lang="en"><a name="id307966"></a><h4>[RPC|ADS] USER DELETE <em class="replaceable"><code>target</code></em></h4><p>Delete specified user</p></div><div class="refsect3" lang="en"><a name="id307978"></a><h4>[RPC|ADS] USER INFO <em class="replaceable"><code>target</code></em></h4><p>List the domain groups of the specified user.</p></div><div class="refsect3" lang="en"><a name="id307991"></a><h4>[RPC|ADS] USER RENAME <em class="replaceable"><code>oldname</code></em> <em class="replaceable"><code>newname</code></em></h4><p>Rename specified user.</p></div><div class="refsect3" lang="en"><a name="id308007"></a><h4>[RPC|ADS] USER ADD <em class="replaceable"><code>name</code></em> [password] [-F user flags] [-C comment]</h4><p>Add specified user.</p></div></div><div class="refsect2" lang="en"><a name="id308022"></a><h3>[RPC|ADS] GROUP</h3><div class="refsect3" lang="en"><a name="id308028"></a><h4>[RPC|ADS] GROUP [misc options] [targets]</h4><p>List user groups.</p></div><div class="refsect3" lang="en"><a name="id308038"></a><h4>[RPC|ADS] GROUP DELETE <em class="replaceable"><code>name</code></em> [misc. options]</h4><p>Delete specified group.</p></div><div class="refsect3" lang="en"><a name="id308052"></a><h4>[RPC|ADS] GROUP ADD <em class="replaceable"><code>name</code></em> [-C comment]</h4><p>Create specified group.</p></div></div><div class="refsect2" lang="en"><a name="id308067"></a><h3>[RAP|RPC] SHARE</h3><div class="refsect3" lang="en"><a name="id308073"></a><h4>[RAP|RPC] SHARE [misc. options] [targets]</h4><p>Enumerates all exported resources (network shares) on target server.</p></div><div class="refsect3" lang="en"><a name="id308084"></a><h4>[RAP|RPC] SHARE ADD <em class="replaceable"><code>name=serverpath</code></em> [-C comment] [-M maxusers] [targets]</h4><p>Adds a share from a server (makes the export active). Maxusers +specifies the number of users that can be connected to the +share simultaneously.</p></div><div class="refsect3" lang="en"><a name="id308099"></a><h4>SHARE DELETE <em class="replaceable"><code>sharename</code></em></h4><p>Delete specified share.</p></div></div><div class="refsect2" lang="en"><a name="id308112"></a><h3>[RPC|RAP] FILE</h3><div class="refsect3" lang="en"><a name="id308118"></a><h4>[RPC|RAP] FILE</h4><p>List all open files on remote server.</p></div><div class="refsect3" lang="en"><a name="id308128"></a><h4>[RPC|RAP] FILE CLOSE <em class="replaceable"><code>fileid</code></em></h4><p>Close file with specified <em class="replaceable"><code>fileid</code></em> on +remote server.</p></div><div class="refsect3" lang="en"><a name="id308145"></a><h4>[RPC|RAP] FILE INFO <em class="replaceable"><code>fileid</code></em></h4><p> +Print information on specified <em class="replaceable"><code>fileid</code></em>. +Currently listed are: file-id, username, locks, path, permissions. +</p></div><div class="refsect3" lang="en"><a name="id308161"></a><h4>[RAP|RPC] FILE USER <em class="replaceable"><code>user</code></em></h4><p> +List files opened by specified <em class="replaceable"><code>user</code></em>. +Please note that <code class="literal">net rap file user</code> does not work +against Samba servers. +</p></div></div><div class="refsect2" lang="en"><a name="id308185"></a><h3>SESSION</h3><div class="refsect3" lang="en"><a name="id308191"></a><h4>RAP SESSION</h4><p>Without any other options, SESSION enumerates all active SMB/CIFS +sessions on the target server.</p></div><div class="refsect3" lang="en"><a name="id308201"></a><h4>RAP SESSION DELETE|CLOSE <em class="replaceable"><code>CLIENT_NAME</code></em></h4><p>Close the specified sessions.</p></div><div class="refsect3" lang="en"><a name="id308214"></a><h4>RAP SESSION INFO <em class="replaceable"><code>CLIENT_NAME</code></em></h4><p>Give a list with all the open files in specified session.</p></div></div><div class="refsect2" lang="en"><a name="id308228"></a><h3>RAP SERVER <em class="replaceable"><code>DOMAIN</code></em></h3><p>List all servers in specified domain or workgroup. Defaults +to local domain.</p></div><div class="refsect2" lang="en"><a name="id308241"></a><h3>RAP DOMAIN</h3><p>Lists all domains and workgroups visible on the +current network.</p></div><div class="refsect2" lang="en"><a name="id308252"></a><h3>RAP PRINTQ</h3><div class="refsect3" lang="en"><a name="id308257"></a><h4>RAP PRINTQ LIST <em class="replaceable"><code>QUEUE_NAME</code></em></h4><p>Lists the specified print queue and print jobs on the server. +If the <em class="replaceable"><code>QUEUE_NAME</code></em> is omitted, all +queues are listed.</p></div><div class="refsect3" lang="en"><a name="id308274"></a><h4>RAP PRINTQ DELETE <em class="replaceable"><code>JOBID</code></em></h4><p>Delete job with specified id.</p></div></div><div class="refsect2" lang="en"><a name="id308288"></a><h3>RAP VALIDATE <em class="replaceable"><code>user</code></em> [<em class="replaceable"><code>password</code></em>]</h3><p> +Validate whether the specified user can log in to the +remote server. If the password is not specified on the commandline, it +will be prompted. +</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Currently NOT implemented.</p></div></div><div class="refsect2" lang="en"><a name="id308311"></a><h3>RAP GROUPMEMBER</h3><div class="refsect3" lang="en"><a name="id308316"></a><h4>RAP GROUPMEMBER LIST <em class="replaceable"><code>GROUP</code></em></h4><p>List all members of the specified group.</p></div><div class="refsect3" lang="en"><a name="id308329"></a><h4>RAP GROUPMEMBER DELETE <em class="replaceable"><code>GROUP</code></em> <em class="replaceable"><code>USER</code></em></h4><p>Delete member from group.</p></div><div class="refsect3" lang="en"><a name="id308345"></a><h4>RAP GROUPMEMBER ADD <em class="replaceable"><code>GROUP</code></em> <em class="replaceable"><code>USER</code></em></h4><p>Add member to group.</p></div></div><div class="refsect2" lang="en"><a name="id308362"></a><h3>RAP ADMIN <em class="replaceable"><code>command</code></em></h3><p>Execute the specified <em class="replaceable"><code>command</code></em> on +the remote server. Only works with OS/2 servers. +</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Currently NOT implemented.</p></div></div><div class="refsect2" lang="en"><a name="id308384"></a><h3>RAP SERVICE</h3><div class="refsect3" lang="en"><a name="id308389"></a><h4>RAP SERVICE START <em class="replaceable"><code>NAME</code></em> [arguments...]</h4><p>Start the specified service on the remote server. Not implemented yet.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Currently NOT implemented.</p></div></div><div class="refsect3" lang="en"><a name="id308408"></a><h4>RAP SERVICE STOP</h4><p>Stop the specified service on the remote server.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Currently NOT implemented.</p></div></div></div><div class="refsect2" lang="en"><a name="id308424"></a><h3>RAP PASSWORD <em class="replaceable"><code>USER</code></em> <em class="replaceable"><code>OLDPASS</code></em> <em class="replaceable"><code>NEWPASS</code></em></h3><p> +Change password of <em class="replaceable"><code>USER</code></em> from <em class="replaceable"><code>OLDPASS</code></em> to <em class="replaceable"><code>NEWPASS</code></em>. +</p></div><div class="refsect2" lang="en"><a name="id308455"></a><h3>LOOKUP</h3><div class="refsect3" lang="en"><a name="id308460"></a><h4>LOOKUP HOST <em class="replaceable"><code>HOSTNAME</code></em> [<em class="replaceable"><code>TYPE</code></em>]</h4><p> +Lookup the IP address of the given host with the specified type (netbios suffix). +The type defaults to 0x20 (workstation). +</p></div><div class="refsect3" lang="en"><a name="id308478"></a><h4>LOOKUP LDAP [<em class="replaceable"><code>DOMAIN</code></em>]</h4><p>Give IP address of LDAP server of specified <em class="replaceable"><code>DOMAIN</code></em>. Defaults to local domain.</p></div><div class="refsect3" lang="en"><a name="id308496"></a><h4>LOOKUP KDC [<em class="replaceable"><code>REALM</code></em>]</h4><p>Give IP address of KDC for the specified <em class="replaceable"><code>REALM</code></em>. +Defaults to local realm.</p></div><div class="refsect3" lang="en"><a name="id308514"></a><h4>LOOKUP DC [<em class="replaceable"><code>DOMAIN</code></em>]</h4><p>Give IP's of Domain Controllers for specified <em class="replaceable"><code> +DOMAIN</code></em>. Defaults to local domain.</p></div><div class="refsect3" lang="en"><a name="id308531"></a><h4>LOOKUP MASTER <em class="replaceable"><code>DOMAIN</code></em></h4><p>Give IP of master browser for specified <em class="replaceable"><code>DOMAIN</code></em> +or workgroup. Defaults to local domain.</p></div></div><div class="refsect2" lang="en"><a name="id308549"></a><h3>CACHE</h3><p>Samba uses a general caching interface called 'gencache'. It +can be controlled using 'NET CACHE'.</p><p>All the timeout parameters support the suffixes: + +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>s - Seconds</td></tr><tr><td>m - Minutes</td></tr><tr><td>h - Hours</td></tr><tr><td>d - Days</td></tr><tr><td>w - Weeks</td></tr></table><p> + +</p><div class="refsect3" lang="en"><a name="id308586"></a><h4>CACHE ADD <em class="replaceable"><code>key</code></em> <em class="replaceable"><code>data</code></em> <em class="replaceable"><code>time-out</code></em></h4><p>Add specified key+data to the cache with the given timeout.</p></div><div class="refsect3" lang="en"><a name="id308605"></a><h4>CACHE DEL <em class="replaceable"><code>key</code></em></h4><p>Delete key from the cache.</p></div><div class="refsect3" lang="en"><a name="id308618"></a><h4>CACHE SET <em class="replaceable"><code>key</code></em> <em class="replaceable"><code>data</code></em> <em class="replaceable"><code>time-out</code></em></h4><p>Update data of existing cache entry.</p></div><div class="refsect3" lang="en"><a name="id308637"></a><h4>CACHE SEARCH <em class="replaceable"><code>PATTERN</code></em></h4><p>Search for the specified pattern in the cache data.</p></div><div class="refsect3" lang="en"><a name="id308650"></a><h4>CACHE LIST</h4><p> +List all current items in the cache. +</p></div><div class="refsect3" lang="en"><a name="id308660"></a><h4>CACHE FLUSH</h4><p>Remove all the current items from the cache.</p></div></div><div class="refsect2" lang="en"><a name="id308671"></a><h3>GETLOCALSID [DOMAIN]</h3><p>Prints the SID of the specified domain, or if the parameter is +omitted, the SID of the local server.</p></div><div class="refsect2" lang="en"><a name="id308682"></a><h3>SETLOCALSID S-1-5-21-x-y-z</h3><p>Sets SID for the local server to the specified SID.</p></div><div class="refsect2" lang="en"><a name="id308693"></a><h3>GETDOMAINSID</h3><p>Prints the local machine SID and the SID of the current +domain.</p></div><div class="refsect2" lang="en"><a name="id308703"></a><h3>SETDOMAINSID</h3><p>Sets the SID of the current domain.</p></div><div class="refsect2" lang="en"><a name="id308714"></a><h3>GROUPMAP</h3><p>Manage the mappings between Windows group SIDs and UNIX groups. +Common options include:</p><div class="itemizedlist"><ul type="disc"><li><p>unixgroup - Name of the UNIX group</p></li><li><p>ntgroup - Name of the Windows NT group (must be + resolvable to a SID</p></li><li><p>rid - Unsigned 32-bit integer</p></li><li><p>sid - Full SID in the form of "S-1-..."</p></li><li><p>type - Type of the group; either 'domain', 'local', + or 'builtin'</p></li><li><p>comment - Freeform text description of the group</p></li></ul></div><div class="refsect3" lang="en"><a name="id308755"></a><h4>GROUPMAP ADD</h4><p> +Add a new group mapping entry: +</p><pre class="programlisting"> +net groupmap add {rid=int|sid=string} unixgroup=string \ + [type={domain|local}] [ntgroup=string] [comment=string] +</pre><p> +</p></div><div class="refsect3" lang="en"><a name="id308772"></a><h4>GROUPMAP DELETE</h4><p>Delete a group mapping entry. If more than one group name matches, the first entry found is deleted.</p><p>net groupmap delete {ntgroup=string|sid=SID}</p></div><div class="refsect3" lang="en"><a name="id308786"></a><h4>GROUPMAP MODIFY</h4><p>Update en existing group entry.</p><p> +</p><pre class="programlisting"> +net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] \ + [comment=string] [type={domain|local}] +</pre><p> +</p></div><div class="refsect3" lang="en"><a name="id308806"></a><h4>GROUPMAP LIST</h4><p>List existing group mapping entries.</p><p>net groupmap list [verbose] [ntgroup=string] [sid=SID]</p></div></div><div class="refsect2" lang="en"><a name="id308821"></a><h3>MAXRID</h3><p>Prints out the highest RID currently in use on the local +server (by the active 'passdb backend'). +</p></div><div class="refsect2" lang="en"><a name="id308832"></a><h3>RPC INFO</h3><p>Print information about the domain of the remote server, +such as domain name, domain sid and number of users and groups. +</p></div><div class="refsect2" lang="en"><a name="id308843"></a><h3>[RPC|ADS] TESTJOIN</h3><p>Check whether participation in a domain is still valid.</p></div><div class="refsect2" lang="en"><a name="id308854"></a><h3>[RPC|ADS] CHANGETRUSTPW</h3><p>Force change of domain trust password.</p></div><div class="refsect2" lang="en"><a name="id308864"></a><h3>RPC TRUSTDOM</h3><div class="refsect3" lang="en"><a name="id308870"></a><h4>RPC TRUSTDOM ADD <em class="replaceable"><code>DOMAIN</code></em></h4><p>Add a interdomain trust account for <em class="replaceable"><code>DOMAIN</code></em>. +This is in fact a Samba account named <em class="replaceable"><code>DOMAIN$</code></em> +with the account flag <code class="constant">'I'</code> (interdomain trust account). +If the command is used against localhost it has the same effect as +<code class="literal">smbpasswd -a -i DOMAIN</code>. Please note that both commands +expect a appropriate UNIX account. +</p></div><div class="refsect3" lang="en"><a name="id308901"></a><h4>RPC TRUSTDOM DEL <em class="replaceable"><code>DOMAIN</code></em></h4><p>Remove interdomain trust account for +<em class="replaceable"><code>DOMAIN</code></em>. If it is used against localhost +it has the same effect as <code class="literal">smbpasswd -x DOMAIN$</code>. +</p></div><div class="refsect3" lang="en"><a name="id308923"></a><h4>RPC TRUSTDOM ESTABLISH <em class="replaceable"><code>DOMAIN</code></em></h4><p> +Establish a trust relationship to a trusting domain. +Interdomain account must already be created on the remote PDC. +</p></div><div class="refsect3" lang="en"><a name="id308936"></a><h4>RPC TRUSTDOM REVOKE <em class="replaceable"><code>DOMAIN</code></em></h4><p>Abandon relationship to trusted domain</p></div><div class="refsect3" lang="en"><a name="id308949"></a><h4>RPC TRUSTDOM LIST</h4><p>List all current interdomain trust relationships.</p></div><div class="refsect3" lang="en"><a name="id308960"></a><h4>RPC RIGHTS</h4><p>This subcommand is used to view and manage Samba's rights assignments (also +referred to as privileges). There are three options currently available: +<em class="parameter"><code>list</code></em>, <em class="parameter"><code>grant</code></em>, and +<em class="parameter"><code>revoke</code></em>. More details on Samba's privilege model and its use +can be found in the Samba-HOWTO-Collection.</p></div></div><div class="refsect2" lang="en"><a name="id308991"></a><h3>RPC ABORTSHUTDOWN</h3><p>Abort the shutdown of a remote server.</p></div><div class="refsect2" lang="en"><a name="id309001"></a><h3>RPC SHUTDOWN [-t timeout] [-r] [-f] [-C message]</h3><p>Shut down the remote server.</p><div class="variablelist"><dl><dt><span class="term">-r</span></dt><dd><p> +Reboot after shutdown. +</p></dd><dt><span class="term">-f</span></dt><dd><p> +Force shutting down all applications. +</p></dd><dt><span class="term">-t timeout</span></dt><dd><p> +Timeout before system will be shut down. An interactive +user of the system can use this time to cancel the shutdown. +</p></dd><dt><span class="term">-C message</span></dt><dd><p>Display the specified message on the screen to +announce the shutdown.</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id309061"></a><h3>RPC SAMDUMP</h3><p>Print out sam database of remote server. You need +to run this against the PDC, from a Samba machine joined as a BDC. </p></div><div class="refsect2" lang="en"><a name="id309072"></a><h3>RPC VAMPIRE</h3><p>Export users, aliases and groups from remote server to +local server. You need to run this against the PDC, from a Samba machine joined as a BDC. +</p></div><div class="refsect2" lang="en"><a name="id309083"></a><h3>RPC GETSID</h3><p>Fetch domain SID and store it in the local <code class="filename">secrets.tdb</code>. </p></div><div class="refsect2" lang="en"><a name="id309099"></a><h3>ADS LEAVE</h3><p>Make the remote host leave the domain it is part of. </p></div><div class="refsect2" lang="en"><a name="id309109"></a><h3>ADS STATUS</h3><p>Print out status of machine account of the local machine in ADS. +Prints out quite some debug info. Aimed at developers, regular +users should use <code class="literal">NET ADS TESTJOIN</code>.</p></div><div class="refsect2" lang="en"><a name="id309126"></a><h3>ADS PRINTER</h3><div class="refsect3" lang="en"><a name="id309132"></a><h4>ADS PRINTER INFO [<em class="replaceable"><code>PRINTER</code></em>] [<em class="replaceable"><code>SERVER</code></em>]</h4><p> +Lookup info for <em class="replaceable"><code>PRINTER</code></em> on <em class="replaceable"><code>SERVER</code></em>. The printer name defaults to "*", the +server name defaults to the local host.</p></div><div class="refsect3" lang="en"><a name="id309157"></a><h4>ADS PRINTER PUBLISH <em class="replaceable"><code>PRINTER</code></em></h4><p>Publish specified printer using ADS.</p></div><div class="refsect3" lang="en"><a name="id309170"></a><h4>ADS PRINTER REMOVE <em class="replaceable"><code>PRINTER</code></em></h4><p>Remove specified printer from ADS directory.</p></div></div><div class="refsect2" lang="en"><a name="id309183"></a><h3>ADS SEARCH <em class="replaceable"><code>EXPRESSION</code></em> <em class="replaceable"><code>ATTRIBUTES...</code></em></h3><p>Perform a raw LDAP search on a ADS server and dump the results. The +expression is a standard LDAP search expression, and the +attributes are a list of LDAP fields to show in the results.</p><p>Example: <strong class="userinput"><code>net ads search '(objectCategory=group)' sAMAccountName</code></strong> +</p></div><div class="refsect2" lang="en"><a name="id309210"></a><h3>ADS DN <em class="replaceable"><code>DN</code></em> <em class="replaceable"><code>(attributes)</code></em></h3><p> +Perform a raw LDAP search on a ADS server and dump the results. The +DN standard LDAP DN, and the attributes are a list of LDAP fields +to show in the result. +</p><p>Example: <strong class="userinput"><code>net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName</code></strong></p></div><div class="refsect2" lang="en"><a name="id309236"></a><h3>ADS WORKGROUP</h3><p>Print out workgroup name for specified kerberos realm.</p></div><div class="refsect2" lang="en"><a name="id309246"></a><h3>SAM CREATEBUILTINGROUP <NAME></h3><p> +(Re)Create a BUILTIN group. +Only a wellknown set of BUILTIN groups can be created with this command. +This is the list of currently recognized group names: Administrators, +Users, Guests, Power Users, Account Operators, Server Operators, Print +Operators, Backup Operators, Replicator, RAS Servers, Pre-Windows 2000 +compatible Access. + +This command requires a running Winbindd with idmap allocation properly +configured. The group gid will be allocated out of the winbindd range. +</p></div><div class="refsect2" lang="en"><a name="id309260"></a><h3>SAM CREATELOCALGROUP <NAME></h3><p> +Create a LOCAL group (also known as Alias). + +This command requires a running Winbindd with idmap allocation properly +configured. The group gid will be allocated out of the winbindd range. +</p></div><div class="refsect2" lang="en"><a name="id309272"></a><h3>SAM DELETELOCALGROUP <NAME></h3><p> +Delete an existing LOCAL group (also known as Alias). + +</p></div><div class="refsect2" lang="en"><a name="id309283"></a><h3>SAM MAPUNIXGROUP <NAME></h3><p> +Map an existing Unix group and make it a Domain Group, the domain group +will have the same name. +</p></div><div class="refsect2" lang="en"><a name="id309294"></a><h3>SAM UNMAPUNIXGROUP <NAME></h3><p> +Remove an existing group mapping entry. +</p></div><div class="refsect2" lang="en"><a name="id309305"></a><h3>SAM ADDMEM <GROUP> <MEMBER></h3><p> +Add a member to a Local group. The group can be specified only by name, +the member can be specified by name or SID. +</p></div><div class="refsect2" lang="en"><a name="id309316"></a><h3>SAM DELMEM <GROUP> <MEMBER></h3><p> +Remove a member from a Local group. The group and the member must be +specified by name. +</p></div><div class="refsect2" lang="en"><a name="id309327"></a><h3>SAM LISTMEM <GROUP></h3><p> +List Local group members. The group must be specified by name. +</p></div><div class="refsect2" lang="en"><a name="id309338"></a><h3>SAM LIST <users|groups|localgroups|builtin|workstations> [verbose]</h3><p> +List the specified set of accounts by name. If verbose is specified, +the rid and description is also provided for each account. +</p></div><div class="refsect2" lang="en"><a name="id309350"></a><h3>SAM SHOW <NAME></h3><p> +Show the full DOMAIN\\NAME the SID and the type for the corresponding +account. +</p></div><div class="refsect2" lang="en"><a name="id309361"></a><h3>SAM SET HOMEDIR <NAME> <DIRECTORY></h3><p> +Set the home directory for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309371"></a><h3>SAM SET PROFILEPATH <NAME> <PATH></h3><p> +Set the profile path for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309382"></a><h3>SAM SET COMMENT <NAME> <COMMENT></h3><p> +Set the comment for a user or group account. +</p></div><div class="refsect2" lang="en"><a name="id309392"></a><h3>SAM SET FULLNAME <NAME> <FULL NAME></h3><p> +Set the full name for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309403"></a><h3>SAM SET LOGONSCRIPT <NAME> <SCRIPT></h3><p> +Set the logon script for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309413"></a><h3>SAM SET HOMEDRIVE <NAME> <DRIVE></h3><p> +Set the home drive for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309424"></a><h3>SAM SET WORKSTATIONS <NAME> <WORKSTATIONS></h3><p> +Set the workstations a user account is allowed to log in from. +</p></div><div class="refsect2" lang="en"><a name="id309435"></a><h3>SAM SET DISABLE <NAME></h3><p> +Set the "disabled" flag for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309445"></a><h3>SAM SET PWNOTREQ <NAME></h3><p> +Set the "password not required" flag for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309456"></a><h3>SAM SET AUTOLOCK <NAME></h3><p> +Set the "autolock" flag for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309466"></a><h3>SAM SET PWNOEXP <NAME></h3><p> +Set the "password do not expire" flag for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309477"></a><h3>SAM SET PWDMUSTCHANGENOW <NAME> [yes|no]</h3><p> +Set or unset the "password must change" flag for a user account. +</p></div><div class="refsect2" lang="en"><a name="id309488"></a><h3>SAM POLICY LIST</h3><p> +List the available account policies. +</p></div><div class="refsect2" lang="en"><a name="id309498"></a><h3>SAM POLICY SHOW <account policy></h3><p> +Show the account policy value. +</p></div><div class="refsect2" lang="en"><a name="id309509"></a><h3>SAM POLICY SET <account policy> <value></h3><p> +Set a value for the account policy. +Valid values can be: "forever", "never", "off", or a number. +</p></div><div class="refsect2" lang="en"><a name="id309520"></a><h3>SAM PROVISION</h3><p> +Only available if ldapsam:editposix is set and winbindd is running. +Properly populates the ldap tree with the basic accounts (Administrator) +and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree. +</p></div><div class="refsect2" lang="en"><a name="id309532"></a><h3>IDMAP DUMP <local tdb file name></h3><p> +Dumps the mappings contained in the local tdb file specified. +This command is useful to dump only the mappings produced by the idmap_tdb backend. +</p></div><div class="refsect2" lang="en"><a name="id309544"></a><h3>IDMAP RESTORE [input file]</h3><p> +Restore the mappings from the specified file or stdin. +</p></div><div class="refsect2" lang="en"><a name="id309554"></a><h3>IDMAP SECRET <DOMAIN>|ALLOC <secret></h3><p> +Store a secret for the specified domain, used primarily for domains +that use idmap_ldap as a backend. In this case the secret is used +as the password for the user DN used to bind to the ldap server. +</p></div><div class="refsect2" lang="en"><a name="id309566"></a><h3>USERSHARE</h3><p>Starting with version 3.0.23, a Samba server now supports the ability for +non-root users to add user defined shares to be exported using the "net usershare" +commands. +</p><p> +To set this up, first set up your smb.conf by adding to the [global] section: + +usershare path = /usr/local/samba/lib/usershares + +Next create the directory /usr/local/samba/lib/usershares, change the owner to root and +set the group owner to the UNIX group who should have the ability to create usershares, +for example a group called "serverops". + +Set the permissions on /usr/local/samba/lib/usershares to 01770. + +(Owner and group all access, no access for others, plus the sticky bit, +which means that a file in that directory can be renamed or deleted only +by the owner of the file). + +Finally, tell smbd how many usershares you will allow by adding to the [global] +section of smb.conf a line such as : + +usershare max shares = 100. + +To allow 100 usershare definitions. Now, members of the UNIX group "serverops" +can create user defined shares on demand using the commands below. +</p><p>The usershare commands are: + +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>net usershare add sharename path [comment] [acl] [guest_ok=[y|n]] - to add or change a user defined share.</td></tr><tr><td>net usershare delete sharename - to delete a user defined share.</td></tr><tr><td>net usershare info [-l|--long] [wildcard sharename] - to print info about a user defined share.</td></tr><tr><td>net usershare list [-l|--long] [wildcard sharename] - to list user defined shares.</td></tr></table><p> + +</p><div class="refsect3" lang="en"><a name="id309613"></a><h4>USERSHARE ADD <em class="replaceable"><code>sharename</code></em> <em class="replaceable"><code>path</code></em> <em class="replaceable"><code>[comment]</code></em> <em class="replaceable"><code>[acl]</code></em> <em class="replaceable"><code>[guest_ok=[y|n]]</code></em></h4><p> +Add or replace a new user defined share, with name "sharename". +</p><p> +"path" specifies the absolute pathname on the system to be exported. +Restrictions may be put on this, see the global smb.conf parameters: +"usershare owner only", "usershare prefix allow list", and +"usershare prefix deny list". +</p><p> +The optional "comment" parameter is the comment that will appear +on the share when browsed to by a client. +</p><p>The optional "acl" field +specifies which users have read and write access to the entire share. +Note that guest connections are not allowed unless the smb.conf parameter +"usershare allow guests" has been set. The definition of a user +defined share acl is: "user:permission", where user is a valid +username on the system and permission can be "F", "R", or "D". +"F" stands for "full permissions", ie. read and write permissions. +"D" stands for "deny" for a user, ie. prevent this user from accessing +this share. +"R" stands for "read only", ie. only allow read access to this +share (no creation of new files or directories or writing to files). +</p><p> +The default if no "acl" is given is "Everyone:R", which means any +authenticated user has read-only access. +</p><p> +The optional "guest_ok" has the same effect as the parameter of the +same name in smb.conf, in that it allows guest access to this user +defined share. This parameter is only allowed if the global parameter +"usershare allow guests" has been set to true in the smb.conf. +</p> + +There is no separate command to modify an existing user defined share, +just use the "net usershare add [sharename]" command using the same +sharename as the one you wish to modify and specify the new options +you wish. The Samba smbd daemon notices user defined share modifications +at connect time so will see the change immediately, there is no need +to restart smbd on adding, deleting or changing a user defined share. +</div><div class="refsect3" lang="en"><a name="id309671"></a><h4>USERSHARE DELETE <em class="replaceable"><code>sharename</code></em></h4><p> +Deletes the user defined share by name. The Samba smbd daemon +immediately notices this change, although it will not disconnect +any users currently connected to the deleted share. +</p></div><div class="refsect3" lang="en"><a name="id309685"></a><h4>USERSHARE INFO <em class="replaceable"><code>[-l|--long]</code></em> <em class="replaceable"><code>[wildcard sharename]</code></em></h4><p> +Get info on user defined shares owned by the current user matching the given pattern, or all users. +</p><p> +net usershare info on its own dumps out info on the user defined shares that were +created by the current user, or restricts them to share names that match the given +wildcard pattern ('*' matches one or more characters, '?' matches only one character). +If the '-l' or '--long' option is also given, it prints out info on user defined +shares created by other users. +</p><p> +The information given about a share looks like: + +[foobar] +path=/home/jeremy +comment=testme +usershare_acl=Everyone:F +guest_ok=n + +And is a list of the current settings of the user defined share that can be +modified by the "net usershare add" command. +</p></div><div class="refsect3" lang="en"><a name="id309714"></a><h4>USERSHARE LIST <em class="replaceable"><code>[-l|--long]</code></em> <em class="replaceable"><code>wildcard sharename</code></em></h4><p> +List all the user defined shares owned by the current user matching the given pattern, or all users. +</p><p> +net usershare list on its own list out the names of the user defined shares that were +created by the current user, or restricts the list to share names that match the given +wildcard pattern ('*' matches one or more characters, '?' matches only one character). +If the '-l' or '--long' option is also given, it includes the names of user defined +shares created by other users. +</p></div></div><div class="refsect2" lang="en"><a name="id309738"></a><h3>CONF</h3><p>Starting with version 3.2.0, a Samba server can be configured by data +stored in registry. This configuration data can be edited with the new "net +conf" commands. +</p><p> +The deployment of this configuration data can be activated in two levels from the +<span class="emphasis"><em>smb.conf</em></span> file: Share definitions from registry are +activated by setting <em class="parameter"><code>registry shares</code></em> to +“<span class="quote">yes</span>” in the [global] section and global configuration options are +activated by setting <a class="indexterm" name="id309765"></a>include = registry in +the [global] section. +See the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> manpage for details. +</p><p>The conf commands are: +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>net conf list - Dump the complete configuration in smb.conf like +format.</td></tr><tr><td>net conf import - Import configuration from file in smb.conf +format.</td></tr><tr><td>net conf listshares - List the registry shares.</td></tr><tr><td>net conf drop - Delete the complete configuration from +registry.</td></tr><tr><td>net conf showshare - Show the definition of a registry share.</td></tr><tr><td>net conf addshare - Create a new registry share.</td></tr><tr><td>net conf delshare - Delete a registry share.</td></tr><tr><td>net conf setparm - Store a parameter.</td></tr><tr><td>net conf getparm - Retrieve the value of a parameter.</td></tr><tr><td>net conf delparm - Delete a parameter.</td></tr></table><p> +</p><div class="refsect3" lang="en"><a name="id309828"></a><h4>CONF LIST</h4><p> +Print the configuration data stored in the registry in a smb.conf-like format to +standard output. +</p></div><div class="refsect3" lang="en"><a name="id309839"></a><h4>CONF IMPORT <em class="replaceable"><code>[--test|-T]</code></em> <em class="replaceable"><code>filename</code></em> <em class="replaceable"><code>[section]</code></em></h4><p> +This command imports configuration from a file in smb.conf format. +If a section encountered in the input file is present in registry, +its contents is replaced. Sections of registry configuration that have +no counterpart in the input file are not affected. If you want to delete these, +you will have to use the "net conf drop" or "net conf delshare" commands. +Optionally, a section may be specified to restrict the effect of the +import command to that specific section. A test mode is enabled by specifying +the parameter "-T" on the commandline. In test mode, no changes are made to the +registry, and the resulting configuration is printed to standard output instead. +</p></div><div class="refsect3" lang="en"><a name="id309864"></a><h4>CONF LISTSHARES</h4><p> +List the names of the shares defined in registry. +</p></div><div class="refsect3" lang="en"><a name="id309875"></a><h4>CONF DROP</h4><p> +Delete the complete configuration data from registry. +</p></div><div class="refsect3" lang="en"><a name="id309885"></a><h4>CONF SHOWSHARE <em class="replaceable"><code>sharename</code></em></h4><p> +Show the definition of the share or section specified. It is valid to specify +"global" as sharename to retrieve the global configuration options from +registry. +</p></div><div class="refsect3" lang="en"><a name="id309899"></a><h4>CONF ADDSHARE <em class="replaceable"><code>sharename</code></em> <em class="replaceable"><code>path</code></em> [<em class="replaceable"><code>writeable={y|N}</code></em> [<em class="replaceable"><code>guest_ok={y|N}</code></em> [<em class="replaceable"><code>comment</code></em>]]] </h4><p>Create a new share definition in registry. +The sharename and path have to be given. The share name may +<span class="emphasis"><em>not</em></span> be "global". Optionally, values for the very +common options "writeable", "guest ok" and a "comment" may be specified. +The same result may be obtained by a sequence of "net conf setparm" +commands. +</p></div><div class="refsect3" lang="en"><a name="id309932"></a><h4>CONF DELSHARE <em class="replaceable"><code>sharename</code></em></h4><p> +Delete a share definition from registry. +</p></div><div class="refsect3" lang="en"><a name="id309945"></a><h4>CONF SETPARM <em class="replaceable"><code>section</code></em> <em class="replaceable"><code>parameter</code></em> <em class="replaceable"><code>value</code></em></h4><p> +Store a parameter in registry. The section may be global or a sharename. +The section is created if it does not exist yet. +</p></div><div class="refsect3" lang="en"><a name="id309965"></a><h4>CONF GETPARM <em class="replaceable"><code>section</code></em> <em class="replaceable"><code>parameter</code></em></h4><p> +Show a parameter stored in registry. +</p></div><div class="refsect3" lang="en"><a name="id309981"></a><h4>CONF DELPARM <em class="replaceable"><code>section</code></em> <em class="replaceable"><code>parameter</code></em></h4><p> +Delete a parameter stored in registry. +</p></div><div class="refsect3" lang="en"><a name="id309998"></a><h4></h4><p> +</p></div></div><div class="refsect2" lang="en"><a name="id310007"></a><h3>HELP [COMMAND]</h3><p>Gives usage information for the specified command.</p></div></div><div class="refsect1" lang="en"><a name="id310019"></a><h2>VERSION</h2><p>This man page is complete for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><a name="id310029"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The net manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/nmbd.8.html b/docs/htmldocs/manpages/nmbd.8.html new file mode 100644 index 0000000000..4d8a2f8bf2 --- /dev/null +++ b/docs/htmldocs/manpages/nmbd.8.html @@ -0,0 +1,147 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>nmbd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="nmbd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>nmbd — NetBIOS name server to provide NetBIOS + over IP naming services to clients</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">nmbd</code> [-D] [-F] [-S] [-a] [-i] [-o] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log directory>] [-p <port number>] [-s <configuration file>]</p></div></div><div class="refsect1" lang="en"><a name="id267087"></a><h2>DESCRIPTION</h2><p>This program is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">nmbd</code> is a server that understands + and can reply to NetBIOS over IP name service requests, like + those produced by SMB/CIFS clients such as Windows 95/98/ME, + Windows NT, Windows 2000, Windows XP and LanManager clients. It also + participates in the browsing protocols which make up the + Windows "Network Neighborhood" view.</p><p>SMB/CIFS clients, when they start up, may wish to + locate an SMB/CIFS server. That is, they wish to know what + IP number a specified host is using.</p><p>Amongst other services, <code class="literal">nmbd</code> will + listen for such requests, and if its own NetBIOS name is + specified it will respond with the IP number of the host it + is running on. Its "own NetBIOS name" is by + default the primary DNS name of the host it is running on, + but this can be overridden by the <a class="indexterm" name="id299225"></a>netbios name + in <code class="filename">smb.conf</code>. Thus <code class="literal">nmbd</code> will + reply to broadcast queries for its own name(s). Additional + names for <code class="literal">nmbd</code> to respond on can be set + via parameters in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> configuration file.</p><p><code class="literal">nmbd</code> can also be used as a WINS + (Windows Internet Name Server) server. What this basically means + is that it will act as a WINS database server, creating a + database from name registration requests that it receives and + replying to queries from clients for these names.</p><p>In addition, <code class="literal">nmbd</code> can act as a WINS + proxy, relaying broadcast queries from clients that do + not understand how to talk the WINS protocol to a WINS + server.</p></div><div class="refsect1" lang="en"><a name="id266718"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-D</span></dt><dd><p>If specified, this parameter causes + <code class="literal">nmbd</code> to operate as a daemon. That is, + it detaches itself and runs in the background, fielding + requests on the appropriate port. By default, <code class="literal">nmbd</code> + will operate as a daemon if launched from a command shell. + nmbd can also be operated from the <code class="literal">inetd</code> + meta-daemon, although this is not recommended. + </p></dd><dt><span class="term">-F</span></dt><dd><p>If specified, this parameter causes + the main <code class="literal">nmbd</code> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <code class="literal">nmbd</code> under process supervisors such + as <code class="literal">supervise</code> and <code class="literal">svscan</code> + from Daniel J. Bernstein's <code class="literal">daemontools</code> + package, or the AIX process monitor. + </p></dd><dt><span class="term">-S</span></dt><dd><p>If specified, this parameter causes + <code class="literal">nmbd</code> to log to standard output rather + than a file.</p></dd><dt><span class="term">-i</span></dt><dd><p>If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the + server is executed on the command line of a shell. Setting this + parameter negates the implicit daemon mode when run from the + command line. <code class="literal">nmbd</code> also logs to standard + output, as if the <code class="constant">-S</code> parameter had been + given. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-H <filename></span></dt><dd><p>NetBIOS lmhosts file. The lmhosts + file is a list of NetBIOS names to IP addresses that + is loaded by the nmbd server and used via the name + resolution mechanism <a class="indexterm" name="id266863"></a>name resolve order described in <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> to resolve any + NetBIOS name queries needed by the server. Note + that the contents of this file are <span class="emphasis"><em>NOT</em></span> + used by <code class="literal">nmbd</code> to answer any name queries. + Adding a line to this file affects name NetBIOS resolution + from this host <span class="emphasis"><em>ONLY</em></span>.</p><p>The default path to this file is compiled into + Samba as part of the build process. Common defaults + are <code class="filename">/usr/local/samba/lib/lmhosts</code>, + <code class="filename">/usr/samba/lib/lmhosts</code> or + <code class="filename">/etc/samba/lmhosts</code>. See the <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> man page for details on the contents of this file.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id307906"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-p <UDP port number></span></dt><dd><p>UDP port number is a positive integer value. + This option changes the default UDP port number (normally 137) + that <code class="literal">nmbd</code> responds to name queries on. Don't + use this option unless you are an expert, in which case you + won't need help!</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id307989"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/inetd.conf</code></span></dt><dd><p>If the server is to be run by the + <code class="literal">inetd</code> meta-daemon, this file + must contain suitable startup information for the + meta-daemon. + </p></dd><dt><span class="term"><code class="filename">/etc/rc</code></span></dt><dd><p>or whatever initialization script your + system uses).</p><p>If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server.</p></dd><dt><span class="term"><code class="filename">/etc/services</code></span></dt><dd><p>If running the server via the + meta-daemon <code class="literal">inetd</code>, this file + must contain a mapping of service name (e.g., netbios-ssn) + to service port (e.g., 139) and protocol type (e.g., tcp). + </p></dd><dt><span class="term"><code class="filename">/usr/local/samba/lib/smb.conf</code></span></dt><dd><p>This is the default location of + the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> server + configuration file. Other common places that systems + install this file are <code class="filename">/usr/samba/lib/smb.conf</code> + and <code class="filename">/etc/samba/smb.conf</code>.</p><p>When run as a WINS server (see the + <a class="indexterm" name="id308096"></a>wins support + parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> man page), + <code class="literal">nmbd</code> + will store the WINS database in the file <code class="filename">wins.dat</code> + in the <code class="filename">var/locks</code> directory configured under + wherever Samba was configured to install itself.</p><p>If <code class="literal">nmbd</code> is acting as a <span class="emphasis"><em> + browse master</em></span> (see the <a class="indexterm" name="id308143"></a>local master + parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> man page, <code class="literal">nmbd</code> + will store the browsing database in the file <code class="filename">browse.dat + </code> in the <code class="filename">var/locks</code> directory + configured under wherever Samba was configured to install itself. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308181"></a><h2>SIGNALS</h2><p>To shut down an <code class="literal">nmbd</code> process it is recommended + that SIGKILL (-9) <span class="emphasis"><em>NOT</em></span> be used, except as a last + resort, as this may leave the name database in an inconsistent state. + The correct way to terminate <code class="literal">nmbd</code> is to send it + a SIGTERM (-15) signal and wait for it to die on its own.</p><p><code class="literal">nmbd</code> will accept SIGHUP, which will cause + it to dump out its namelists into the file <code class="filename">namelist.debug + </code> in the <code class="filename">/usr/local/samba/var/locks</code> + directory (or the <code class="filename">var/locks</code> directory configured + under wherever Samba was configured to install itself). This will also + cause <code class="literal">nmbd</code> to dump out its server database in + the <code class="filename">log.nmb</code> file.</p><p>The debug log level of nmbd may be raised or lowered + using <a href="smbcontrol.1.html"><span class="citerefentry"><span class="refentrytitle">smbcontrol</span>(1)</span></a> (SIGUSR[1|2] signals + are no longer used since Samba 2.2). This is to allow + transient problems to be diagnosed, whilst still running + at a normally low log level.</p></div><div class="refsect1" lang="en"><a name="id308261"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308272"></a><h2>SEE ALSO</h2><p> + <a href="inetd.8.html"><span class="citerefentry"><span class="refentrytitle">inetd</span>(8)</span></a>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a>, <a href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a>, and the Internet + RFC's <code class="filename">rfc1001.txt</code>, <code class="filename">rfc1002.txt</code>. + In addition the CIFS (formerly SMB) specification is available + as a link from the Web page <a href="http://samba.org/cifs/" target="_top"> + http://samba.org/cifs/</a>.</p></div><div class="refsect1" lang="en"><a name="id308349"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/nmblookup.1.html b/docs/htmldocs/manpages/nmblookup.1.html new file mode 100644 index 0000000000..d4084372ad --- /dev/null +++ b/docs/htmldocs/manpages/nmblookup.1.html @@ -0,0 +1,105 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>nmblookup</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="nmblookup"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>nmblookup — NetBIOS over TCP/IP client used to lookup NetBIOS + names</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">nmblookup</code> [-M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>] [-T] [-f] {name}</p></div></div><div class="refsect1" lang="en"><a name="id299269"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">nmblookup</code> is used to query NetBIOS names + and map them to IP addresses in a network using NetBIOS over TCP/IP + queries. The options allow the name queries to be directed at a + particular IP broadcast area or to a particular machine. All queries + are done over UDP.</p></div><div class="refsect1" lang="en"><a name="id266732"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-M</span></dt><dd><p>Searches for a master browser by looking + up the NetBIOS name <em class="replaceable"><code>name</code></em> with a + type of <code class="constant">0x1d</code>. If <em class="replaceable"><code> + name</code></em> is "-" then it does a lookup on the special name + <code class="constant">__MSBROWSE__</code>. Please note that in order to + use the name "-", you need to make sure "-" isn't parsed as an + argument, e.g. use : + <strong class="userinput"><code>nmblookup -M -- -</code></strong>.</p></dd><dt><span class="term">-R</span></dt><dd><p>Set the recursion desired bit in the packet + to do a recursive lookup. This is used when sending a name + query to a machine running a WINS server and the user wishes + to query the names in the WINS server. If this bit is unset + the normal (broadcast responding) NetBIOS processing code + on a machine is used instead. See RFC1001, RFC1002 for details. + </p></dd><dt><span class="term">-S</span></dt><dd><p>Once the name query has returned an IP + address then do a node status query as well. A node status + query returns the NetBIOS names registered by a host. + </p></dd><dt><span class="term">-r</span></dt><dd><p>Try and bind to UDP port 137 to send and receive UDP + datagrams. The reason for this option is a bug in Windows 95 + where it ignores the source port of the requesting packet + and only replies to UDP port 137. Unfortunately, on most UNIX + systems root privilege is needed to bind to this port, and + in addition, if the <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> daemon is running on this machine it also binds to this port. + </p></dd><dt><span class="term">-A</span></dt><dd><p>Interpret <em class="replaceable"><code>name</code></em> as + an IP Address and do a node status query on this address.</p></dd><dt><span class="term">-n <primary NetBIOS name></span></dt><dd><p>This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the <a class="indexterm" name="id266847"></a> parameter in the <code class="filename">smb.conf</code> file. +However, a command +line setting will take precedence over settings in +<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i <scope></span></dt><dd><p>This specifies a NetBIOS scope that +<code class="literal">nmblookup</code> will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +<span class="emphasis"><em>very</em></span> rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O socket options</span></dt><dd><p>TCP socket options to set on the client +socket. See the socket options parameter in +the <code class="filename">smb.conf</code> manual page for the list of valid +options. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-B <broadcast address></span></dt><dd><p>Send the query to the given broadcast address. Without + this option the default behavior of nmblookup is to send the + query to the broadcast address of the network interfaces as + either auto-detected or defined in the <a href="smb.conf.5.html#INTERFACES" target="_top"><em class="parameter"><code>interfaces</code></em> + </a> parameter of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. + </p></dd><dt><span class="term">-U <unicast address></span></dt><dd><p>Do a unicast query to the specified address or + host <em class="replaceable"><code>unicast address</code></em>. This option + (along with the <em class="parameter"><code>-R</code></em> option) is needed to + query a WINS server.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id307894"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-T</span></dt><dd><p>This causes any IP addresses found in the + lookup to be looked up via a reverse DNS lookup into a + DNS name, and printed out before each</p><p><span class="emphasis"><em>IP address .... NetBIOS name</em></span></p><p> pair that is the normal output.</p></dd><dt><span class="term">-f</span></dt><dd><p> + Show which flags apply to the name that has been looked up. Possible + answers are zero or more of: Response, Authoritative, + Truncated, Recursion_Desired, Recursion_Available, Broadcast. + </p></dd><dt><span class="term">name</span></dt><dd><p>This is the NetBIOS name being queried. Depending + upon the previous options this may be a NetBIOS name or IP address. + If a NetBIOS name then the different name types may be specified + by appending '#<type>' to the name. This name may also be + '*', which will return all registered names within a broadcast + area.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308003"></a><h2>EXAMPLES</h2><p><code class="literal">nmblookup</code> can be used to query + a WINS server (in the same way <code class="literal">nslookup</code> is + used to query DNS servers). To query a WINS server, <code class="literal">nmblookup</code> + must be called like this:</p><p><code class="literal">nmblookup -U server -R 'name'</code></p><p>For example, running :</p><p><code class="literal">nmblookup -U samba.org -R 'IRIX#1B'</code></p><p>would query the WINS server samba.org for the domain + master browser (1B name type) for the IRIX workgroup.</p></div><div class="refsect1" lang="en"><a name="id308052"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308063"></a><h2>SEE ALSO</h2><p><a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>, and <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id308095"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/ntlm_auth.1.html b/docs/htmldocs/manpages/ntlm_auth.1.html new file mode 100644 index 0000000000..18c77834ed --- /dev/null +++ b/docs/htmldocs/manpages/ntlm_auth.1.html @@ -0,0 +1,157 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ntlm_auth</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ntlm-auth.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ntlm_auth — tool to allow external access to Winbind's NTLM authentication function</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">ntlm_auth</code> [-d debuglevel] [-l logdir] [-s <smb config file>]</p></div></div><div class="refsect1" lang="en"><a name="id267695"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">ntlm_auth</code> is a helper utility that authenticates + users using NT/LM authentication. It returns 0 if the users is authenticated + successfully and 1 if access was denied. ntlm_auth uses winbind to access + the user and authentication data for a domain. This utility + is only indended to be used by other programs (currently + <a href="http://www.squid-cache.org/" target="_top">Squid</a> + and <a href="http://download.samba.org/ftp/unpacked/lorikeet/trunk/mod_ntlm_winbind/" target="_top">mod_ntlm_winbind</a>) + </p></div><div class="refsect1" lang="en"><a name="id299225"></a><h2>OPERATIONAL REQUIREMENTS</h2><p> + The <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon must be operational + for many of these commands to function.</p><p>Some of these commands also require access to the directory + <code class="filename">winbindd_privileged</code> in + <code class="filename">$LOCKDIR</code>. This should be done either by running + this command as root or providing group access + to the <code class="filename">winbindd_privileged</code> directory. For + security reasons, this directory should not be world-accessable. </p></div><div class="refsect1" lang="en"><a name="id299266"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">--helper-protocol=PROTO</span></dt><dd><p> + Operate as a stdio-based helper. Valid helper protocols are: + </p><div class="variablelist"><dl><dt><span class="term">squid-2.4-basic</span></dt><dd><p> + Server-side helper for use with Squid 2.4's basic (plaintext) + authentication. </p></dd><dt><span class="term">squid-2.5-basic</span></dt><dd><p> + Server-side helper for use with Squid 2.5's basic (plaintext) + authentication. </p></dd><dt><span class="term">squid-2.5-ntlmssp</span></dt><dd><p> + Server-side helper for use with Squid 2.5's NTLMSSP + authentication. </p><p>Requires access to the directory + <code class="filename">winbindd_privileged</code> in + <code class="filename">$LOCKDIR</code>. The protocol used is + described here: <a href="http://devel.squid-cache.org/ntlm/squid_helper_protocol.html" target="_top">http://devel.squid-cache.org/ntlm/squid_helper_protocol.html</a>. + This protocol has been extended to allow the + NTLMSSP Negotiate packet to be included as an argument + to the <code class="literal">YR</code> command. (Thus avoiding + loss of information in the protocol exchange). + </p></dd><dt><span class="term">ntlmssp-client-1</span></dt><dd><p> + Client-side helper for use with arbitrary external + programs that may wish to use Samba's NTLMSSP + authentication knowledge. </p><p>This helper is a client, and as such may be run by any + user. The protocol used is + effectively the reverse of the previous protocol. A + <code class="literal">YR</code> command (without any arguments) + starts the authentication exchange. + </p></dd><dt><span class="term">gss-spnego</span></dt><dd><p> + Server-side helper that implements GSS-SPNEGO. This + uses a protocol that is almost the same as + <code class="literal">squid-2.5-ntlmssp</code>, but has some + subtle differences that are undocumented outside the + source at this stage. + </p><p>Requires access to the directory + <code class="filename">winbindd_privileged</code> in + <code class="filename">$LOCKDIR</code>. + </p></dd><dt><span class="term">gss-spnego-client</span></dt><dd><p> + Client-side helper that implements GSS-SPNEGO. This + also uses a protocol similar to the above helpers, but + is currently undocumented. + </p></dd><dt><span class="term">ntlm-server-1</span></dt><dd><p> + Server-side helper protocol, intended for use by a + RADIUS server or the 'winbind' plugin for pppd, for + the provision of MSCHAP and MSCHAPv2 authentication. + </p><p>This protocol consists of lines in the form: + <code class="literal">Parameter: value</code> and <code class="literal">Parameter:: + Base64-encode value</code>. The presence of a single + period <code class="literal">.</code> indicates that one side has + finished supplying data to the other. (Which in turn + could cause the helper to authenticate the + user). </p><p>Curently implemented parameters from the + external program to the helper are:</p><div class="variablelist"><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3>Implementors should take care to base64 encode + any data (such as usernames/passwords) that may contain malicous user data, such as + a newline. They may also need to decode strings from + the helper, which likewise may have been base64 encoded.</div><dl><dt><span class="term">Username</span></dt><dd><p>The username, expected to be in + Samba's <a class="indexterm" name="id266937"></a>unix charset. + </p><div class="example"><a name="id266946"></a><p class="title"><b>Example 1. </b></p><div class="example-contents">Username: bob</div></div><p><br class="example-break"></p><div class="example"><a name="id266950"></a><p class="title"><b>Example 2. </b></p><div class="example-contents">Username:: Ym9i</div></div><p><br class="example-break"></p></dd><dt><span class="term">Username</span></dt><dd><p>The user's domain, expected to be in + Samba's <a class="indexterm" name="id266964"></a>unix charset. + </p><div class="example"><a name="id266973"></a><p class="title"><b>Example 3. </b></p><div class="example-contents">Domain: WORKGROUP</div></div><p><br class="example-break"></p><div class="example"><a name="id266978"></a><p class="title"><b>Example 4. </b></p><div class="example-contents">Domain:: V09SS0dST1VQ</div></div><p><br class="example-break"></p></dd><dt><span class="term">Full-Username</span></dt><dd><p>The fully qualified username, expected to be in + Samba's <a class="indexterm" name="id266991"></a> and qualified with the + <a class="indexterm" name="id266997"></a>winbind separator. + </p><div class="example"><a name="id267007"></a><p class="title"><b>Example 5. </b></p><div class="example-contents">Full-Username: WORKGROUP\bob</div></div><p><br class="example-break"></p><div class="example"><a name="id267011"></a><p class="title"><b>Example 6. </b></p><div class="example-contents">Full-Username:: V09SS0dST1VQYm9i</div></div><p><br class="example-break"></p></dd><dt><span class="term">LANMAN-Challenge</span></dt><dd><p>The 8 byte <code class="literal">LANMAN Challenge</code> value, + generated randomly by the server, or (in cases such as + MSCHAPv2) generated in some way by both the server and + the client. + </p><div class="example"><a name="id307893"></a><p class="title"><b>Example 7. </b></p><div class="example-contents">LANMAN-Challege: 0102030405060708</div></div><p><br class="example-break"></p></dd><dt><span class="term">LANMAN-Response</span></dt><dd><p>The 24 byte <code class="literal">LANMAN Response</code> value, + calculated from the user's password and the supplied + <code class="literal">LANMAN Challenge</code>. Typically, this + is provided over the network by a client wishing to authenticate. + </p><div class="example"><a name="id307922"></a><p class="title"><b>Example 8. </b></p><div class="example-contents">LANMAN-Response: 0102030405060708090A0B0C0D0E0F101112131415161718</div></div><p><br class="example-break"></p></dd><dt><span class="term">NT-Response</span></dt><dd><p>The >= 24 byte <code class="literal">NT Response</code> + calculated from the user's password and the supplied + <code class="literal">LANMAN Challenge</code>. Typically, this is + provided over the network by a client wishing to authenticate. + </p><div class="example"><a name="id307952"></a><p class="title"><b>Example 9. </b></p><div class="example-contents">NT-Response: 0102030405060708090A0B0C0D0E0F101112131415161718</div></div><p><br class="example-break"></p></dd><dt><span class="term">Password</span></dt><dd><p>The user's password. This would be + provided by a network client, if the helper is being + used in a legacy situation that exposes plaintext + passwords in this way. + </p><div class="example"><a name="id307970"></a><p class="title"><b>Example 10. </b></p><div class="example-contents">Password: samba2</div></div><p><br class="example-break"></p><div class="example"><a name="id307974"></a><p class="title"><b>Example 11. </b></p><div class="example-contents">Password:: c2FtYmEy</div></div><p><br class="example-break"></p></dd><dt><span class="term">Request-User-Session-Key</span></dt><dd><p>Apon sucessful authenticaiton, return + the user session key associated with the login. + </p><div class="example"><a name="id307991"></a><p class="title"><b>Example 12. </b></p><div class="example-contents">Request-User-Session-Key: Yes</div></div><p><br class="example-break"></p></dd><dt><span class="term">Request-LanMan-Session-Key</span></dt><dd><p>Apon sucessful authenticaiton, return + the LANMAN session key associated with the login. + </p><div class="example"><a name="id308008"></a><p class="title"><b>Example 13. </b></p><div class="example-contents">Request-LanMan-Session-Key: Yes</div></div><p><br class="example-break"></p></dd></dl></div></dd></dl></div></dd><dt><span class="term">--username=USERNAME</span></dt><dd><p> + Specify username of user to authenticate + </p></dd><dt><span class="term">--domain=DOMAIN</span></dt><dd><p> + Specify domain of user to authenticate + </p></dd><dt><span class="term">--workstation=WORKSTATION</span></dt><dd><p> + Specify the workstation the user authenticated from + </p></dd><dt><span class="term">--challenge=STRING</span></dt><dd><p>NTLM challenge (in HEXADECIMAL)</p></dd><dt><span class="term">--lm-response=RESPONSE</span></dt><dd><p>LM Response to the challenge (in HEXADECIMAL)</p></dd><dt><span class="term">--nt-response=RESPONSE</span></dt><dd><p>NT or NTLMv2 Response to the challenge (in HEXADECIMAL)</p></dd><dt><span class="term">--password=PASSWORD</span></dt><dd><p>User's plaintext password</p><p>If + not specified on the command line, this is prompted for when + required. </p><p>For the NTLMSSP based server roles, this parameter + specifies the expected password, allowing testing without + winbindd operational.</p></dd><dt><span class="term">--request-lm-key</span></dt><dd><p>Retreive LM session key</p></dd><dt><span class="term">--request-nt-key</span></dt><dd><p>Request NT key</p></dd><dt><span class="term">--diagnostics</span></dt><dd><p>Perform Diagnostics on the authentication + chain. Uses the password from <code class="literal">--password</code> + or prompts for one.</p></dd><dt><span class="term">--require-membership-of={SID|Name}</span></dt><dd><p>Require that a user be a member of specified + group (either name or SID) for authentication to succeed.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id308198"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308275"></a><h2>EXAMPLE SETUP</h2><p>To setup ntlm_auth for use by squid 2.5, with both basic and + NTLMSSP authentication, the following + should be placed in the <code class="filename">squid.conf</code> file. +</p><pre class="programlisting"> +auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp +auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic +auth_param basic children 5 +auth_param basic realm Squid proxy-caching web server +auth_param basic credentialsttl 2 hours +</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This example assumes that ntlm_auth has been installed into your + path, and that the group permissions on + <code class="filename">winbindd_privileged</code> are as described above.</p></div><p>To setup ntlm_auth for use by squid 2.5 with group limitation in addition to the above + example, the following should be added to the <code class="filename">squid.conf</code> file. +</p><pre class="programlisting"> +auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp --require-membership-of='WORKGROUP\Domain Users' +auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic --require-membership-of='WORKGROUP\Domain Users' +</pre></div><div class="refsect1" lang="en"><a name="id308327"></a><h2>TROUBLESHOOTING</h2><p>If you're experiencing problems with authenticating Internet Explorer running + under MS Windows 9X or Millenium Edition against ntlm_auth's NTLMSSP authentication + helper (--helper-protocol=squid-2.5-ntlmssp), then please read + <a href="http://support.microsoft.com/support/kb/articles/Q239/8/69.ASP" target="_top"> + the Microsoft Knowledge Base article #239869 and follow instructions described there</a>. + </p></div><div class="refsect1" lang="en"><a name="id308346"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><a name="id308356"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The ntlm_auth manpage was written by Jelmer Vernooij and + Andrew Bartlett.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/pam_winbind.7.html b/docs/htmldocs/manpages/pam_winbind.7.html new file mode 100644 index 0000000000..697ecbc784 --- /dev/null +++ b/docs/htmldocs/manpages/pam_winbind.7.html @@ -0,0 +1,61 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>pam_winbind</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="pam_winbind.7"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>pam_winbind — PAM module for Winbind</p></div><div class="refsect1" lang="en"><a name="id267380"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p> + pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon. + </p></div><div class="refsect1" lang="en"><a name="id267683"></a><h2>OPTIONS</h2><p> + + pam_winbind supports several options which can either be set in + the PAM configuration files or in the pam_winbind configuration + file situated at + <code class="filename">/etc/security/pam_winbind.conf</code>. Options + from the PAM configuration file take precedence to those from + the configuration file. + + </p><div class="variablelist"><dl><dt><span class="term">debug</span></dt><dd><p>Gives debugging output to syslog.</p></dd><dt><span class="term">debug_state</span></dt><dd><p>Gives detailed PAM state debugging output to syslog.</p></dd><dt><span class="term">require_membership_of=[SID or NAME]</span></dt><dd><p> + If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME. A SID + can be either a group-SID, an alias-SID or even an user-SID. It is also possible to give a NAME instead of the + SID. That name must have the form: <em class="parameter"><code>MYDOMAIN\\mygroup</code></em> or + <em class="parameter"><code>MYDOMAIN\\myuser</code></em>. pam_winbind will, in that case, lookup the SID internally. Note that + NAME may not contain any spaces. It is thus recommended to only use SIDs. You can verify the list of SIDs a + user is a member of with <code class="literal">wbinfo --user-sids=SID</code>. + </p></dd><dt><span class="term">try_first_pass</span></dt><dd><p></p></dd><dt><span class="term">use_first_pass</span></dt><dd><p> + By default, pam_winbind tries to get the authentication token from a previous module. If no token is available + it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication + token from a previous module is available. + </p></dd><dt><span class="term">use_authtok</span></dt><dd><p> + Set the new password to the one provided by the previously stacked password module. If this option is not set + pam_winbind will ask the user for the new password. + </p></dd><dt><span class="term">krb5_auth</span></dt><dd><p> + + pam_winbind can authenticate using Kerberos when winbindd is + talking to an Active Directory domain controller. Kerberos + authentication must be enabled with this parameter. When + Kerberos authentication can not succeed (e.g. due to clock + skew), winbindd will fallback to samlogon authentication over + MSRPC. When this parameter is used in conjunction with + <em class="parameter"><code>winbind refresh tickets</code></em>, winbind will + keep your Ticket Granting Ticket (TGT) uptodate by refreshing + it whenever necessary. + + </p></dd><dt><span class="term">krb5_ccache_type=[type]</span></dt><dd><p> + + When pam_winbind is configured to try kerberos authentication + by enabling the <em class="parameter"><code>krb5_auth</code></em> option, it can + store the retrieved Ticket Granting Ticket (TGT) in a + credential cache. The type of credential cache can be set with + this option. Currently the only supported value is: + <em class="parameter"><code>FILE</code></em>. In that case a credential cache in + the form of /tmp/krb5cc_UID will be created, where UID is + replaced with the numeric user id. Leave empty to just do + kerberos authentication without having a ticket cache after the + logon has succeeded. + + </p></dd><dt><span class="term">cached_login</span></dt><dd><p> + Winbind allows to logon using cached credentials when <em class="parameter"><code>winbind offline logon</code></em> is enabled. To use this feature from the PAM module this option must be set. + </p></dd><dt><span class="term">silent</span></dt><dd><p> + Do not emit any messages. + </p></dd></dl></div><p> + + + </p></div><div class="refsect1" lang="en"><a name="id266792"></a><h2>SEE ALSO</h2><p><a href="wbinfo.1.html"><span class="citerefentry"><span class="refentrytitle">wbinfo</span>(1)</span></a>, <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><a name="id266827"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of Samba.</p></div><div class="refsect1" lang="en"><a name="id266837"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by + the Samba Team as an Open Source project similar to the way the Linux kernel is developed. + </p><p>This manpage was written by Jelmer Vernooij and Guenther Deschner.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/pdbedit.8.html b/docs/htmldocs/manpages/pdbedit.8.html new file mode 100644 index 0000000000..15122a414f --- /dev/null +++ b/docs/htmldocs/manpages/pdbedit.8.html @@ -0,0 +1,151 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>pdbedit</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="pdbedit.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>pdbedit — manage the SAM database (Database of Samba Users)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">pdbedit</code> [-L] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-t, --password-from-stdin] [-m] [-r] [-x] [-i passdb-backend] [-e passdb-backend] [-b passdb-backend] [-g] [-d debuglevel] [-s configfile] [-P account-policy] [-C value] [-c account-control] [-y]</p></div></div><div class="refsect1" lang="en"><a name="id266779"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The pdbedit program is used to manage the users accounts + stored in the sam database and can only be run by root.</p><p>The pdbedit tool uses the passdb modular interface and is + independent from the kind of users database used (currently there + are smbpasswd, ldap, nis+ and tdb based and more can be added + without changing the tool).</p><p>There are five main ways to use pdbedit: adding a user account, + removing a user account, modifing a user account, listing user + accounts, importing users accounts.</p></div><div class="refsect1" lang="en"><a name="id266812"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-L</span></dt><dd><p>This option lists all the user accounts + present in the users database. + This option prints a list of user/uid pairs separated by + the ':' character.</p><p>Example: <code class="literal">pdbedit -L</code></p><pre class="programlisting"> +sorce:500:Simo Sorce +samba:45:Test User +</pre></dd><dt><span class="term">-v</span></dt><dd><p>This option enables the verbose listing format. + It causes pdbedit to list the users in the database, printing + out the account fields in a descriptive format.</p><p>Example: <code class="literal">pdbedit -L -v</code></p><pre class="programlisting"> +--------------- +username: sorce +user ID/Group: 500/500 +user RID/GRID: 2000/2001 +Full Name: Simo Sorce +Home Directory: \\BERSERKER\sorce +HomeDir Drive: H: +Logon Script: \\BERSERKER\netlogon\sorce.bat +Profile Path: \\BERSERKER\profile +--------------- +username: samba +user ID/Group: 45/45 +user RID/GRID: 1090/1091 +Full Name: Test User +Home Directory: \\BERSERKER\samba +HomeDir Drive: +Logon Script: +Profile Path: \\BERSERKER\profile +</pre></dd><dt><span class="term">-w</span></dt><dd><p>This option sets the "smbpasswd" listing format. + It will make pdbedit list the users in the database, printing + out the account fields in a format compatible with the + <code class="filename">smbpasswd</code> file format. (see the + <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> for details)</p><p>Example: <code class="literal">pdbedit -L -w</code></p><pre class="programlisting"> +sorce:500:508818B733CE64BEAAD3B435B51404EE: + D2A2418EFC466A8A0F6B1DBB5C3DB80C: + [UX ]:LCT-00000000: +samba:45:0F2B255F7B67A7A9AAD3B435B51404EE: + BC281CE3F53B6A5146629CD4751D3490: + [UX ]:LCT-3BFA1E8D: +</pre></dd><dt><span class="term">-u username</span></dt><dd><p>This option specifies the username to be + used for the operation requested (listing, adding, removing). + It is <span class="emphasis"><em>required</em></span> in add, remove and modify + operations and <span class="emphasis"><em>optional</em></span> in list + operations.</p></dd><dt><span class="term">-f fullname</span></dt><dd><p>This option can be used while adding or + modifing a user account. It will specify the user's full + name. </p><p>Example: <code class="literal">-f "Simo Sorce"</code></p></dd><dt><span class="term">-h homedir</span></dt><dd><p>This option can be used while adding or + modifing a user account. It will specify the user's home + directory network path.</p><p>Example: <code class="literal">-h "\\\\BERSERKER\\sorce"</code> + </p></dd><dt><span class="term">-D drive</span></dt><dd><p>This option can be used while adding or + modifing a user account. It will specify the windows drive + letter to be used to map the home directory.</p><p>Example: <code class="literal">-D "H:"</code> + </p></dd><dt><span class="term">-S script</span></dt><dd><p>This option can be used while adding or + modifing a user account. It will specify the user's logon + script path.</p><p>Example: <code class="literal">-S "\\\\BERSERKER\\netlogon\\sorce.bat"</code> + </p></dd><dt><span class="term">-p profile</span></dt><dd><p>This option can be used while adding or + modifing a user account. It will specify the user's profile + directory.</p><p>Example: <code class="literal">-p "\\\\BERSERKER\\netlogon"</code> + </p></dd><dt><span class="term">-G SID|rid</span></dt><dd><p> + This option can be used while adding or modifying a user account. It + will specify the users' new primary group SID (Security Identifier) or + rid. </p><p>Example: <code class="literal">-G S-1-5-21-2447931902-1787058256-3961074038-1201</code></p></dd><dt><span class="term">-U SID|rid</span></dt><dd><p> + This option can be used while adding or modifying a user account. It + will specify the users' new SID (Security Identifier) or + rid. </p><p>Example: <code class="literal">-U S-1-5-21-2447931902-1787058256-3961074038-5004</code></p></dd><dt><span class="term">-c account-control</span></dt><dd><p>This option can be used while adding or modifying a user + account. It will specify the users' account control property. Possible flags are listed below. + </p><p> + </p><div class="itemizedlist"><ul type="disc"><li><p>N: No password required</p></li><li><p>D: Account disabled</p></li><li><p>H: Home directory required</p></li><li><p>T: Temporary duplicate of other account</p></li><li><p>U: Regular user account</p></li><li><p>M: MNS logon user account</p></li><li><p>W: Workstation Trust Account</p></li><li><p>S: Server Trust Account</p></li><li><p>L: Automatic Locking</p></li><li><p>X: Password does not expire</p></li><li><p>I: Domain Trust Account</p></li></ul></div><p> + </p><p>Example: <code class="literal">-c "[X ]"</code></p></dd><dt><span class="term">-a</span></dt><dd><p>This option is used to add a user into the + database. This command needs a user name specified with + the -u switch. When adding a new user, pdbedit will also + ask for the password to be used.</p><p>Example: <code class="literal">pdbedit -a -u sorce</code> +</p><pre class="programlisting">new password: +retype new password +</pre><p> +</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>pdbedit does not call the unix password syncronisation + script if <a class="indexterm" name="id308083"></a>unix password sync + has been set. It only updates the data in the Samba + user database. + </p><p>If you wish to add a user and synchronise the password + that immediately, use <code class="literal">smbpasswd</code>'s <code class="option">-a</code> option. + </p></div></dd><dt><span class="term">-t, --password-from-stdin</span></dt><dd><p>This option causes pdbedit to read the password + from standard input, rather than from /dev/tty (like the + <code class="literal">passwd(1)</code> program does). The password has + to be submitted twice and terminated by a newline each.</p></dd><dt><span class="term">-r</span></dt><dd><p>This option is used to modify an existing user + in the database. This command needs a user name specified with the -u + switch. Other options can be specified to modify the properties of + the specified user. This flag is kept for backwards compatibility, but + it is no longer necessary to specify it. + </p></dd><dt><span class="term">-m</span></dt><dd><p>This option may only be used in conjunction + with the <em class="parameter"><code>-a</code></em> option. It will make + pdbedit to add a machine trust account instead of a user + account (-u username will provide the machine name).</p><p>Example: <code class="literal">pdbedit -a -m -u w2k-wks</code> + </p></dd><dt><span class="term">-x</span></dt><dd><p>This option causes pdbedit to delete an account + from the database. It needs a username specified with the + -u switch.</p><p>Example: <code class="literal">pdbedit -x -u bob</code></p></dd><dt><span class="term">-i passdb-backend</span></dt><dd><p>Use a different passdb backend to retrieve users + than the one specified in smb.conf. Can be used to import data into + your local user database.</p><p>This option will ease migration from one passdb backend to + another.</p><p>Example: <code class="literal">pdbedit -i smbpasswd:/etc/smbpasswd.old + </code></p></dd><dt><span class="term">-e passdb-backend</span></dt><dd><p>Exports all currently available users to the + specified password database backend.</p><p>This option will ease migration from one passdb backend to + another and will ease backing up.</p><p>Example: <code class="literal">pdbedit -e smbpasswd:/root/samba-users.backup</code></p></dd><dt><span class="term">-g</span></dt><dd><p>If you specify <em class="parameter"><code>-g</code></em>, + then <em class="parameter"><code>-i in-backend -e out-backend</code></em> + applies to the group mapping instead of the user database.</p><p>This option will ease migration from one passdb backend to + another and will ease backing up.</p></dd><dt><span class="term">-b passdb-backend</span></dt><dd><p>Use a different default passdb backend. </p><p>Example: <code class="literal">pdbedit -b xml:/root/pdb-backup.xml -l</code></p></dd><dt><span class="term">-P account-policy</span></dt><dd><p>Display an account policy</p><p>Valid policies are: minimum password age, reset count minutes, disconnect time, + user must logon to change password, password history, lockout duration, min password length, + maximum password age and bad lockout attempt.</p><p>Example: <code class="literal">pdbedit -P "bad lockout attempt"</code></p><pre class="programlisting"> +account policy value for bad lockout attempt is 0 +</pre></dd><dt><span class="term">-C account-policy-value</span></dt><dd><p>Sets an account policy to a specified value. + This option may only be used in conjunction + with the <em class="parameter"><code>-P</code></em> option. + </p><p>Example: <code class="literal">pdbedit -P "bad lockout attempt" -C 3</code></p><pre class="programlisting"> +account policy value for bad lockout attempt was 0 +account policy value for bad lockout attempt is now 3 +</pre></dd><dt><span class="term">-y</span></dt><dd><p>If you specify <em class="parameter"><code>-y</code></em>, + then <em class="parameter"><code>-i in-backend -e out-backend</code></em> + applies to the account policies instead of the user database.</p><p>This option will allow to migrate account policies from their default + tdb-store into a passdb backend, e.g. an LDAP directory server.</p><p>Example: <code class="literal">pdbedit -y -i tdbsam: -e ldapsam:ldap://my.ldap.host</code></p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id308437"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308501"></a><h2>NOTES</h2><p>This command may be used only by root.</p></div><div class="refsect1" lang="en"><a name="id308512"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308522"></a><h2>SEE ALSO</h2><p><a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>, <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a></p></div><div class="refsect1" lang="en"><a name="id308546"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/profiles.1.html b/docs/htmldocs/manpages/profiles.1.html new file mode 100644 index 0000000000..c820bcac0f --- /dev/null +++ b/docs/htmldocs/manpages/profiles.1.html @@ -0,0 +1,12 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>profiles</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="profiles.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>profiles — A utility to report and change SIDs in registry files + </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">profiles</code> [-v] [-c SID] [-n SID] {file}</p></div></div><div class="refsect1" lang="en"><a name="id267702"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">profiles</code> is a utility that + reports and changes SIDs in windows registry files. It currently only + supports NT. + </p></div><div class="refsect1" lang="en"><a name="id299219"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">file</span></dt><dd><p>Registry file to view or edit. </p></dd><dt><span class="term">-v,--verbose</span></dt><dd><p>Increases verbosity of messages. + </p></dd><dt><span class="term">-c SID1 -n SID2</span></dt><dd><p>Change all occurences of SID1 in <code class="filename">file</code> by SID2. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266714"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><a name="id266725"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The profiles man page was written by Jelmer Vernooij. </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/rpcclient.1.html b/docs/htmldocs/manpages/rpcclient.1.html new file mode 100644 index 0000000000..ef9b4bc532 --- /dev/null +++ b/docs/htmldocs/manpages/rpcclient.1.html @@ -0,0 +1,206 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>rpcclient</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="rpcclient.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>rpcclient — tool for executing client side + MS-RPC functions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">rpcclient</code> [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logdir] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}</p></div></div><div class="refsect1" lang="en"><a name="id299254"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">rpcclient</code> is a utility initially developed + to test MS-RPC functionality in Samba itself. It has undergone + several stages of development and stability. Many system administrators + have now written scripts around it to manage Windows NT clients from + their UNIX workstation. </p></div><div class="refsect1" lang="en"><a name="id266717"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">server</span></dt><dd><p>NetBIOS name of Server to which to connect. + The server can be any SMB/CIFS server. The name is + resolved using the <a class="indexterm" name="id266734"></a>name resolve order line from <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></dd><dt><span class="term">-c|--command='command string'</span></dt><dd><p>execute semicolon separated commands (listed + below)) </p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><em class="replaceable"><code>IP address</code></em> is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named + SMB/CIFS server by looking it up via the NetBIOS name resolution + mechanism described above in the <em class="parameter"><code>name resolve order</code></em> + parameter above. Using this parameter will force the client + to assume that the server is on the machine with the specified IP + address and the NetBIOS name component of the resource being + connected to will be ignored. </p><p>There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above. </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266823"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.</p><p>If a password is specified on the command line and this +option is also defined the password on the command line will +be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k</span></dt><dd><p> +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +</p><pre class="programlisting"> +username = <value> +password = <value> +domain = <value> +</pre><p>Make certain that the permissions on the file restrict +access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The +client will first check the <code class="envar">USER</code> environment variable, then the +<code class="envar">LOGNAME</code> variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the <code class="literal">ps</code> command. To be safe always allow +<code class="literal">rpcclient</code> to prompt for a password and type +it in directly. </p></dd><dt><span class="term">-n <primary NetBIOS name></span></dt><dd><p>This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the <a class="indexterm" name="id307888"></a> parameter in the <code class="filename">smb.conf</code> file. +However, a command +line setting will take precedence over settings in +<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i <scope></span></dt><dd><p>This specifies a NetBIOS scope that +<code class="literal">nmblookup</code> will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +<span class="emphasis"><em>very</em></span> rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O socket options</span></dt><dd><p>TCP socket options to set on the client +socket. See the socket options parameter in +the <code class="filename">smb.conf</code> manual page for the list of valid +options. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id307973"></a><h2>COMMANDS</h2><div class="refsect2" lang="en"><a name="id307979"></a><h3>LSARPC</h3><div class="variablelist"><dl><dt><span class="term">lsaquery</span></dt><dd><p>Query info policy</p></dd><dt><span class="term">lookupsids</span></dt><dd><p>Resolve a list + of SIDs to usernames. + </p></dd><dt><span class="term">lookupnames</span></dt><dd><p>Resolve a list + of usernames to SIDs. + </p></dd><dt><span class="term">enumtrusts</span></dt><dd><p>Enumerate trusted domains</p></dd><dt><span class="term">enumprivs</span></dt><dd><p>Enumerate privileges</p></dd><dt><span class="term">getdispname</span></dt><dd><p>Get the privilege name</p></dd><dt><span class="term">lsaenumsid</span></dt><dd><p>Enumerate the LSA SIDS</p></dd><dt><span class="term">lsaenumprivsaccount</span></dt><dd><p>Enumerate the privileges of an SID</p></dd><dt><span class="term">lsaenumacctrights</span></dt><dd><p>Enumerate the rights of an SID</p></dd><dt><span class="term">lsaenumacctwithright</span></dt><dd><p>Enumerate accounts with a right</p></dd><dt><span class="term">lsaaddacctrights</span></dt><dd><p>Add rights to an account</p></dd><dt><span class="term">lsaremoveacctrights</span></dt><dd><p>Remove rights from an account</p></dd><dt><span class="term">lsalookupprivvalue</span></dt><dd><p>Get a privilege value given its name</p></dd><dt><span class="term">lsaquerysecobj</span></dt><dd><p>Query LSA security object</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id308103"></a><h3>LSARPC-DS</h3><div class="variablelist"><dl><dt><span class="term">dsroledominfo</span></dt><dd><p>Get Primary Domain Information</p></dd></dl></div><p> </p><p><span class="emphasis"><em>DFS</em></span></p><div class="variablelist"><dl><dt><span class="term">dfsexist</span></dt><dd><p>Query DFS support</p></dd><dt><span class="term">dfsadd</span></dt><dd><p>Add a DFS share</p></dd><dt><span class="term">dfsremove</span></dt><dd><p>Remove a DFS share</p></dd><dt><span class="term">dfsgetinfo</span></dt><dd><p>Query DFS share info</p></dd><dt><span class="term">dfsenum</span></dt><dd><p>Enumerate dfs shares</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id308172"></a><h3>REG</h3><div class="variablelist"><dl><dt><span class="term">shutdown</span></dt><dd><p>Remote Shutdown</p></dd><dt><span class="term">abortshutdown</span></dt><dd><p>Abort Shutdown</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id308197"></a><h3>SRVSVC</h3><div class="variablelist"><dl><dt><span class="term">srvinfo</span></dt><dd><p>Server query info</p></dd><dt><span class="term">netshareenum</span></dt><dd><p>Enumerate shares</p></dd><dt><span class="term">netfileenum</span></dt><dd><p>Enumerate open files</p></dd><dt><span class="term">netremotetod</span></dt><dd><p>Fetch remote time of day</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id308239"></a><h3>SAMR</h3><div class="variablelist"><dl><dt><span class="term">queryuser</span></dt><dd><p>Query user info</p></dd><dt><span class="term">querygroup</span></dt><dd><p>Query group info</p></dd><dt><span class="term">queryusergroups</span></dt><dd><p>Query user groups</p></dd><dt><span class="term">querygroupmem</span></dt><dd><p>Query group membership</p></dd><dt><span class="term">queryaliasmem</span></dt><dd><p>Query alias membership</p></dd><dt><span class="term">querydispinfo</span></dt><dd><p>Query display info</p></dd><dt><span class="term">querydominfo</span></dt><dd><p>Query domain info</p></dd><dt><span class="term">enumdomusers</span></dt><dd><p>Enumerate domain users</p></dd><dt><span class="term">enumdomgroups</span></dt><dd><p>Enumerate domain groups</p></dd><dt><span class="term">enumalsgroups</span></dt><dd><p>Enumerate alias groups</p></dd><dt><span class="term">createdomuser</span></dt><dd><p>Create domain user</p></dd><dt><span class="term">samlookupnames</span></dt><dd><p>Look up names</p></dd><dt><span class="term">samlookuprids</span></dt><dd><p>Look up names</p></dd><dt><span class="term">deletedomuser</span></dt><dd><p>Delete domain user</p></dd><dt><span class="term">samquerysecobj</span></dt><dd><p>Query SAMR security object</p></dd><dt><span class="term">getdompwinfo</span></dt><dd><p>Retrieve domain password info</p></dd><dt><span class="term">lookupdomain</span></dt><dd><p>Look up domain</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id308385"></a><h3>SPOOLSS</h3><div class="variablelist"><dl><dt><span class="term">adddriver <arch> <config> [<version>]</span></dt><dd><p> + Execute an AddPrinterDriver() RPC to install the printer driver + information on the server. Note that the driver files should + already exist in the directory returned by + <code class="literal">getdriverdir</code>. Possible values for + <em class="parameter"><code>arch</code></em> are the same as those for + the <code class="literal">getdriverdir</code> command. + The <em class="parameter"><code>config</code></em> parameter is defined as + follows: </p><pre class="programlisting"> +Long Printer Name:\ +Driver File Name:\ +Data File Name:\ +Config File Name:\ +Help File Name:\ +Language Monitor Name:\ +Default Data Type:\ +Comma Separated list of Files +</pre><p>Any empty fields should be enter as the string "NULL". </p><p>Samba does not need to support the concept of Print Monitors + since these only apply to local printers whose driver can make + use of a bi-directional link for communication. This field should + be "NULL". On a remote NT print server, the Print Monitor for a + driver must already be installed prior to adding the driver or + else the RPC will fail. </p><p>The <em class="parameter"><code>version</code></em> parameter lets you + specify the printer driver version number. If omitted, the + default driver version for the specified architecture will + be used. This option can be used to upload Windows 2000 + (version 3) printer drivers.</p></dd><dt><span class="term">addprinter <printername> + <sharename> <drivername> <port></span></dt><dd><p> + Add a printer on the remote server. This printer + will be automatically shared. Be aware that the printer driver + must already be installed on the server (see <code class="literal">adddriver</code>) + and the <em class="parameter"><code>port</code></em>must be a valid port name (see + <code class="literal">enumports</code>.</p></dd><dt><span class="term">deldriver</span></dt><dd><p>Delete the + specified printer driver for all architectures. This + does not delete the actual driver files from the server, + only the entry from the server's list of drivers. + </p></dd><dt><span class="term">deldriverex <driver> [architecture] [version] + </span></dt><dd><p>Delete the specified printer driver including driver files. + You can limit this action to a specific architecture and a specific version. + If no architecure is given, all driver files of that driver will be deleted. + </p></dd><dt><span class="term">enumdata</span></dt><dd><p>Enumerate all + printer setting data stored on the server. On Windows NT clients, + these values are stored in the registry, while Samba servers + store them in the printers TDB. This command corresponds + to the MS Platform SDK GetPrinterData() function (* This + command is currently unimplemented).</p></dd><dt><span class="term">enumdataex</span></dt><dd><p>Enumerate printer data for a key</p></dd><dt><span class="term">enumjobs <printer></span></dt><dd><p>List the jobs and status of a given printer. + This command corresponds to the MS Platform SDK EnumJobs() + function</p></dd><dt><span class="term">enumkey</span></dt><dd><p>Enumerate + printer keys</p></dd><dt><span class="term">enumports [level]</span></dt><dd><p> + Executes an EnumPorts() call using the specified + info level. Currently only info levels 1 and 2 are supported. + </p></dd><dt><span class="term">enumdrivers [level]</span></dt><dd><p> + Execute an EnumPrinterDrivers() call. This lists the various installed + printer drivers for all architectures. Refer to the MS Platform SDK + documentation for more details of the various flags and calling + options. Currently supported info levels are 1, 2, and 3.</p></dd><dt><span class="term">enumprinters [level]</span></dt><dd><p>Execute an EnumPrinters() call. This lists the various installed + and share printers. Refer to the MS Platform SDK documentation for + more details of the various flags and calling options. Currently + supported info levels are 1, 2 and 5.</p></dd><dt><span class="term">getdata <printername> <valuename;></span></dt><dd><p>Retrieve the data for a given printer setting. See + the <code class="literal">enumdata</code> command for more information. + This command corresponds to the GetPrinterData() MS Platform + SDK function. </p></dd><dt><span class="term">getdataex</span></dt><dd><p>Get + printer driver data with + keyname</p></dd><dt><span class="term">getdriver <printername></span></dt><dd><p> + Retrieve the printer driver information (such as driver file, + config file, dependent files, etc...) for + the given printer. This command corresponds to the GetPrinterDriver() + MS Platform SDK function. Currently info level 1, 2, and 3 are supported. + </p></dd><dt><span class="term">getdriverdir <arch></span></dt><dd><p> + Execute a GetPrinterDriverDirectory() + RPC to retrieve the SMB share name and subdirectory for + storing printer driver files for a given architecture. Possible + values for <em class="parameter"><code>arch</code></em> are "Windows 4.0" + (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows + Alpha_AXP", and "Windows NT R4000". </p></dd><dt><span class="term">getprinter <printername></span></dt><dd><p>Retrieve the current printer information. This command + corresponds to the GetPrinter() MS Platform SDK function. + </p></dd><dt><span class="term">getprintprocdir</span></dt><dd><p>Get + print processor + directory</p></dd><dt><span class="term">openprinter <printername></span></dt><dd><p>Execute an OpenPrinterEx() and ClosePrinter() RPC + against a given printer. </p></dd><dt><span class="term">setdriver <printername> + <drivername></span></dt><dd><p>Execute a SetPrinter() command to update the printer driver + associated with an installed printer. The printer driver must + already be correctly installed on the print server. </p><p>See also the <code class="literal">enumprinters</code> and + <code class="literal">enumdrivers</code> commands for obtaining a list of + of installed printers and drivers.</p></dd><dt><span class="term">addform</span></dt><dd><p>Add form</p></dd><dt><span class="term">setform</span></dt><dd><p>Set form</p></dd><dt><span class="term">getform</span></dt><dd><p>Get form</p></dd><dt><span class="term">deleteform</span></dt><dd><p>Delete form</p></dd><dt><span class="term">enumforms</span></dt><dd><p>Enumerate form</p></dd><dt><span class="term">setprinter</span></dt><dd><p>Set printer comment</p></dd><dt><span class="term">setprinterdata</span></dt><dd><p>Set REG_SZ printer data</p></dd><dt><span class="term">setprintername <printername> + <newprintername></span></dt><dd><p>Set printer name</p></dd><dt><span class="term">rffpcnex</span></dt><dd><p>Rffpcnex test</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id308764"></a><h3>NETLOGON</h3><div class="variablelist"><dl><dt><span class="term">logonctrl2</span></dt><dd><p>Logon Control 2</p></dd><dt><span class="term">logonctrl</span></dt><dd><p>Logon Control</p></dd><dt><span class="term">samsync</span></dt><dd><p>Sam Synchronisation</p></dd><dt><span class="term">samdeltas</span></dt><dd><p>Query Sam Deltas</p></dd><dt><span class="term">samlogon</span></dt><dd><p>Sam Logon</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id308824"></a><h3>GENERAL COMMANDS</h3><div class="variablelist"><dl><dt><span class="term">debuglevel</span></dt><dd><p>Set the current + debug level used to log information.</p></dd><dt><span class="term">help (?)</span></dt><dd><p>Print a listing of all + known commands or extended help on a particular command. + </p></dd><dt><span class="term">quit (exit)</span></dt><dd><p>Exit <code class="literal">rpcclient + </code>.</p></dd></dl></div></div></div><div class="refsect1" lang="en"><a name="id308866"></a><h2>BUGS</h2><p><code class="literal">rpcclient</code> is designed as a developer testing tool + and may not be robust in certain areas (such as command line parsing). + It has been known to generate a core dump upon failures when invalid + parameters where passed to the interpreter. </p><p>From Luke Leighton's original rpcclient man page:</p><p><span class="emphasis"><em>WARNING!</em></span> The MSRPC over SMB code has + been developed from examining Network traces. No documentation is + available from the original creators (Microsoft) on how MSRPC over + SMB works, or how the individual MSRPC services work. Microsoft's + implementation of these services has been demonstrated (and reported) + to be... a bit flaky in places. </p><p>The development of Samba's implementation is also a bit rough, + and as more of the services are understood, it can even result in + versions of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and <a href="rpcclient.1.html"><span class="citerefentry"><span class="refentrytitle">rpcclient</span>(1)</span></a> that are incompatible for some commands or services. Additionally, + the developers are sending reports to Microsoft, and problems found + or reported to Microsoft are fixed in Service Packs, which may + result in incompatibilities.</p></div><div class="refsect1" lang="en"><a name="id308917"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><a name="id308928"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original rpcclient man page was written by Matthew + Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. + The conversion to DocBook for Samba 2.2 was done by Gerald + Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was + done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/samba.7.html b/docs/htmldocs/manpages/samba.7.html new file mode 100644 index 0000000000..67de3c40fb --- /dev/null +++ b/docs/htmldocs/manpages/samba.7.html @@ -0,0 +1,113 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>samba</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="samba.7"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>samba — A Windows SMB/CIFS fileserver for UNIX</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">samba</code></p></div></div><div class="refsect1" lang="en"><a name="id267383"></a><h2>DESCRIPTION</h2><p>The Samba software suite is a collection of programs + that implements the Server Message Block (commonly abbreviated + as SMB) protocol for UNIX systems. This protocol is sometimes + also referred to as the Common Internet File System (CIFS). For a + more thorough description, see <a href="http://www.ubiqx.org/cifs/" target="_top"> + http://www.ubiqx.org/cifs/</a>. Samba also implements the NetBIOS + protocol in nmbd.</p><div class="variablelist"><dl><dt><span class="term"><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a></span></dt><dd><p>The <code class="literal">smbd</code> daemon provides the file and print services to + SMB clients, such as Windows 95/98, Windows NT, Windows + for Workgroups or LanManager. The configuration file + for this daemon is described in <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> + </p></dd><dt><span class="term"><a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a></span></dt><dd><p>The <code class="literal">nmbd</code> + daemon provides NetBIOS nameservice and browsing + support. The configuration file for this daemon + is described in <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></dd><dt><span class="term"><a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a></span></dt><dd><p>The <code class="literal">smbclient</code> + program implements a simple ftp-like client. This + is useful for accessing SMB shares on other compatible + servers (such as Windows NT), and can also be used + to allow a UNIX box to print to a printer attached to + any SMB server (such as a PC running Windows NT).</p></dd><dt><span class="term"><a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a></span></dt><dd><p>The <code class="literal">testparm</code> + utility is a simple syntax checker for Samba's <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> configuration file.</p></dd><dt><span class="term"><a href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a></span></dt><dd><p>The <code class="literal">testprns</code> + utility supports testing printer names defined + in your <code class="filename">printcap</code> file used + by Samba.</p></dd><dt><span class="term"><a href="smbstatus.1.html"><span class="citerefentry"><span class="refentrytitle">smbstatus</span>(1)</span></a></span></dt><dd><p>The <code class="literal">smbstatus</code> + tool provides access to information about the + current connections to <code class="literal">smbd</code>.</p></dd><dt><span class="term"><a href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a></span></dt><dd><p>The <code class="literal">nmblookup</code> + tools allows NetBIOS name queries to be made + from a UNIX host.</p></dd><dt><span class="term"><a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a></span></dt><dd><p>The <code class="literal">smbpasswd</code> + command is a tool for changing LanMan and Windows NT + password hashes on Samba and Windows NT servers.</p></dd><dt><span class="term"><a href="smbcacls.1.html"><span class="citerefentry"><span class="refentrytitle">smbcacls</span>(1)</span></a></span></dt><dd><p>The <code class="literal">smbcacls</code> command is + a tool to set ACL's on remote CIFS servers. </p></dd><dt><span class="term"><a href="smbsh.1.html"><span class="citerefentry"><span class="refentrytitle">smbsh</span>(1)</span></a></span></dt><dd><p>The <code class="literal">smbsh</code> command is + a program that allows you to run a unix shell with + with an overloaded VFS.</p></dd><dt><span class="term"><a href="smbtree.1.html"><span class="citerefentry"><span class="refentrytitle">smbtree</span>(1)</span></a></span></dt><dd><p>The <code class="literal">smbtree</code> command + is a text-based network neighborhood tool.</p></dd><dt><span class="term"><a href="smbtar.1.html"><span class="citerefentry"><span class="refentrytitle">smbtar</span>(1)</span></a></span></dt><dd><p>The <code class="literal">smbtar</code> can make + backups of data on CIFS/SMB servers.</p></dd><dt><span class="term"><a href="smbspool.8.html"><span class="citerefentry"><span class="refentrytitle">smbspool</span>(8)</span></a></span></dt><dd><p><code class="literal">smbspool</code> is a + helper utility for printing on printers connected + to CIFS servers. </p></dd><dt><span class="term"><a href="smbcontrol.1.html"><span class="citerefentry"><span class="refentrytitle">smbcontrol</span>(1)</span></a></span></dt><dd><p><code class="literal">smbcontrol</code> is a utility + that can change the behaviour of running samba daemons. + </p></dd><dt><span class="term"><a href="rpcclient.1.html"><span class="citerefentry"><span class="refentrytitle">rpcclient</span>(1)</span></a></span></dt><dd><p><code class="literal">rpcclient</code> is a utility + that can be used to execute RPC commands on remote + CIFS servers.</p></dd><dt><span class="term"><a href="pdbedit.8.html"><span class="citerefentry"><span class="refentrytitle">pdbedit</span>(8)</span></a></span></dt><dd><p>The <code class="literal">pdbedit</code> command + can be used to maintain the local user database on + a samba server.</p></dd><dt><span class="term"><a href="findsmb.1.html"><span class="citerefentry"><span class="refentrytitle">findsmb</span>(1)</span></a></span></dt><dd><p>The <code class="literal">findsmb</code> command + can be used to find SMB servers on the local network. + </p></dd><dt><span class="term"><a href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a></span></dt><dd><p>The <code class="literal">net</code> command + is supposed to work similar to the DOS/Windows + NET.EXE command.</p></dd><dt><span class="term"><a href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a></span></dt><dd><p><code class="literal">swat</code> is a web-based + interface to configuring <code class="filename">smb.conf</code>. + </p></dd><dt><span class="term"><a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a></span></dt><dd><p><code class="literal">winbindd</code> is a daemon + that is used for integrating authentication and + the user database into unix.</p></dd><dt><span class="term"><a href="wbinfo.1.html"><span class="citerefentry"><span class="refentrytitle">wbinfo</span>(1)</span></a></span></dt><dd><p><code class="literal">wbinfo</code> is a utility + that retrieves and stores information related to winbind. + </p></dd><dt><span class="term"><a href="profiles.1.html"><span class="citerefentry"><span class="refentrytitle">profiles</span>(1)</span></a></span></dt><dd><p><code class="literal">profiles</code> is a command-line + utility that can be used to replace all occurences of + a certain SID with another SID. + </p></dd><dt><span class="term"><a href="log2pcap.1.html"><span class="citerefentry"><span class="refentrytitle">log2pcap</span>(1)</span></a></span></dt><dd><p><code class="literal">log2pcap</code> is a utility + for generating pcap trace files from Samba log + files.</p></dd><dt><span class="term"><a href="vfstest.1.html"><span class="citerefentry"><span class="refentrytitle">vfstest</span>(1)</span></a></span></dt><dd><p><code class="literal">vfstest</code> is a utility + that can be used to test vfs modules.</p></dd><dt><span class="term"><a href="ntlm_auth.1.html"><span class="citerefentry"><span class="refentrytitle">ntlm_auth</span>(1)</span></a></span></dt><dd><p><code class="literal">ntlm_auth</code> is a helper-utility + for external programs wanting to do NTLM-authentication. + </p></dd><dt><span class="term"> +<a href="smbmount.8.html"><span class="citerefentry"><span class="refentrytitle">smbmount</span>(8)</span></a>, +<a href="smbumount.8.html"><span class="citerefentry"><span class="refentrytitle">smbumount</span>(8)</span></a>, +<a href="smbmnt.8.html"><span class="citerefentry"><span class="refentrytitle">smbmnt</span>(8)</span></a></span></dt><dd><p><code class="literal">smbmount</code>,<code class="literal">smbumount</code> and <code class="literal">smbmnt</code> are commands that can be used to + mount CIFS/SMB shares on Linux. + </p></dd><dt><span class="term"><a href="smbcquotas.1.html"><span class="citerefentry"><span class="refentrytitle">smbcquotas</span>(1)</span></a></span></dt><dd><p><code class="literal">smbcquotas</code> is a tool that + can set remote QUOTA's on server with NTFS 5. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308170"></a><h2>COMPONENTS</h2><p>The Samba suite is made up of several components. Each + component is described in a separate manual page. It is strongly + recommended that you read the documentation that comes with Samba + and the manual pages of those components that you use. If the + manual pages and documents aren't clear enough then please visit + <a href="http://devel.samba.org/" target="_top">http://devel.samba.org</a> + for information on how to file a bug report or submit a patch.</p><p>If you require help, visit the Samba webpage at + <a href="http://samba.org/" target="_top">http://www.samba.org/</a> and + explore the many option available to you. + </p></div><div class="refsect1" lang="en"><a name="id308199"></a><h2>AVAILABILITY</h2><p>The Samba software suite is licensed under the + GNU Public License(GPL). A copy of that license should + have come with the package in the file COPYING. You are + encouraged to distribute copies of the Samba suite, but + please obey the terms of this license.</p><p>The latest version of the Samba suite can be + obtained via anonymous ftp from samba.org in the + directory pub/samba/. It is also available on several + mirror sites worldwide.</p><p>You may also find useful information about Samba + on the newsgroup <a href="news:comp.protocols.smb" target="_top"> + comp.protocol.smb</a> and the Samba mailing + list. Details on how to join the mailing list are given in + the README file that comes with Samba.</p><p>If you have access to a WWW viewer (such as Mozilla + or Konqueror) then you will also find lots of useful information, + including back issues of the Samba mailing list, at + <a href="http://lists.samba.org/" target="_top">http://lists.samba.org</a>.</p></div><div class="refsect1" lang="en"><a name="id308237"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the + Samba suite. </p></div><div class="refsect1" lang="en"><a name="id308247"></a><h2>CONTRIBUTIONS</h2><p>If you wish to contribute to the Samba project, + then I suggest you join the Samba mailing list at + <a href="http://lists.samba.org/" target="_top">http://lists.samba.org</a>. + </p><p>If you have patches to submit, visit + <a href="http://devel.samba.org/" target="_top">http://devel.samba.org/</a> + for information on how to do it properly. We prefer patches + in <code class="literal">diff -u</code> format.</p></div><div class="refsect1" lang="en"><a name="id308280"></a><h2>CONTRIBUTORS</h2><p>Contributors to the project are now too numerous + to mention here but all deserve the thanks of all Samba + users. To see a full list, look at the + <code class="filename">change-log</code> in the source package + for the pre-CVS changes and at <a href="http://cvs.samba.org/" target="_top"> + http://cvs.samba.org/</a> + for the contributors to Samba post-CVS. CVS is the Open Source + source code control system used by the Samba Team to develop + Samba. The project would have been unmanageable without it.</p></div><div class="refsect1" lang="en"><a name="id308305"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML + 4.2 for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smb.conf.5.html b/docs/htmldocs/manpages/smb.conf.5.html new file mode 100644 index 0000000000..bd1675c385 --- /dev/null +++ b/docs/htmldocs/manpages/smb.conf.5.html @@ -0,0 +1,5127 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smb.conf</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smb.conf.5"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smb.conf — The configuration file for the Samba suite</p></div><div class="refsect1" lang="en"><a name="id267380"></a><h2>SYNOPSIS</h2><p> + The <code class="filename">smb.conf</code> file is a configuration file for the Samba suite. <code class="filename">smb.conf</code> contains runtime configuration information for the Samba programs. The + <code class="filename">smb.conf</code> file is designed to be configured and administered by the + <a href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> program. The + complete description of the file format and possible parameters held within are here for reference purposes. + </p></div><div class="refsect1" lang="en"><a name="FILEFORMATSECT"></a><h2>FILE FORMAT</h2><p> + The file consists of sections and parameters. A section begins with the name of the section in square brackets + and continues until the next section begins. Sections contain parameters of the form: +</p><pre class="programlisting"> +<em class="replaceable"><code>name</code></em> = <em class="replaceable"><code>value </code></em> +</pre><p> + </p><p> + The file is line-based - that is, each newline-terminated line represents either a comment, a section name or + a parameter. + </p><p>Section and parameter names are not case sensitive.</p><p> + Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is + discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading + and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is + retained verbatim. + </p><p> + Any line beginning with a semicolon (“<span class="quote">;</span>”) or a hash (“<span class="quote">#</span>”) + character is ignored, as are lines containing only whitespace. + </p><p> + Any line ending in a “<span class="quote"><code class="literal">\</code></span>” is continued on the next line in the customary UNIX fashion. + </p><p> + The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, + which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved + in string values. Some items such as create masks are numeric. + </p></div><div class="refsect1" lang="en"><a name="id299256"></a><h2>SECTION DESCRIPTIONS</h2><p> + Each section in the configuration file (except for the [global] section) describes a shared resource (known as + a “<span class="quote">share</span>”). The section name is the name of the shared resource and the parameters within the + section define the shares attributes. + </p><p> + There are three special sections, [global], [homes] and [printers], which are described under + <span class="emphasis"><em>special sections</em></span>. The following notes apply to ordinary section descriptions. + </p><p> + A share consists of a directory to which access is being given plus a description of the access rights + which are granted to the user of the service. Some housekeeping options are also specifiable. + </p><p> + Sections are either file share services (used by the client as an extension of their native file systems) + or printable services (used by the client to access print services on the host running the server). + </p><p> + Sections may be designated <span class="emphasis"><em>guest</em></span> services, in which case no password is required to + access them. A specified UNIX <span class="emphasis"><em>guest account</em></span> is used to define access privileges in this + case. + </p><p> + Sections other than guest services will require a password to access them. The client provides the + username. As older clients only provide passwords and not usernames, you may specify a list of usernames to + check against the password using the <code class="literal">user =</code> option in the share definition. For modern clients + such as Windows 95/98/ME/NT/2000, this should not be necessary. + </p><p> + The access rights granted by the server are masked by the access rights granted to the specified or guest + UNIX user by the host system. The server does not grant more access than the host system grants. + </p><p> + The following sample section defines a file space share. The user has write access to the path <code class="filename">/home/bar</code>. The share is accessed via the share name <code class="literal">foo</code>: +</p><pre class="programlisting"> + <em class="parameter"><code>[foo]</code></em> + <a class="indexterm" name="id266776"></a>path = /home/bar + <a class="indexterm" name="id266783"></a>read only = no +</pre><p> + </p><p> + The following sample section defines a printable share. The share is read-only, but printable. That is, + the only write access permitted is via calls to open, write to and close a spool file. The <span class="emphasis"><em>guest + ok</em></span> parameter means access will be permitted as the default guest user (specified elsewhere): +</p><pre class="programlisting"> + <em class="parameter"><code>[aprinter]</code></em> + <a class="indexterm" name="id266810"></a>path = /usr/spool/public + <a class="indexterm" name="id266818"></a>read only = yes + <a class="indexterm" name="id266825"></a>printable = yes + <a class="indexterm" name="id266832"></a>guest ok = yes +</pre><p> + </p></div><div class="refsect1" lang="en"><a name="id266842"></a><h2>SPECIAL SECTIONS</h2><div class="refsect2" lang="en"><a name="id266848"></a><h3>The [global] section</h3><p> + Parameters in this section apply to the server as a whole, or are defaults for sections that do not + specifically define certain items. See the notes under PARAMETERS for more information. + </p></div><div class="refsect2" lang="en"><a name="HOMESECT"></a><h3>The [homes] section</h3><p> + If a section called [homes] is included in the configuration file, services connecting clients + to their home directories can be created on the fly by the server. + </p><p> + When the connection request is made, the existing sections are scanned. If a match is found, it is + used. If no match is found, the requested section name is treated as a username and looked up in the local + password file. If the name exists and the correct password has been given, a share is created by cloning the + [homes] section. + </p><p> + Some modifications are then made to the newly created share: + </p><div class="itemizedlist"><ul type="disc"><li><p> + The share name is changed from homes to the located username. + </p></li><li><p> + If no path was given, the path is set to the user's home directory. + </p></li></ul></div><p> + If you decide to use a <span class="emphasis"><em>path =</em></span> line in your [homes] section, it may be useful + to use the %S macro. For example: +</p><pre class="programlisting"> +<strong class="userinput"><code>path = /data/pchome/%S</code></strong> +</pre><p> + is useful if you have different home directories for your PCs than for UNIX access. + </p><p> + This is a fast and simple way to give a large number of clients access to their home directories with a minimum + of fuss. + </p><p> + A similar process occurs if the requested section name is “<span class="quote">homes</span>”, except that the share + name is not changed to that of the requesting user. This method of using the [homes] section works well if + different users share a client PC. + </p><p> + The [homes] section can specify all the parameters a normal service section can specify, though some make more sense + than others. The following is a typical and suitable [homes] section: +</p><pre class="programlisting"> +<em class="parameter"><code>[homes]</code></em> +<a class="indexterm" name="id266965"></a>read only = no +</pre><p> + </p><p> + An important point is that if guest access is specified in the [homes] section, all home directories will be + visible to all clients <span class="emphasis"><em>without a password</em></span>. In the very unlikely event that this is actually + desirable, it is wise to also specify <span class="emphasis"><em>read only access</em></span>. + </p><p> + The <span class="emphasis"><em>browseable</em></span> flag for auto home directories will be inherited from the global browseable + flag, not the [homes] browseable flag. This is useful as it means setting <span class="emphasis"><em>browseable = no</em></span> in + the [homes] section will hide the [homes] share but make any auto home directories visible. + </p></div><div class="refsect2" lang="en"><a name="PRINTERSSECT"></a><h3>The [printers] section</h3><p> + This section works like [homes], but for printers. + </p><p> + If a [printers] section occurs in the configuration file, users are able to connect to any printer + specified in the local host's printcap file. + </p><p> + When a connection request is made, the existing sections are scanned. If a match is found, it is used. + If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested + section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested + section name is a valid printer share name. If a match is found, a new printer share is created by cloning the + [printers] section. + </p><p> + A few modifications are then made to the newly created share: + </p><div class="itemizedlist"><ul type="disc"><li><p>The share name is set to the located printer name</p></li><li><p>If no printer name was given, the printer name is set to the located printer name</p></li><li><p>If the share does not permit guest access and no username was given, the username is set + to the located printer name.</p></li></ul></div><p> + The [printers] service MUST be printable - if you specify otherwise, the server will refuse + to load the configuration file. + </p><p> + Typically the path specified is that of a world-writeable spool directory with the sticky bit set on + it. A typical [printers] entry looks like this: +</p><pre class="programlisting"> +<em class="parameter"><code>[printers]</code></em> +<a class="indexterm" name="id307925"></a>path = /usr/spool/public +<a class="indexterm" name="id307932"></a>guest ok = yes +<a class="indexterm" name="id307939"></a>printable = yes +</pre><p> + </p><p> + All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. + If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file + consisting of one or more lines like this: +</p><pre class="programlisting"> +alias|alias|alias|alias... +</pre><p> + </p><p> + Each alias should be an acceptable printer name for your printing subsystem. In the [global] section, + specify the new file as your printcap. The server will only recognize names found in your pseudo-printcap, + which of course can contain whatever aliases you like. The same technique could be used simply to limit access + to a subset of your local printers. + </p><p> + An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines, + components (if there are more than one) are separated by vertical bar symbols (<code class="literal">|</code>). + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use + <code class="literal">printcap name = lpstat</code> to automatically obtain a list of printers. See the + <code class="literal">printcap name</code> option for more details. + </p></div></div></div><div class="refsect1" lang="en"><a name="id307997"></a><h2>USERSHARES</h2><p>Starting with Samba version 3.0.23 the capability for non-root users to add, modify, and delete + their own share definitions has been added. This capability is called <span class="emphasis"><em>usershares</em></span> and + is controlled by a set of parameters in the [global] section of the smb.conf. + The relevant parameters are : + </p><div class="variablelist"><dl><dt><span class="term">usershare allow guests</span></dt><dd><p>Controls if usershares can permit guest access.</p></dd><dt><span class="term">usershare max shares</span></dt><dd><p>Maximum number of user defined shares allowed.</p></dd><dt><span class="term">usershare owner only</span></dt><dd><p>If set only directories owned by the sharing user can be shared.</p></dd><dt><span class="term">usershare path</span></dt><dd><p>Points to the directory containing the user defined share definitions. + The filesystem permissions on this directory control who can create user defined shares.</p></dd><dt><span class="term">usershare prefix allow list</span></dt><dd><p>Comma-separated list of absolute pathnames restricting what directories + can be shared. Only directories below the pathnames in this list are permitted.</p></dd><dt><span class="term">usershare prefix deny list</span></dt><dd><p>Comma-separated list of absolute pathnames restricting what directories + can be shared. Directories below the pathnames in this list are prohibited.</p></dd><dt><span class="term">usershare template share</span></dt><dd><p>Names a pre-existing share used as a template for creating new usershares. + All other share parameters not specified in the user defined share definition + are copied from this named share.</p></dd></dl></div><p>To allow members of the UNIX group <code class="literal">foo</code> to create user defined + shares, create the directory to contain the share definitions as follows: + </p><p>Become root:</p><pre class="programlisting"> +mkdir /usr/local/samba/lib/usershares +chgrp foo /usr/local/samba/lib/usershares +chmod 1770 /usr/local/samba/lib/usershares +</pre><p>Then add the parameters + +</p><pre class="programlisting"> + <a class="indexterm" name="id308127"></a>usershare path = /usr/local/samba/lib/usershares + <a class="indexterm" name="id308134"></a>usershare max shares = 10 # (or the desired number of shares) +</pre><p> + + to the global + section of your <code class="filename">smb.conf</code>. Members of the group foo may then manipulate the user defined shares + using the following commands.</p><div class="variablelist"><dl><dt><span class="term">net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]</span></dt><dd><p>To create or modify (overwrite) a user defined share.</p></dd><dt><span class="term">net usershare delete sharename</span></dt><dd><p>To delete a user defined share.</p></dd><dt><span class="term">net usershare list wildcard-sharename</span></dt><dd><p>To list user defined shares.</p></dd><dt><span class="term">net usershare info wildcard-sharename</span></dt><dd><p>To print information about user defined shares.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308201"></a><h2>PARAMETERS</h2><p>Parameters define the specific attributes of sections.</p><p> + Some parameters are specific to the [global] section (e.g., <span class="emphasis"><em>security</em></span>). Some parameters + are usable in all sections (e.g., <span class="emphasis"><em>create mask</em></span>). All others are permissible only in normal + sections. For the purposes of the following descriptions the [homes] and [printers] sections will be + considered normal. The letter <span class="emphasis"><em>G</em></span> in parentheses indicates that a parameter is specific to + the [global] section. The letter <span class="emphasis"><em>S</em></span> indicates that a parameter can be specified in a + service specific section. All <span class="emphasis"><em>S</em></span> parameters can also be specified in the [global] section + - in which case they will define the default behavior for all services. + </p><p> + Parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can + find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred + synonym. + </p></div><div class="refsect1" lang="en"><a name="id308242"></a><h2>VARIABLE SUBSTITUTIONS</h2><p> + Many of the strings that are settable in the config file can take substitutions. For example the option + “<span class="quote">path = /tmp/%u</span>” is interpreted as “<span class="quote">path = /tmp/john</span>” if the user connected with the + username john. + </p><p> + These substitutions are mostly noted in the descriptions below, but there are some general substitutions + which apply whenever they might be relevant. These are: + </p><div class="variablelist"><dl><dt><span class="term">%U</span></dt><dd><p>session username (the username that the client wanted, not + necessarily the same as the one they got).</p></dd><dt><span class="term">%G</span></dt><dd><p>primary group name of %U.</p></dd><dt><span class="term">%h</span></dt><dd><p>the Internet hostname that Samba is running on.</p></dd><dt><span class="term">%m</span></dt><dd><p>the NetBIOS name of the client machine (very useful).</p><p>This parameter is not available when Samba listens on port 445, as clients no longer + send this information. If you use this macro in an include statement on a domain that has + a Samba domain controller be sure to set in the [global] section <em class="parameter"><code>smb ports = + 139</code></em>. This will cause Samba to not listen on port 445 and will permit include + functionality to function as it did with Samba 2.x. + </p></dd><dt><span class="term">%L</span></dt><dd><p>the NetBIOS name of the server. This allows you to change your config based on what + the client calls you. Your server can have a “<span class="quote">dual personality</span>”. + </p></dd><dt><span class="term">%M</span></dt><dd><p>the Internet name of the client machine. + </p></dd><dt><span class="term">%R</span></dt><dd><p>the selected protocol level after protocol negotiation. It can be one of CORE, COREPLUS, + LANMAN1, LANMAN2 or NT1.</p></dd><dt><span class="term">%d</span></dt><dd><p>the process id of the current server + process.</p></dd><dt><span class="term">%a</span></dt><dd><p>the architecture of the remote + machine. It currently recognizes Samba (<code class="constant">Samba</code>), + the Linux CIFS file system (<code class="constant">CIFSFS</code>), OS/2, (<code class="constant">OS2</code>), + Windows for Workgroups (<code class="constant">WfWg</code>), Windows 9x/ME + (<code class="constant">Win95</code>), Windows NT (<code class="constant">WinNT</code>), + Windows 2000 (<code class="constant">Win2K</code>), Windows XP (<code class="constant">WinXP</code>), + and Windows 2003 (<code class="constant">Win2K3</code>). Anything else will be known as + <code class="constant">UNKNOWN</code>.</p></dd><dt><span class="term">%I</span></dt><dd><p>the IP address of the client machine.</p></dd><dt><span class="term">%i</span></dt><dd><p>the local IP address to which a client connected.</p></dd><dt><span class="term">%T</span></dt><dd><p>the current date and time.</p></dd><dt><span class="term">%D</span></dt><dd><p>name of the domain or workgroup of the current user.</p></dd><dt><span class="term">%w</span></dt><dd><p>the winbind separator.</p></dd><dt><span class="term">%$(<em class="replaceable"><code>envvar</code></em>)</span></dt><dd><p>the value of the environment variable + <em class="replaceable"><code>envar</code></em>.</p></dd></dl></div><p> + The following substitutes apply only to some configuration options (only those that are + used when a connection has been established): + </p><div class="variablelist"><dl><dt><span class="term">%S</span></dt><dd><p>the name of the current service, if any.</p></dd><dt><span class="term">%P</span></dt><dd><p>the root directory of the current service, if any.</p></dd><dt><span class="term">%u</span></dt><dd><p>username of the current service, if any.</p></dd><dt><span class="term">%g</span></dt><dd><p>primary group name of %u.</p></dd><dt><span class="term">%H</span></dt><dd><p>the home directory of the user given by %u.</p></dd><dt><span class="term">%N</span></dt><dd><p> + the name of your NIS home directory server. This is obtained from your NIS auto.map entry. + If you have not compiled Samba with the <span class="emphasis"><em>--with-automount</em></span> option, this + value will be the same as %L.</p></dd><dt><span class="term">%p</span></dt><dd><p> + the path of the service's home directory, obtained from your NIS auto.map entry. The NIS + auto.map entry is split up as <code class="literal">%N:%p</code>.</p></dd></dl></div><p> + There are some quite creative things that can be done with these substitutions and other + <code class="filename">smb.conf</code> options. + </p></div><div class="refsect1" lang="en"><a name="NAMEMANGLINGSECT"></a><h2>NAME MANGLING</h2><p> + Samba supports <code class="literal">name mangling</code> so that DOS and Windows clients can use files that don't + conform to the 8.3 format. It can also be set to adjust the case of 8.3 format filenames. + </p><p> + There are several options that control the way mangling is performed, and they are grouped here rather + than listed separately. For the defaults look at the output of the testparm program. + </p><p> + These options can be set separately for each service. + </p><p> + The options are: + </p><div class="variablelist"><dl><dt><span class="term">case sensitive = yes/no/auto</span></dt><dd><p> + controls whether filenames are case sensitive. If they aren't, Samba must do a filename search and match on + passed names. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS + and smbclient 3.0.5 and above currently) to tell the Samba server on a per-packet basis that they wish to + access the file system in a case-sensitive manner (to support UNIX case sensitive semantics). No Windows or + DOS system supports case-sensitive filename so setting this option to auto is that same as setting it to no + for them. Default <span class="emphasis"><em>auto</em></span>. + </p></dd><dt><span class="term">default case = upper/lower</span></dt><dd><p> + controls what the default case is for new filenames (ie. files that don't currently exist in the filesystem). + Default <span class="emphasis"><em>lower</em></span>. IMPORTANT NOTE: This option will be used to modify the case of + <span class="emphasis"><em>all</em></span> incoming client filenames, not just new filenames if the options <a class="indexterm" name="id308683"></a>case sensitive = yes, <a class="indexterm" name="id308690"></a>preserve case = No, + <a class="indexterm" name="id308697"></a>short preserve case = No are set. This change is needed as part of the + optimisations for directories containing large numbers of files. + </p></dd><dt><span class="term">preserve case = yes/no</span></dt><dd><p> + controls whether new files (ie. files that don't currently exist in the filesystem) are created with the case + that the client passes, or if they are forced to be the <code class="literal">default</code> case. Default + <span class="emphasis"><em>yes</em></span>. + </p></dd><dt><span class="term">short preserve case = yes/no</span></dt><dd><p> + controls if new files (ie. files that don't currently exist in the filesystem) which conform to 8.3 syntax, + that is all in upper case and of suitable length, are created upper case, or if they are forced to be the + <code class="literal">default</code> case. This option can be used with <code class="literal">preserve case = yes</code> to permit + long filenames to retain their case, while short names are lowercased. Default <span class="emphasis"><em>yes</em></span>. + </p></dd></dl></div><p> + By default, Samba 3.0 has the same semantics as a Windows NT server, in that it is case insensitive + but case preserving. As a special case for directories with large numbers of files, if the case + options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" + then the "default case" option will be applied and will modify all filenames sent from the client + when accessing this share. + </p></div><div class="refsect1" lang="en"><a name="VALIDATIONSECT"></a><h2>NOTE ABOUT USERNAME/PASSWORD VALIDATION</h2><p> + There are a number of ways in which a user can connect to a service. The server uses the following steps + in determining if it will allow a connection to a specified service. If all the steps fail, the connection + request is rejected. However, if one of the steps succeeds, the following steps are not checked. + </p><p> + If the service is marked “<span class="quote">guest only = yes</span>” and the server is running with share-level + security (“<span class="quote">security = share</span>”, steps 1 to 5 are skipped. + </p><div class="orderedlist"><ol type="1"><li><p> + If the client has passed a username/password pair and that username/password pair is validated by the UNIX + system's password programs, the connection is made as that username. This includes the + <code class="literal">\\server\service</code>%<em class="replaceable"><code>username</code></em> method of passing a username. + </p></li><li><p> + If the client has previously registered a username with the system and now supplies a correct password for that + username, the connection is allowed. + </p></li><li><p> + The client's NetBIOS name and any previously used usernames are checked against the supplied password. If + they match, the connection is allowed as the corresponding user. + </p></li><li><p> + If the client has previously validated a username/password pair with the server and the client has passed + the validation token, that username is used. + </p></li><li><p> + If a <code class="literal">user = </code> field is given in the <code class="filename">smb.conf</code> file for the + service and the client has supplied a password, and that password matches (according to the UNIX system's + password checking) with one of the usernames from the <code class="literal">user =</code> field, the connection is made as + the username in the <code class="literal">user =</code> line. If one of the usernames in the <code class="literal">user =</code> list + begins with a <code class="literal">@</code>, that name expands to a list of names in the group of the same name. + </p></li><li><p> + If the service is a guest service, a connection is made as the username given in the <code class="literal">guest account + =</code> for the service, irrespective of the supplied password. + </p></li></ol></div></div><div class="refsect1" lang="en"><a name="id308893"></a><h2>REGISTRY-BASED CONFIGURATION</h2><p> + Starting with Samba version 3.2.0, the capability to + store Samba configuration in the registry is available. + There are two levels of registry configuration: + </p><div class="orderedlist"><ol type="1"><li><p>Share definitions stored in registry are used. + This is triggered by setting the global + parameter <em class="parameter"><code>registry shares</code></em> to “<span class="quote">yes</span>” + in <span class="emphasis"><em>smb.conf</em></span>. + </p><p>Note: Shares defined in <span class="emphasis"><em>smb.conf</em></span> + always take priority over + shares of the same name defined in registry. + </p></li><li><p>Global <span class="emphasis"><em>smb.conf</em></span> options stored in + registry are used. This is triggered by the + parameter <a class="indexterm" name="id308946"></a>config backend = registry in + the [global] section of <span class="emphasis"><em>smb.conf</em></span>. + This removes everything that has been read from config files + to this point and reads the content of the global configuration + section from the registry. + Activation of global registry options automatically + activates registry shares. In this case, no share definitions + from smb.conf are read: This is a registry only configuration + with the advantage that share definitions are not read + in a bulk at startup time but on demand when a share is + accessed. + </p></li></ol></div><p> + Caveat: To make registry-based configurations foolproof at least to a + certain extent, the use + of <em class="parameter"><code>lock directory</code></em>, + <em class="parameter"><code>config backend</code></em>, and + <em class="parameter"><code>include</code></em> inside the registry + configuration has been disabled. Especially, by changing the + <em class="parameter"><code>lock directory</code></em> inside the registry + configuration, one would create a broken setup where the daemons + do not see the configuration they loaded once it is active. + </p><p> + The registry configuration can be accessed with + tools like <span class="emphasis"><em>regedit</em></span> or <span class="emphasis"><em>net rpc + registry</em></span> in the key + <span class="emphasis"><em>HKLM\Software\Samba\smbconf</em></span>. + + More conveniently, the <span class="emphasis"><em>conf</em></span> subcommand of the + <a href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> utility + offers a dedicated interface to read and write the + registry based configuration locally, i.e. directly + accessing the database file, circumventing the + server. + </p></div><div class="refsect1" lang="en"><a name="id309022"></a><h2>EXPLANATION OF EACH PARAMETER</h2><div class="variablelist"><dl><dt><span class="term"><a name="ABORTSHUTDOWNSCRIPT"></a>abort shutdown script (G)</span></dt><dd><p>This a full path name to a script called by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that + should stop a shutdown procedure issued by the <a class="indexterm" name="id309062"></a>shutdown script.</p><p>If the connected user posseses the <code class="constant">SeRemoteShutdownPrivilege</code>, + right, this command will be run as user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>abort shutdown script</code></em> = <code class="literal">""</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>abort shutdown script</code></em> = <code class="literal">/sbin/shutdown -c</code> +</em></span> +</p></dd><dt><span class="term"><a name="ACLCHECKPERMISSIONS"></a>acl check permissions (S)</span></dt><dd><p>This boolean parameter controls what <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>does on receiving a protocol request of "open for delete" + from a Windows client. If a Windows client doesn't have permissions to delete a file then they + expect this to be denied at open time. POSIX systems normally only detect restrictions on delete by + actually attempting to delete the file or directory. As Windows clients can (and do) "back out" a + delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately + on "open for delete" request as we cannot restore such a deleted file. With this parameter set to + true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the + request without actually deleting the file if the file system permissions would seem to deny it. + This is not perfect, as it's possible a user could have deleted a file without Samba being able to + check the permissions correctly, but it is close enough to Windows semantics for mostly correct + behaviour. Samba will correctly check POSIX ACL semantics in this case. + </p><p>If this parameter is set to "false" Samba doesn't check permissions on "open for delete" + and allows the open. If the user doesn't have permission to delete the file this will only be + discovered at close time, which is too late for the Windows user tools to display an error message + to the user. The symptom of this is files that appear to have been deleted "magically" re-appearing + on a Windows explorer refersh. This is an extremely advanced protocol option which should not + need to be changed. This parameter was introduced in its final form in 3.0.21, an earlier version + with slightly different semantics was introduced in 3.0.20. That older version is not documented here. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl check permissions</code></em> = <code class="literal">True</code> +</em></span> +</p></dd><dt><span class="term"><a name="ACLCOMPATIBILITY"></a>acl compatibility (S)</span></dt><dd><p>This parameter specifies what OS ACL semantics should + be compatible with. Possible values are <span class="emphasis"><em>winnt</em></span> for Windows NT 4, + <span class="emphasis"><em>win2k</em></span> for Windows 2000 and above and <span class="emphasis"><em>auto</em></span>. + If you specify <span class="emphasis"><em>auto</em></span>, the value for this parameter + will be based upon the version of the client. There should + be no reason to change this parameter from the default.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl compatibility</code></em> = <code class="literal">Auto</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>acl compatibility</code></em> = <code class="literal">win2k</code> +</em></span> +</p></dd><dt><span class="term"><a name="ACLGROUPCONTROL"></a>acl group control (S)</span></dt><dd><p> + In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions + and ACLs on a file. If this parameter is set, then Samba overrides this restriction, and also allows the + <span class="emphasis"><em>primary group owner</em></span> of a file or directory to modify the permissions and ACLs + on that file. + </p><p> + On a Windows server, groups may be the owner of a file or directory - thus allowing anyone in + that group to modify the permissions on it. This allows the delegation of security controls + on a point in the filesystem to the group owner of a directory and anything below it also owned + by that group. This means there are multiple people with permissions to modify ACLs on a file + or directory, easing managability. + </p><p> + This parameter allows Samba to also permit delegation of the control over a point in the exported + directory hierarchy in much the same was as Windows. This allows all members of a UNIX group to + control the permissions on a file or directory they have group ownership on. + </p><p> + This parameter is best used with the <a class="indexterm" name="id309290"></a>inherit owner option and also + on on a share containing directories with the UNIX <span class="emphasis"><em>setgid bit</em></span> bit set + on them, which causes new files and directories created within it to inherit the group + ownership from the containing directory. + </p><p> + This is parameter has been marked deprecated in Samba 3.0.23. The same behavior is now + implemented by the <em class="parameter"><code>dos filemode</code></em> option. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl group control</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="ACLMAPFULLCONTROL"></a>acl map full control (S)</span></dt><dd><p> + This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum + allowed POSIX permission set, into a Windows ACL of "FULL CONTROL". If this parameter is set to true any POSIX + ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any + POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and + execute. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl map full control</code></em> = <code class="literal">True</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADDGROUPSCRIPT"></a>add group script (G)</span></dt><dd><p> + This is the full pathname to a script that will be run <span class="emphasis"><em>AS ROOT</em></span> by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a new group is requested. It + will expand any <em class="parameter"><code>%g</code></em> to the group name passed. This script is only useful + for installations using the Windows NT domain administration tools. The script is free to create a group with + an arbitrary name to circumvent unix group name restrictions. In that case the script must print the numeric + gid of the created group on stdout. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add group script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add group script</code></em> = <code class="literal">/usr/sbin/groupadd %g</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADDMACHINESCRIPT"></a>add machine script (G)</span></dt><dd><p> + This is the full pathname to a script that will be run by + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a machine is + added to Samba's domain and a Unix account matching the machine's name appended with a "$" does not + already exist. + </p><p>This option is very similar to the <a class="indexterm" name="id309488"></a>add user script, and likewise uses the %u + substitution for the account name. Do not use the %m + substitution. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add machine script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add machine script</code></em> = <code class="literal">/usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADDPORTCOMMAND"></a>add port command (G)</span></dt><dd><p>Samba 3.0.23 introduces support for adding printer ports + remotely using the Windows "Add Standard TCP/IP Port Wizard". + This option defines an external program to be executed when + smbd receives a request to add a new Port to the system. + he script is passed two parameters: + </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>port name</code></em></p></li><li><p><em class="parameter"><code>device URI</code></em></p></li></ul></div><p>The deviceURI is in the for of socket://<hostname>[:<portnumber>] + or lpd://<hostname>/<queuename>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add port command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add port command</code></em> = <code class="literal">/etc/samba/scripts/addport.sh</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADDPRINTERCOMMAND"></a>add printer command (G)</span></dt><dd><p>With the introduction of MS-RPC based printing + support for Windows NT/2000 clients in Samba 2.2, The MS Add + Printer Wizard (APW) icon is now also available in the + "Printers..." folder displayed a share listing. The APW + allows for printers to be add remotely to a Samba or Windows + NT/2000 print server.</p><p>For a Samba host this means that the printer must be + physically added to the underlying printing system. The <em class="parameter"><code>add + printer command</code></em> defines a script to be run which + will perform the necessary operations for adding the printer + to the print system and to add the appropriate service definition + to the <code class="filename">smb.conf</code> file in order that it can be + shared by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>The <em class="parameter"><code>addprinter command</code></em> is + automatically invoked with the following parameter (in + order):</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>printer name</code></em></p></li><li><p><em class="parameter"><code>share name</code></em></p></li><li><p><em class="parameter"><code>port name</code></em></p></li><li><p><em class="parameter"><code>driver name</code></em></p></li><li><p><em class="parameter"><code>location</code></em></p></li><li><p><em class="parameter"><code>Windows 9x driver location</code></em></p></li></ul></div><p>All parameters are filled in from the PRINTER_INFO_2 structure sent + by the Windows NT/2000 client with one exception. The "Windows 9x + driver location" parameter is included for backwards compatibility + only. The remaining fields in the structure are generated from answers + to the APW questions.</p><p>Once the <em class="parameter"><code>addprinter command</code></em> has + been executed, <code class="literal">smbd</code> will reparse the <code class="filename"> + smb.conf</code> to determine if the share defined by the APW + exists. If the sharename is still invalid, then <code class="literal">smbd + </code> will return an ACCESS_DENIED error to the client.</p><p> + The "add printer command" program can output a single line of text, + which Samba will set as the port the new printer is connected to. + If this line isn't output, Samba won't reload its printer shares. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add printer command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add printer command</code></em> = <code class="literal">/usr/bin/addprinter</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADDSHARECOMMAND"></a>add share command (G)</span></dt><dd><p> + Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server + Manager. The <em class="parameter"><code>add share command</code></em> is used to define an external program + or script which will add a new service definition to <code class="filename">smb.conf</code>. In order + to successfully execute the <em class="parameter"><code>add share command</code></em>, <code class="literal">smbd</code> requires that the administrator be connected using a root account (i.e. uid == 0). + </p><p> + If the connected account has <code class="literal">SeDiskOperatorPrivilege</code>, scripts defined in + <em class="parameter"><code>change share</code></em> parameter are executed as root. + </p><p> + When executed, <code class="literal">smbd</code> will automatically invoke the + <em class="parameter"><code>add share command</code></em> with five parameters. + </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>configFile</code></em> - the location of the global <code class="filename">smb.conf</code> file. + </p></li><li><p><em class="parameter"><code>shareName</code></em> - the name of the new share. + </p></li><li><p><em class="parameter"><code>pathName</code></em> - path to an **existing** + directory on disk. + </p></li><li><p><em class="parameter"><code>comment</code></em> - comment string to associate with the new + share. + </p></li><li><p><em class="parameter"><code>max + connections</code></em> + Number of maximum simultaneous connections to this + share. + </p></li></ul></div><p> + This parameter is only used for add file shares. To add printer shares, see the <a class="indexterm" name="id309946"></a>addprinter command. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add share command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add share command</code></em> = <code class="literal">/usr/local/bin/addshare</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADDUSERSCRIPT"></a>add user script (G)</span></dt><dd><p> + This is the full pathname to a script that will be run <span class="emphasis"><em>AS ROOT</em></span> by + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> + under special circumstances described below. + </p><p> + Normally, a Samba server requires that UNIX users are created for all users accessing + files on this server. For sites that use Windows NT account databases as their primary + user database creating these users and keeping the user list in sync with the Windows + NT PDC is an onerous task. This option allows smbd to create the required UNIX users + <span class="emphasis"><em>ON DEMAND</em></span> when a user accesses the Samba server. + </p><p> + In order to use this option, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must <span class="emphasis"><em>NOT</em></span> be set to + <a class="indexterm" name="id310044"></a>security = share and <a class="indexterm" name="id310052"></a>add user script + must be set to a full pathname for a script that will create a UNIX user given one argument of + <em class="parameter"><code>%u</code></em>, which expands into the UNIX user name to create. + </p><p> + When the Windows user attempts to access the Samba server, at login (session setup in + the SMB protocol) time, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> contacts the <a class="indexterm" name="id310078"></a>password server + and attempts to authenticate the given user with the given password. If the authentication + succeeds then <code class="literal">smbd</code> attempts to find a UNIX user in the UNIX + password database to map the Windows user into. If this lookup fails, and + <a class="indexterm" name="id310093"></a>add user script is set then <code class="literal">smbd</code> will + call the specified script <span class="emphasis"><em>AS ROOT</em></span>, expanding any + <em class="parameter"><code>%u</code></em> argument to be the user name to create. + </p><p> + If this script successfully creates the user then <code class="literal">smbd</code> will + continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to + match existing Windows NT accounts. + </p><p> + See also <a class="indexterm" name="id310130"></a>security, <a class="indexterm" name="id310137"></a>password server, + <a class="indexterm" name="id310144"></a>delete user script. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add user script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add user script</code></em> = <code class="literal">/usr/local/samba/bin/add_user %u</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADDUSERTOGROUPSCRIPT"></a>add user to group script (G)</span></dt><dd><p> + Full path to the script that will be called when a user is added to a group using the Windows NT domain administration + tools. It will be run by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> + <span class="emphasis"><em>AS ROOT</em></span>. Any <em class="parameter"><code>%g</code></em> will be replaced with the group name and + any <em class="parameter"><code>%u</code></em> will be replaced with the user name. + </p><p> + Note that the <code class="literal">adduser</code> command used in the example below does + not support the used syntax on all systems. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add user to group script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add user to group script</code></em> = <code class="literal">/usr/sbin/adduser %u %g</code> +</em></span> +</p></dd><dt><span class="term"><a name="ADMINUSERS"></a>admin users (S)</span></dt><dd><p>This is a list of users who will be granted + administrative privileges on the share. This means that they + will do all file operations as the super-user (root).</p><p>You should use this option very carefully, as any user in + this list will be able to do anything they like on the share, + irrespective of file permissions.</p><p>This parameter will not work with the <a class="indexterm" name="id310304"></a>security = share in + Samba 3.0. This is by design.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>admin users</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>admin users</code></em> = <code class="literal">jason</code> +</em></span> +</p></dd><dt><span class="term"><a name="AFSSHARE"></a>afs share (S)</span></dt><dd><p>This parameter controls whether special AFS features are enabled + for this share. If enabled, it assumes that the directory exported via + the <em class="parameter"><code>path</code></em> 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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>afs share</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="AFSUSERNAMEMAP"></a>afs username map (G)</span></dt><dd><p>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. + </p><p>The mapped user name must contain the cell name to log into, + so without setting this parameter there will be no token.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>afs username map</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>afs username map</code></em> = <code class="literal">%u@afs.samba.org</code> +</em></span> +</p></dd><dt><span class="term"><a name="AIOREADSIZE"></a>aio read size (S)</span></dt><dd><p>If Samba has been built with asynchronous I/O support and this + integer parameter is set to non-zero value, + Samba will read from file asynchronously when size of request is bigger + than this value. Note that it happens only for non-chained and non-chaining + reads and when not using write cache.</p><p>Current implementation of asynchronous I/O in Samba 3.0 does support + only up to 10 outstanding asynchronous requests, read and write combined.</p> + + write cache size + aio write size + +<p>Default: <span class="emphasis"><em><em class="parameter"><code>aio read size</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>aio read size</code></em> = <code class="literal">16384 +# Use asynchronous I/O for reads bigger than 16KB + request size</code> +</em></span> +</p></dd><dt><span class="term"><a name="AIOWRITESIZE"></a>aio write size (S)</span></dt><dd><p>If Samba has been built with asynchronous I/O support and this + integer parameter is set to non-zero value, + Samba will write to file asynchronously when size of request is bigger + than this value. Note that it happens only for non-chained and non-chaining + reads and when not using write cache.</p><p>Current implementation of asynchronous I/O in Samba 3.0 does support + only up to 10 outstanding asynchronous requests, read and write combined.</p> + + write cache size + aio read size + +<p>Default: <span class="emphasis"><em><em class="parameter"><code>aio write size</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>aio write size</code></em> = <code class="literal">16384 +# Use asynchronous I/O for writes bigger than 16KB + request size</code> +</em></span> +</p></dd><dt><span class="term"><a name="ALGORITHMICRIDBASE"></a>algorithmic rid base (G)</span></dt><dd><p>This determines how Samba will use its + algorithmic mapping from uids/gid to the RIDs needed to construct + NT Security Identifiers. + </p><p>Setting this option to a larger value could be useful to sites + transitioning from WinNT and Win2k, as existing user and + group rids would otherwise clash with sytem users etc. + </p><p>All UIDs and GIDs must be able to be resolved into SIDs for + the correct operation of ACLs on the server. As such the algorithmic + mapping can't be 'turned off', but pushing it 'out of the way' should + resolve the issues. Users and groups can then be assigned 'low' RIDs + in arbitrary-rid supporting backends. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>algorithmic rid base</code></em> = <code class="literal">1000</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>algorithmic rid base</code></em> = <code class="literal">100000</code> +</em></span> +</p></dd><dt><span class="term"><a name="ALLOCATIONROUNDUPSIZE"></a>allocation roundup size (S)</span></dt><dd><p>This parameter allows an administrator to tune the + allocation size reported to Windows clients. The default + size of 1Mb generally results in improved Windows client + performance. However, rounding the allocation size may cause + difficulties for some applications, e.g. MS Visual Studio. + If the MS Visual Studio compiler starts to crash with an + internal error, set this parameter to zero for this share. + </p><p>The integer parameter specifies the roundup size in bytes.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>allocation roundup size</code></em> = <code class="literal">1048576</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>allocation roundup size</code></em> = <code class="literal">0 +# (to disable roundups)</code> +</em></span> +</p></dd><dt><span class="term"><a name="ALLOWTRUSTEDDOMAINS"></a>allow trusted domains (G)</span></dt><dd><p> + This option only takes effect when the <a class="indexterm" name="id310731"></a>security option is set to + <code class="constant">server</code>, <code class="constant">domain</code> or <code class="constant">ads</code>. + If it is set to no, then attempts to connect to a resource from + a domain or workgroup other than the one which smbd is running + in will fail, even if that domain is trusted by the remote server + doing the authentication.</p><p>This is useful if you only want your Samba server to + serve resources to users in the domain it is a member of. As + an example, suppose that there are two domains DOMA and DOMB. DOMB + is trusted by DOMA, which contains the Samba server. Under normal + circumstances, a user with an account in DOMB can then access the + resources of a UNIX account with the same account name on the + Samba server even if they do not have an account in DOMA. This + can make implementing a security boundary difficult.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>allow trusted domains</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="ANNOUNCEAS"></a>announce as (G)</span></dt><dd><p>This specifies what type of server <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will announce itself as, to a network neighborhood browse + list. By default this is set to Windows NT. The valid options + are : "NT Server" (which can also be written as "NT"), + "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, + Windows NT Workstation, Windows 95 and Windows for Workgroups + respectively. Do not change this parameter unless you have a + specific need to stop Samba appearing as an NT server as this + may prevent Samba servers from participating as browser servers + correctly.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>announce as</code></em> = <code class="literal">NT Server</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>announce as</code></em> = <code class="literal">Win95</code> +</em></span> +</p></dd><dt><span class="term"><a name="ANNOUNCEVERSION"></a>announce version (G)</span></dt><dd><p>This specifies the major and minor version numbers + that nmbd will use when announcing itself as a server. The default + is 4.9. Do not change this parameter unless you have a specific + need to set a Samba server to be a downlevel server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>announce version</code></em> = <code class="literal">4.9</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>announce version</code></em> = <code class="literal">2.0</code> +</em></span> +</p></dd><dt><span class="term"><a name="AUTHMETHODS"></a>auth methods (G)</span></dt><dd><p> + This option allows the administrator to chose what authentication methods <code class="literal">smbd</code> + will use when authenticating a user. This option defaults to sensible values based on <a class="indexterm" name="id310928"></a>security. + This should be considered a developer option and used only in rare circumstances. In the majority (if not all) + of production servers, the default setting should be adequate. + </p><p> + Each entry in the list attempts to authenticate the user in turn, until + the user authenticates. In practice only one method will ever actually + be able to complete the authentication. + </p><p> + Possible options include <code class="constant">guest</code> (anonymous access), + <code class="constant">sam</code> (lookups in local list of accounts based on netbios + name or domain name), <code class="constant">winbind</code> (relay authentication requests + for remote users through winbindd), <code class="constant">ntdomain</code> (pre-winbindd + method of authentication for remote domain users; deprecated in favour of winbind method), + <code class="constant">trustdomain</code> (authenticate trusted users by contacting the + remote DC directly from smbd; deprecated in favour of winbind method). + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>auth methods</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>auth methods</code></em> = <code class="literal">guest sam winbind</code> +</em></span> +</p></dd><dt><span class="term"><a name="AVAILABLE"></a>available (S)</span></dt><dd><p>This parameter lets you "turn off" a service. If + <em class="parameter"><code>available = no</code></em>, then <span class="emphasis"><em>ALL</em></span> + attempts to connect to the service will fail. Such failures are + logged.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>available</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="BINDINTERFACESONLY"></a>bind interfaces only (G)</span></dt><dd><p>This global parameter allows the Samba admin + to limit what interfaces on a machine will serve SMB requests. It + affects file service <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and name service <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> in a slightly different ways.</p><p> + For name service it causes <code class="literal">nmbd</code> to bind to ports 137 and 138 on the + interfaces listed in the <a class="indexterm" name="id311097"></a>interfaces parameter. <code class="literal">nmbd</code> + also binds to the "all addresses" interface (0.0.0.0) on ports 137 and 138 for the purposes of + reading broadcast messages. If this option is not set then <code class="literal">nmbd</code> will + service name requests on all of these sockets. If <a class="indexterm" name="id311118"></a>bind interfaces only is set then + <code class="literal">nmbd</code> will check the source address of any packets coming in on the + broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the + <a class="indexterm" name="id311132"></a>interfaces parameter list. As unicast packets are received on the other sockets it + allows <code class="literal">nmbd</code> to refuse to serve names to machines that send packets that + arrive through any interfaces not listed in the <a class="indexterm" name="id311147"></a>interfaces list. IP Source address + spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for + <code class="literal">nmbd</code>. + </p><p> + For file service it causes <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to bind only to the interface list given in the <a class="indexterm" name="id311172"></a>interfaces parameter. This restricts the networks that <code class="literal">smbd</code> will + serve to packets coming in those interfaces. Note that you should not use this parameter for machines that + are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with + non-permanent interfaces. + </p><p> + If <a class="indexterm" name="id311191"></a>bind interfaces only is set then unless the network address + <span class="emphasis"><em>127.0.0.1</em></span> is added to the <a class="indexterm" name="id311202"></a>interfaces parameter list + <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> and + <a href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> may not work as + expected due to the reasons covered below. + </p><p> + To change a users SMB password, the <code class="literal">smbpasswd</code> by default connects to the + <span class="emphasis"><em>localhost - 127.0.0.1</em></span> address as an SMB client to issue the password change request. If + <a class="indexterm" name="id311240"></a>bind interfaces only is set then unless the network address + <span class="emphasis"><em>127.0.0.1</em></span> is added to the <a class="indexterm" name="id311251"></a>interfaces parameter list then <code class="literal"> smbpasswd</code> will fail to connect in it's default mode. <code class="literal">smbpasswd</code> can be forced to use the primary IP interface of the local host by using + its <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> <em class="parameter"><code>-r <em class="replaceable"><code>remote machine</code></em></code></em> parameter, with <em class="replaceable"><code>remote + machine</code></em> set to the IP name of the primary interface of the local host. + </p><p> + The <code class="literal">swat</code> status page tries to connect with <code class="literal">smbd</code> and <code class="literal">nmbd</code> at the address + <span class="emphasis"><em>127.0.0.1</em></span> to determine if they are running. Not adding <span class="emphasis"><em>127.0.0.1</em></span> + will cause <code class="literal"> smbd</code> and <code class="literal">nmbd</code> to always show + "not running" even if they really are. This can prevent <code class="literal"> swat</code> + from starting/stopping/restarting <code class="literal">smbd</code> and <code class="literal">nmbd</code>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>bind interfaces only</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="BLOCKINGLOCKS"></a>blocking locks (S)</span></dt><dd><p>This parameter controls the behavior + of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when given a request by a client + to obtain a byte range lock on a region of an open file, and the + request has a time limit associated with it.</p><p>If this parameter is set and the lock range requested + cannot be immediately satisfied, samba will internally + queue the lock request, and periodically attempt to obtain + the lock until the timeout period expires.</p><p>If this parameter is set to <code class="constant">no</code>, then + samba will behave as previous versions of Samba would and + will fail the lock request immediately if the lock range + cannot be obtained.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>blocking locks</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="BLOCKSIZE"></a>block size (S)</span></dt><dd><p>This parameter controls the behavior of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when reporting disk free + sizes. By default, this reports a disk block size of 1024 bytes. + </p><p>Changing this parameter may have some effect on the + efficiency of client writes, this is not yet confirmed. This + parameter was added to allow advanced administrators to change + it (usually to a higher value) and test the effect it has on + client write performance without re-compiling the code. As this + is an experimental option it may be removed in a future release. + </p><p>Changing this option does not change the disk free reporting + size, just the block size unit reported to the client. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>block size</code></em> = <code class="literal">1024</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>block size</code></em> = <code class="literal">4096</code> +</em></span> +</p></dd><dt><span class="term"><a name="BROWSABLE"></a>browsable</span></dt><dd><p>This parameter is a synonym for browseable.</p></dd><dt><span class="term"><a name="BROWSEABLE"></a>browseable (S)</span></dt><dd><p>This controls whether this share is seen in + the list of available shares in a net view and in the browse list.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>browseable</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="BROWSELIST"></a>browse list (G)</span></dt><dd><p>This controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will serve a browse list to + a client doing a <code class="literal">NetServerEnum</code> call. Normally + set to <code class="constant">yes</code>. You should never need to change + this.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>browse list</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="CASESIGNAMES"></a>casesignames</span></dt><dd><p>This parameter is a synonym for case sensitive.</p></dd><dt><span class="term"><a name="CASESENSITIVE"></a>case sensitive (S)</span></dt><dd><p>See the discussion in the section <a class="indexterm" name="id311661"></a>name mangling.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>case sensitive</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="CHANGENOTIFY"></a>change notify (S)</span></dt><dd><p>This parameter specifies whether Samba should reply + to a client's file change notify requests. + </p><p>You should never need to change this parameter</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>change notify</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="CHANGESHARECOMMAND"></a>change share command (G)</span></dt><dd><p> + Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server +Manager. The <em class="parameter"><code>change share command</code></em> is used to define an external +program or script which will modify an existing service definition in <code class="filename">smb.conf</code>. In order to successfully execute the <em class="parameter"><code>change +share command</code></em>, <code class="literal">smbd</code> requires that the administrator be +connected using a root account (i.e. uid == 0). + </p><p> + If the connected account has <code class="literal">SeDiskOperatorPrivilege</code>, scripts defined in + <em class="parameter"><code>change share</code></em> parameter are executed as root. + </p><p> + When executed, <code class="literal">smbd</code> will automatically invoke the + <em class="parameter"><code>change share command</code></em> with five parameters. + </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>configFile</code></em> - the location + of the global <code class="filename">smb.conf</code> file. + </p></li><li><p><em class="parameter"><code>shareName</code></em> - the name of the new + share. + </p></li><li><p><em class="parameter"><code>pathName</code></em> - path to an **existing** + directory on disk. + </p></li><li><p><em class="parameter"><code>comment</code></em> - comment string to associate + with the new share. + </p></li><li><p><em class="parameter"><code>max + connections</code></em> + Number of maximum simultaneous connections to this + share. + </p></li></ul></div><p> + This parameter is only used modify existing file shares definitions. To modify + printer shares, use the "Printers..." folder as seen when browsing the Samba host. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>change share command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>change share command</code></em> = <code class="literal">/usr/local/bin/addshare</code> +</em></span> +</p></dd><dt><span class="term"><a name="CHECKPASSWORDSCRIPT"></a>check password script (G)</span></dt><dd><p>The name of a program that can be used to check password + complexity. The password is sent to the program's standrad input.</p><p>The program must return 0 on good password any other value otherwise. + In case the password is considered weak (the program do not return 0) the + user will be notified and the password change will fail.</p><p>Note: In the example directory there is a sample program called crackcheck + that uses cracklib to checkpassword quality</p>. + + +<p>Default: <span class="emphasis"><em><em class="parameter"><code>check password script</code></em> = <code class="literal">Disabled</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>check password script</code></em> = <code class="literal">check password script = /usr/local/sbin/crackcheck</code> +</em></span> +</p></dd><dt><span class="term"><a name="CLIENTLANMANAUTH"></a>client lanman auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> and other samba client + tools will attempt to authenticate itself to servers using the + weaker LANMAN password hash. If disabled, only server which support NT + password hashes (e.g. Windows NT/2000, Samba, etc... but not + Windows 95/98) will be able to be connected from the Samba client.</p><p>The LANMAN encrypted response is easily broken, due to it's + case-insensitive nature, and the choice of algorithm. Clients + without Windows 95/98 servers are advised to disable + this option. </p><p>Disabling this option will also disable the <code class="literal">client plaintext auth</code> option</p><p>Likewise, if the <code class="literal">client ntlmv2 + auth</code> parameter is enabled, then only NTLMv2 logins will be + attempted.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client lanman auth</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="CLIENTLDAPSASLWRAPPING"></a>client ldap sasl wrapping (G)</span></dt><dd><p> + The <a class="indexterm" name="id312072"></a>client ldap sasl wrapping defines whether + ldap traffic will be signed or signed and encrypted (sealed). + Possible values are <span class="emphasis"><em>plain</em></span>, <span class="emphasis"><em>sign</em></span> + and <span class="emphasis"><em>seal</em></span>. + </p><p> + The values <span class="emphasis"><em>sign</em></span> and <span class="emphasis"><em>seal</em></span> are + only available if Samba has been compiled against a modern + OpenLDAP version (2.3.x or higher). + </p><p> + This option is needed in the case of Domain Controllers enforcing + the usage of signed LDAP connections (e.g. Windows 2000 SP3 or higher). + LDAP sign and seal can be controlled with the registry key + "HKLM\System\CurrentControlSet\Services\NTDS\Parameters\LDAPServerIntegrity" + on the Windows server side. + </p><p> + Depending on the used KRB5 library (MIT and older Heimdal versions) + it is possible that the message "integrity only" is not supported. + In this case, <span class="emphasis"><em>sign</em></span> is just an alias for + <span class="emphasis"><em>seal</em></span>. + </p><p> + The default value is <span class="emphasis"><em>plain</em></span> which is not irritable + to KRB5 clock skew errors. That implies synchronizing the time + with the KDC in the case of using <span class="emphasis"><em>sign</em></span> or + <span class="emphasis"><em>seal</em></span>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client ldap sasl wrapping</code></em> = <code class="literal">plain</code> +</em></span> +</p></dd><dt><span class="term"><a name="CLIENTNTLMV2AUTH"></a>client ntlmv2 auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> will attempt to + authenticate itself to servers using the NTLMv2 encrypted password + response.</p><p>If enabled, only an NTLMv2 and LMv2 response (both much more + secure than earlier versions) will be sent. Many servers + (including NT4 < SP4, Win9x and Samba 2.2) are not compatible with + NTLMv2. </p><p>Similarly, if enabled, NTLMv1, <code class="literal">client lanman auth</code> and <code class="literal">client plaintext auth</code> + authentication will be disabled. This also disables share-level + authentication. </p><p>If disabled, an NTLM response (and possibly a LANMAN response) + will be sent by the client, depending on the value of <code class="literal">client lanman auth</code>. </p><p>Note that some sites (particularly + those following 'best practice' security polices) only allow NTLMv2 + responses, and not the weaker LM or NTLM.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client ntlmv2 auth</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="CLIENTPLAINTEXTAUTH"></a>client plaintext auth (G)</span></dt><dd><p>Specifies whether a client should send a plaintext + password if the server does not support encrypted passwords.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client plaintext auth</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="CLIENTSCHANNEL"></a>client schannel (G)</span></dt><dd><p> + This controls whether the client offers or even demands the use of the netlogon schannel. + <a class="indexterm" name="id312298"></a>client schannel = no does not offer the schannel, + <a class="indexterm" name="id312306"></a>client schannel = auto offers the schannel but does not + enforce it, and <a class="indexterm" name="id312313"></a>client schannel = yes denies access + if the server is not able to speak netlogon schannel. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client schannel</code></em> = <code class="literal">auto</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>client schannel</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="CLIENTSIGNING"></a>client signing (G)</span></dt><dd><p>This controls whether the client offers or requires + the server it talks to to use SMB signing. Possible values + are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span> + and <span class="emphasis"><em>disabled</em></span>. + </p><p>When set to auto, SMB signing is offered, but not enforced. + When set to mandatory, SMB signing is required and if set + to disabled, SMB signing is not offered either. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client signing</code></em> = <code class="literal">auto</code> +</em></span> +</p></dd><dt><span class="term"><a name="CLIENTUSESPNEGO"></a>client use spnego (G)</span></dt><dd><p> This variable controls whether Samba clients will try + to use Simple and Protected NEGOciation (as specified by rfc2478) with + supporting servers (including WindowsXP, Windows2000 and Samba + 3.0) to agree upon an authentication + mechanism. This enables Kerberos authentication in particular.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client use spnego</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="COMMENT"></a>comment (S)</span></dt><dd><p>This is a text field that is seen next to a share + when a client does a queries the server, either via the network + neighborhood or via <code class="literal">net view</code> to list what shares + are available.</p><p>If you want to set the string that is displayed next to the + machine name then see the <a class="indexterm" name="id312483"></a>server string parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>comment</code></em> = <code class="literal"> +# No comment</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>comment</code></em> = <code class="literal">Fred's Files</code> +</em></span> +</p></dd><dt><span class="term"><a name="CONFIGBACKEND"></a>config backend (G)</span></dt><dd><p> + This controls the backend for storing the configuration. + Possible values are <span class="emphasis"><em>file</em></span> (the default) + and <span class="emphasis"><em>registry</em></span>. + When <a class="indexterm" name="id312554"></a>config backend = registry + is encountered while loading <span class="emphasis"><em>smb.conf</em></span>, + the configuration read so far is dropped and the global + options are read from registry instead. So this triggers a + registry only configuration. Share definitions are not read + immediately but instead <em class="parameter"><code>registry + shares</code></em> is set to <span class="emphasis"><em>yes</em></span>. + </p><p> + Note: This option can not be set inside the registry + configuration itself. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>config backend</code></em> = <code class="literal">file</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>config backend</code></em> = <code class="literal">registry</code> +</em></span> +</p></dd><dt><span class="term"><a name="CONFIGFILE"></a>config file (G)</span></dt><dd><p>This allows you to override the config file + to use, instead of the default (usually <code class="filename">smb.conf</code>). + There is a chicken and egg problem here as this option is set + in the config file!</p><p>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.</p><p>This option takes the usual substitutions, which can + be very useful.</p><p>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).</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>config file</code></em> = <code class="literal">/usr/local/samba/lib/smb.conf.%m</code> +</em></span> +</p></dd><dt><span class="term"><a name="COPY"></a>copy (S)</span></dt><dd><p>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.</p><p>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.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>copy</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>copy</code></em> = <code class="literal">otherservice</code> +</em></span> +</p></dd><dt><span class="term"><a name="CREATEMODE"></a>create mode</span></dt><dd><p>This parameter is a synonym for create mask.</p></dd><dt><span class="term"><a name="CREATEMASK"></a>create mask (S)</span></dt><dd><p> + When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to + UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may + be thought of as a bit-wise MASK for the UNIX modes of a file. Any bit <span class="emphasis"><em>not</em></span> set here will + be removed from the modes set on a file when it is created. + </p><p> + The default value of this parameter removes the <code class="literal">group</code> and <code class="literal">other</code> + write and execute bits from the UNIX modes. + </p><p> + Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the + <a class="indexterm" name="id312806"></a>force create mode parameter which is set to 000 by default. + </p><p> + This parameter does not affect directory masks. See the parameter <a class="indexterm" name="id312818"></a>directory mask + for details. + </p><p> + Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the + administrator wishes to enforce a mask on access control lists also, they need to set the <a class="indexterm" name="id312830"></a>security mask. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>create mask</code></em> = <code class="literal">0744</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>create mask</code></em> = <code class="literal">0775</code> +</em></span> +</p></dd><dt><span class="term"><a name="CSCPOLICY"></a>csc policy (S)</span></dt><dd><p> + This stands for <span class="emphasis"><em>client-side caching policy</em></span>, and specifies how clients capable of offline + caching will cache the files in the share. The valid values are: manual, documents, programs, disable. + </p><p> + These values correspond to those used on Windows servers. + </p><p> + For example, shares containing roaming profiles can have offline caching disabled using + <a class="indexterm" name="id312906"></a>csc policy = disable. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>csc policy</code></em> = <code class="literal">manual</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>csc policy</code></em> = <code class="literal">programs</code> +</em></span> +</p></dd><dt><span class="term"><a name="CUPSOPTIONS"></a>cups options (S)</span></dt><dd><p> + This parameter is only applicable if <a class="indexterm" name="id312969"></a>printing is + set to <code class="constant">cups</code>. Its value is a free form string of options + passed directly to the cups library. + </p><p> + You can pass any generic print option known to CUPS (as listed + in the CUPS "Software Users' Manual"). You can also pass any printer + specific option (as listed in "lpoptions -d printername -l") + valid for the target queue. + </p><p> + You should set this parameter to <code class="constant">raw</code> if your CUPS server + <code class="filename">error_log</code> file contains messages such as + "Unsupported format 'application/octet-stream'" when printing from a Windows client + through Samba. It is no longer necessary to enable + system wide raw printing in <code class="filename">/etc/cups/mime.{convs,types}</code>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cups options</code></em> = <code class="literal">""</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups options</code></em> = <code class="literal">"raw,media=a4,job-sheets=secret,secret"</code> +</em></span> +</p></dd><dt><span class="term"><a name="CUPSSERVER"></a>cups server (G)</span></dt><dd><p> + This parameter is only applicable if <a class="indexterm" name="id313063"></a>printing is set to <code class="constant">cups</code>. + </p><p> + If set, this option overrides the ServerName option in the CUPS <code class="filename">client.conf</code>. This is + necessary if you have virtual samba servers that connect to different CUPS daemons. + </p><p>Optionally, a port can be specified by separating the server name + and port number with a colon. If no port was specified, + the default port for IPP (631) will be used. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cups server</code></em> = <code class="literal">""</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups server</code></em> = <code class="literal">mycupsserver</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups server</code></em> = <code class="literal">mycupsserver:1631</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEADTIME"></a>deadtime (G)</span></dt><dd><p>The value of the parameter (a decimal integer) + represents the number of minutes of inactivity before a connection + is considered dead, and it is disconnected. The deadtime only takes + effect if the number of open files is zero.</p><p>This is useful to stop a server's resources being + exhausted by a large number of inactive connections.</p><p>Most clients have an auto-reconnect feature when a + connection is broken so in most cases this parameter should be + transparent to users.</p><p>Using this parameter with a timeout of a few minutes + is recommended for most systems.</p><p>A deadtime of zero indicates that no auto-disconnection + should be performed.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>deadtime</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>deadtime</code></em> = <code class="literal">15</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEBUGHIRESTIMESTAMP"></a>debug hires timestamp (G)</span></dt><dd><p> + Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this + boolean parameter adds microsecond resolution to the timestamp message header when turned on. + </p><p> + Note that the parameter <a class="indexterm" name="id313240"></a>debug timestamp must be on for this to have an effect. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug hires timestamp</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEBUGPID"></a>debug pid (G)</span></dt><dd><p> + When using only one log file for more then one forked <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>-process there may be hard to follow which process outputs which + message. This boolean parameter is adds the process-id to the timestamp message headers in the + logfile when turned on. + </p><p> + Note that the parameter <a class="indexterm" name="id313298"></a>debug timestamp must be on for this to have an effect. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug pid</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEBUGPREFIXTIMESTAMP"></a>debug prefix timestamp (G)</span></dt><dd><p> + With this option enabled, the timestamp message header is prefixed to the debug message without the + filename and function information that is included with the <a class="indexterm" name="id313346"></a>debug timestamp + parameter. This gives timestamps to the messages without adding an additional line. + </p><p> + Note that this parameter overrides the <a class="indexterm" name="id313357"></a>debug timestamp parameter. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug prefix timestamp</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="TIMESTAMPLOGS"></a>timestamp logs</span></dt><dd><p>This parameter is a synonym for debug timestamp.</p></dd><dt><span class="term"><a name="DEBUGTIMESTAMP"></a>debug timestamp (G)</span></dt><dd><p> + Samba debug log messages are timestamped by default. If you are running at a high + <a class="indexterm" name="id313424"></a>debug level these timestamps can be distracting. This + boolean parameter allows timestamping to be turned off. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug timestamp</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEBUGUID"></a>debug uid (G)</span></dt><dd><p> + Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the + current euid, egid, uid and gid to the timestamp message headers in the log file if turned on. + </p><p> + Note that the parameter <a class="indexterm" name="id313475"></a>debug timestamp must be on for this to have an effect. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug uid</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEFAULTCASE"></a>default case (S)</span></dt><dd><p>See the section on <a class="indexterm" name="id313521"></a>name mangling. + Also note the <a class="indexterm" name="id313528"></a>short preserve case parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default case</code></em> = <code class="literal">lower</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEFAULTDEVMODE"></a>default devmode (S)</span></dt><dd><p>This parameter is only applicable to <a class="indexterm" name="id313574"></a>printable services. + When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba + server has a Device Mode which defines things such as paper size and + orientation and duplex settings. The device mode can only correctly be + generated by the printer driver itself (which can only be executed on a + Win32 platform). Because smbd is unable to execute the driver code + to generate the device mode, the default behavior is to set this field + to NULL. + </p><p>Most problems with serving printer drivers to Windows NT/2k/XP clients + can be traced to a problem with the generated device mode. Certain drivers + will do things such as crashing the client's Explorer.exe with a NULL devmode. + However, other printer drivers can cause the client's spooler service + (spoolsv.exe) to die if the devmode was not created by the driver itself + (i.e. smbd generates a default devmode). + </p><p>This parameter should be used with care and tested with the printer + driver in question. It is better to leave the device mode to NULL + and let the Windows client set the correct values. Because drivers do not + do this all the time, setting <code class="literal">default devmode = yes</code> + will instruct smbd to generate a default one. + </p><p>For more information on Windows NT/2k printing and Device Modes, + see the <a href="http://msdn.microsoft.com/" target="_top">MSDN documentation</a>. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default devmode</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEFAULT"></a>default</span></dt><dd><p>This parameter is a synonym for default service.</p></dd><dt><span class="term"><a name="DEFAULTSERVICE"></a>default service (G)</span></dt><dd><p>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 <span class="emphasis"><em>NOT</em></span> + given in the parameter value (see example below).</p><p>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.</p><p> + Typically the default service would be a <a class="indexterm" name="id313686"></a>guest ok, <a class="indexterm" name="id313693"></a>read-only service.</p><p>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 <em class="parameter"><code>%S</code></em> to make a wildcard service. + </p><p>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.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default service</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>default service</code></em> = <code class="literal">pub</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEFERSHARINGVIOLATIONS"></a>defer sharing violations (G)</span></dt><dd><p> + Windows allows specifying how a file will be shared with + other processes when it is opened. Sharing violations occur when + a file is opened by a different process using options that violate + the share settings specified by other processes. This parameter causes + smbd to act as a Windows server does, and defer returning a "sharing + violation" error message for up to one second, allowing the client + to close the file causing the violation in the meantime. + </p><p>UNIX by default does not have this behaviour.</p><p> + There should be no reason to turn off this parameter, as it is + designed to enable Samba to more correctly emulate Windows. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>defer sharing violations</code></em> = <code class="literal">True</code> +</em></span> +</p></dd><dt><span class="term"><a name="DELETEGROUPSCRIPT"></a>delete group script (G)</span></dt><dd><p>This is the full pathname to a script that will + be run <span class="emphasis"><em>AS ROOT</em></span> <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a group is requested to be deleted. + It will expand any <em class="parameter"><code>%g</code></em> to the group name passed. + This script is only useful for installations using the Windows NT domain administration tools. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete group script</code></em> = <code class="literal"></code> +</em></span> +</p></dd><dt><span class="term"><a name="DELETEPRINTERCOMMAND"></a>deleteprinter command (G)</span></dt><dd><p>With the introduction of MS-RPC based printer + support for Windows NT/2000 clients in Samba 2.2, it is now + possible to delete printer at run time by issuing the + DeletePrinter() RPC call.</p><p>For a Samba host this means that the printer must be + physically deleted from underlying printing system. The + <a class="indexterm" name="id313883"></a>deleteprinter command defines a script to be run which + will perform the necessary operations for removing the printer + from the print system and from <code class="filename">smb.conf</code>. + </p><p>The <a class="indexterm" name="id313900"></a>deleteprinter command is + automatically called with only one parameter: <a class="indexterm" name="id313908"></a>printer name. + </p><p>Once the <a class="indexterm" name="id313918"></a>deleteprinter command has + been executed, <code class="literal">smbd</code> will reparse the <code class="filename"> + smb.conf</code> to associated printer no longer exists. + If the sharename is still valid, then <code class="literal">smbd + </code> will return an ACCESS_DENIED error to the client.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>deleteprinter command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>deleteprinter command</code></em> = <code class="literal">/usr/bin/removeprinter</code> +</em></span> +</p></dd><dt><span class="term"><a name="DELETEREADONLY"></a>delete readonly (S)</span></dt><dd><p>This parameter allows readonly files to be deleted. + This is not normal DOS semantics, but is allowed by UNIX.</p><p>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.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete readonly</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DELETESHARECOMMAND"></a>delete share command (G)</span></dt><dd><p> + Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server + Manager. The <em class="parameter"><code>delete share command</code></em> is used to define an external + program or script which will remove an existing service definition from + <code class="filename">smb.conf</code>. In order to successfully execute the + <em class="parameter"><code>delete share command</code></em>, <code class="literal">smbd</code> + requires that the administrator be connected using a root account (i.e. uid == 0). + </p><p> + If the connected account has <code class="literal">SeDiskOperatorPrivilege</code>, scripts defined in + <em class="parameter"><code>change share</code></em> parameter are executed as root. + </p><p> + When executed, <code class="literal">smbd</code> will automatically invoke the + <em class="parameter"><code>delete share command</code></em> with two parameters. + </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>configFile</code></em> - the location + of the global <code class="filename">smb.conf</code> file. + </p></li><li><p><em class="parameter"><code>shareName</code></em> - the name of + the existing service. + </p></li></ul></div><p> + This parameter is only used to remove file shares. To delete printer shares, + see the <a class="indexterm" name="id314137"></a>deleteprinter command. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete share command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete share command</code></em> = <code class="literal">/usr/local/bin/delshare</code> +</em></span> +</p></dd><dt><span class="term"><a name="DELETEUSERFROMGROUPSCRIPT"></a>delete user from group script (G)</span></dt><dd><p>Full path to the script that will be called when + a user is removed from a group using the Windows NT domain administration + tools. It will be run by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> <span class="emphasis"><em>AS ROOT</em></span>. + Any <em class="parameter"><code>%g</code></em> will be replaced with the group name and + any <em class="parameter"><code>%u</code></em> will be replaced with the user name. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete user from group script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete user from group script</code></em> = <code class="literal">/usr/sbin/deluser %u %g</code> +</em></span> +</p></dd><dt><span class="term"><a name="DELETEUSERSCRIPT"></a>delete user script (G)</span></dt><dd><p>This is the full pathname to a script that will + be run by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when managing users + with remote RPC (NT) tools. + </p><p>This script is called when a remote client removes a user + from the server, normally using 'User Manager for Domains' or + <code class="literal">rpcclient</code>.</p><p>This script should delete the given UNIX username.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete user script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete user script</code></em> = <code class="literal">/usr/local/samba/bin/del_user %u</code> +</em></span> +</p></dd><dt><span class="term"><a name="DELETEVETOFILES"></a>delete veto files (S)</span></dt><dd><p>This option is used when Samba is attempting to + delete a directory that contains one or more vetoed directories + (see the <a class="indexterm" name="id314355"></a>veto files + option). If this option is set to <code class="constant">no</code> (the default) then if a vetoed + directory contains any non-vetoed files or directories then the + directory delete will fail. This is usually what you want.</p><p>If this option is set to <code class="constant">yes</code>, then Samba + will attempt to recursively delete any files and directories within + the vetoed directory. This can be useful for integration with file + serving systems such as NetAtalk which create meta-files within + directories you might normally veto DOS/Windows users from seeing + (e.g. <code class="filename">.AppleDouble</code>)</p><p>Setting <a class="indexterm" name="id314386"></a>delete veto files = yes allows these + directories to be transparently deleted when the parent directory + is deleted (so long as the user has permissions to do so).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete veto files</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DFREECACHETIME"></a>dfree cache time (S)</span></dt><dd><p> + The <em class="parameter"><code>dfree cache time</code></em> 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. + </p><p> + 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 <a class="indexterm" name="id314446"></a>dfree command scripts increasing the load. + </p><p> + By default this parameter is zero, meaning no caching will be done. + </p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dfree cache time</code></em> = <code class="literal">dfree cache time = 60</code> +</em></span> +</p></dd><dt><span class="term"><a name="DFREECOMMAND"></a>dfree command (S)</span></dt><dd><p> + The <em class="parameter"><code>dfree command</code></em> 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. + </p><p> + 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. + </p><p> + In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the + parameter <a class="indexterm" name="id314518"></a>dfree cache time was added to allow the output of this script to be cached + for systems under heavy load. + </p><p> + The external program will be passed a single parameter indicating a directory in the filesystem being queried. + This will typically consist of the string <code class="filename">./</code>. 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. + </p><p> + Note: Your script should <span class="emphasis"><em>NOT</em></span> be setuid or setgid and should be owned by (and writeable + only by) root! + </p><p> + Where the script dfree (which must be made executable) could be: +</p><pre class="programlisting"> +#!/bin/sh +df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}' +</pre><p> + or perhaps (on Sys V based systems): +</p><pre class="programlisting"> +#!/bin/sh +/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' +</pre><p> + Note that you may have to replace the command names with full path names on some systems. + </p><p> + By default internal routines for determining the disk capacity and remaining space will be used. + </p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dfree command</code></em> = <code class="literal">/usr/local/samba/bin/dfree</code> +</em></span> +</p></dd><dt><span class="term"><a name="DIRECTORYMODE"></a>directory mode</span></dt><dd><p>This parameter is a synonym for directory mask.</p></dd><dt><span class="term"><a name="DIRECTORYMASK"></a>directory mask (S)</span></dt><dd><p>This parameter is the octal modes which are + used when converting DOS modes to UNIX modes when creating UNIX + directories.</p><p>When a directory is created, the necessary permissions are + calculated according to the mapping from DOS modes to UNIX permissions, + and the resulting UNIX mode is then bit-wise 'AND'ed with this + parameter. This parameter may be thought of as a bit-wise MASK for + the UNIX modes of a directory. Any bit <span class="emphasis"><em>not</em></span> set + here will be removed from the modes set on a directory when it is + created.</p><p>The default value of this parameter removes the 'group' + and 'other' write bits from the UNIX mode, allowing only the + user who owns the directory to modify it.</p><p>Following this Samba will bit-wise 'OR' the UNIX mode + created from this parameter with the value of the <a class="indexterm" name="id314651"></a>force directory mode parameter. + This parameter is set to 000 by default (i.e. no extra mode bits are added).</p><p>Note that this parameter does not apply to permissions + set by Windows NT/2000 ACL editors. If the administrator wishes to enforce + a mask on access control lists also, they need to set the <a class="indexterm" name="id314664"></a>directory security mask.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>directory mask</code></em> = <code class="literal">0755</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>directory mask</code></em> = <code class="literal">0775</code> +</em></span> +</p></dd><dt><span class="term"><a name="DIRECTORYSECURITYMASK"></a>directory security mask (S)</span></dt><dd><p>This parameter controls what UNIX permission bits + will be set when a Windows NT client is manipulating the UNIX + permission on a directory using the native NT security dialog + box.</p><p> + This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting + any bits not in this mask. Make sure not to mix up this parameter with <a class="indexterm" name="id314734"></a>force directory security mode, which works similar like this one but uses logical OR instead of AND. + Essentially, zero bits in this mask are a set of bits that will always be set to zero. + </p><p> + Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the + file permissions regardless of the previous status of this bits on the file. + </p><p>If not set explicitly this parameter is set to 0777 + meaning a user is allowed to set all the user/group/world + permissions on a directory.</p><p><span class="emphasis"><em>Note</em></span> that users who can access the + Samba server through other means can easily bypass this restriction, + so it is primarily useful for standalone "appliance" systems. + Administrators of most normal systems will probably want to leave + it as the default of <code class="constant">0777</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>directory security mask</code></em> = <code class="literal">0777</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>directory security mask</code></em> = <code class="literal">0700</code> +</em></span> +</p></dd><dt><span class="term"><a name="DISABLENETBIOS"></a>disable netbios (G)</span></dt><dd><p>Enabling this parameter will disable netbios support + in Samba. Netbios is the only available form of browsing in + all windows versions except for 2000 and XP. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Clients that only support netbios won't be able to + see your samba server when netbios support is disabled. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>disable netbios</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DISABLESPOOLSS"></a>disable spoolss (G)</span></dt><dd><p>Enabling this parameter will disable Samba's support + for the SPOOLSS set of MS-RPC's and will yield identical behavior + as Samba 2.0.x. Windows NT/2000 clients will downgrade to using + Lanman style printing commands. Windows 9x/ME will be unaffected by + the parameter. However, this will also disable the ability to upload + printer drivers to a Samba server via the Windows NT Add Printer + Wizard or by using the NT printer properties dialog window. It will + also disable the capability of Windows NT/2000 clients to download + print drivers from the Samba host upon demand. + <span class="emphasis"><em>Be very careful about enabling this parameter.</em></span> +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>disable spoolss</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DISPLAYCHARSET"></a>display charset (G)</span></dt><dd><p> + Specifies the charset that samba will use to print messages to stdout and stderr. + The default value is "LOCALE", which means automatically set, depending on the + current locale. The value should generally be the same as the value of the parameter + <a class="indexterm" name="id314912"></a>unix charset. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>display charset</code></em> = <code class="literal">"LOCALE" or "ASCII" (depending on the system)</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>display charset</code></em> = <code class="literal">UTF8</code> +</em></span> +</p></dd><dt><span class="term"><a name="DMAPISUPPORT"></a>dmapi support (S)</span></dt><dd><p>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. + </p><p>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. + </p><p>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. + </p><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dmapi support</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DNSPROXY"></a>dns proxy (G)</span></dt><dd><p>Specifies that <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> when acting as a WINS server and + finding that a NetBIOS name has not been registered, should treat the + NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server + for that name on behalf of the name-querying client.</p><p>Note that the maximum length for a NetBIOS name is 15 + characters, so the DNS name (or DNS alias) can likewise only be + 15 characters, maximum.</p><p><code class="literal">nmbd</code> spawns a second copy of itself to do the + DNS name lookup requests, as doing a name lookup is a blocking + action.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dns proxy</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="DOMAINLOGONS"></a>domain logons (G)</span></dt><dd><p> + If set to <code class="constant">yes</code>, the Samba server will + provide the netlogon service for Windows 9X network logons for the + <a class="indexterm" name="id315094"></a>workgroup it is in. + This will also cause the Samba server to act as a domain + controller for NT4 style domain services. For more details on + setting up this feature see the Domain Control chapter of the + Samba HOWTO Collection. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>domain logons</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DOMAINMASTER"></a>domain master (G)</span></dt><dd><p> + Tell <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to enable + WAN-wide browse list collation. Setting this option causes <code class="literal">nmbd</code> to claim a + special domain specific NetBIOS name that identifies it as a domain master browser for its given + <a class="indexterm" name="id315156"></a>workgroup. Local master browsers in the same <a class="indexterm" name="id315164"></a>workgroup on + broadcast-isolated subnets will give this <code class="literal">nmbd</code> their local browse lists, + and then ask <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> for a + complete copy of the browse list for the whole wide area network. Browser clients will then contact their + local master browser, and will receive the domain-wide browse list, instead of just the list for their + broadcast-isolated subnet. + </p><p> + Note that Windows NT Primary Domain Controllers expect to be able to claim this <a class="indexterm" name="id315191"></a>workgroup specific special NetBIOS name that identifies them as domain master browsers for that + <a class="indexterm" name="id315199"></a>workgroup by default (i.e. there is no way to prevent a Windows NT PDC from attempting + to do this). This means that if this parameter is set and <code class="literal">nmbd</code> claims the + special name for a <a class="indexterm" name="id315213"></a>workgroup before a Windows NT PDC is able to do so then cross + subnet browsing will behave strangely and may fail. + </p><p> + If <a class="indexterm" name="id315225"></a>domain logons = yes, then the default behavior is to enable the + <a class="indexterm" name="id315232"></a>domain master parameter. If <a class="indexterm" name="id315239"></a>domain logons is not enabled (the + default setting), then neither will <a class="indexterm" name="id315247"></a>domain master be enabled by default. + </p><p> + When <a class="indexterm" name="id315257"></a>domain logons = Yes the default setting for this parameter is + Yes, with the result that Samba will be a PDC. If <a class="indexterm" name="id315265"></a>domain master = No, + Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>domain master</code></em> = <code class="literal">auto</code> +</em></span> +</p></dd><dt><span class="term"><a name="DONTDESCEND"></a>dont descend (S)</span></dt><dd><p>There are certain directories on some systems + (e.g., the <code class="filename">/proc</code> 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.</p><p>Note that Samba can be very fussy about the exact format + of the "dont descend" entries. For example you may need <code class="filename"> + ./proc</code> instead of just <code class="filename">/proc</code>. + Experimentation is the best policy :-) </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dont descend</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dont descend</code></em> = <code class="literal">/proc,/dev</code> +</em></span> +</p></dd><dt><span class="term"><a name="DOSCHARSET"></a>dos charset (G)</span></dt><dd><p>DOS SMB clients assume the server has + the same charset as they do. This option specifies which + charset Samba should talk to DOS clients. + </p><p>The default depends on which charsets you have installed. + Samba tries to use charset 850 but falls back to ASCII in + case it is not available. Run <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> to check the default on your system.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="DOSFILEMODE"></a>dos filemode (S)</span></dt><dd><p> The default behavior in Samba is to provide + UNIX-like behavior where only the owner of a file/directory is + able to change the permissions on it. However, this behavior + is often confusing to DOS/Windows users. Enabling this parameter + allows a user who has write access to the file (by whatever + means) to modify the permissions (including ACL) on it. Note that a user + belonging to the group owning the file will not be allowed to + change permissions if the group is only granted read access. + Ownership of the file/directory may also be changed.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filemode</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DOSFILETIMERESOLUTION"></a>dos filetime resolution (S)</span></dt><dd><p>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 <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>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.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filetime resolution</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="DOSFILETIMES"></a>dos filetimes (S)</span></dt><dd><p>Under DOS and Windows, if a user can write to a + file they can change the timestamp on it. Under POSIX semantics, + only the owner of the file or root may change the timestamp. By + default, Samba runs with POSIX semantics and refuses to change the + timestamp on a file if the user <code class="literal">smbd</code> is acting + on behalf of is not the file owner. Setting this option to <code class="constant"> + yes</code> allows DOS semantics and <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will change the file + timestamp as DOS requires. Due to changes in Microsoft Office 2000 and beyond, + the default for this parameter has been changed from "no" to "yes" in Samba 3.0.14 + and above. Microsoft Excel will display dialog box warnings about the file being + changed by another user if this parameter is not set to "yes" and files are being + shared between users. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filetimes</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="EASUPPORT"></a>ea support (S)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow clients to attempt to store OS/2 style Extended + attributes on a share. In order to enable this parameter the underlying filesystem exported by + the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the + correct kernel patches). On Linux the filesystem must have been mounted with the mount + option user_xattr in order for extended attributes to work, also + extended attributes must be compiled into the Linux kernel.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ea support</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="ENABLEASUSUPPORT"></a>enable asu support (G)</span></dt><dd><p>Hosts running the "Advanced Server for Unix (ASU)" product + require some special accomodations such as creating a builting [ADMIN$] + share that only supports IPC connections. The has been the default + behavior in smbd for many years. However, certain Microsoft applications + such as the Print Migrator tool require that the remote server support + an [ADMIN$} file share. Disabling this parameter allows for creating + an [ADMIN$] file share in smb.conf.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable asu support</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="ENABLEPRIVILEGES"></a>enable privileges (G)</span></dt><dd><p> + This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either + <code class="literal">net rpc rights</code> or one of the Windows user and group manager tools. This parameter is + enabled by default. It can be disabled to prevent members of the Domain Admins group from being able to + assign privileges to users or groups which can then result in certain smbd operations running as root that + would normally run under the context of the connected user. + </p><p> + An example of how privileges can be used is to assign the right to join clients to a Samba controlled + domain without providing root access to the server via smbd. + </p><p> + Please read the extended description provided in the Samba HOWTO documentation. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable privileges</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="ENCRYPTPASSWORDS"></a>encrypt passwords (G)</span></dt><dd><p>This boolean controls whether encrypted passwords + will be negotiated with the client. Note that Windows NT 4.0 SP3 and + above and also Windows 98 will by default expect encrypted passwords + unless a registry entry is changed. To use encrypted passwords in + Samba see the chapter "User Database" in the Samba HOWTO Collection. + </p><p> + MS Windows clients that expect Microsoft encrypted passwords and that + do not have plain text password support enabled will be able to + connect only to a Samba server that has encrypted password support + enabled and for which the user accounts have a valid encrypted password. + Refer to the smbpasswd command man page for information regarding the + creation of encrypted passwords for user accounts. + </p><p> + The use of plain text passwords is NOT advised as support for this feature + is no longer maintained in Microsoft Windows products. If you want to use + plain text passwords you must set this parameter to no. + </p><p>In order for encrypted passwords to work correctly + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must either + have access to a local <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> file (see the <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> program for information on how to set up + and maintain this file), or set the <a class="indexterm" name="id315792"></a>security = [server|domain|ads] parameter which + causes <code class="literal">smbd</code> to authenticate against another + server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>encrypt passwords</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="ENHANCEDBROWSING"></a>enhanced browsing (G)</span></dt><dd><p>This option enables a couple of enhancements to + cross-subnet browse propagation that have been added in Samba + but which are not standard in Microsoft implementations. + </p><p>The first enhancement to browse propagation consists of a regular + wildcard query to a Samba WINS server for all Domain Master Browsers, + followed by a browse synchronization with each of the returned + DMBs. The second enhancement consists of a regular randomised browse + synchronization with all currently known DMBs.</p><p>You may wish to disable this option if you have a problem with empty + workgroups not disappearing from browse lists. Due to the restrictions + of the browse protocols these enhancements can cause a empty workgroup + to stay around forever which can be annoying.</p><p>In general you should leave this option enabled as it makes + cross-subnet browse propagation much more reliable.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enhanced browsing</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="ENUMPORTSCOMMAND"></a>enumports command (G)</span></dt><dd><p>The concept of a "port" is fairly foreign + to UNIX hosts. Under Windows NT/2000 print servers, a port + is associated with a port monitor and generally takes the form of + a local port (i.e. LPT1:, COM1:, FILE:) or a remote port + (i.e. LPD Port Monitor, etc...). By default, Samba has only one + port defined--<code class="constant">"Samba Printer Port"</code>. Under + Windows NT/2000, all printers must have a valid port name. + If you wish to have a list of ports displayed (<code class="literal">smbd + </code> does not use a port name for anything) other than + the default <code class="constant">"Samba Printer Port"</code>, you + can define <em class="parameter"><code>enumports command</code></em> to point to + a program which should generate a list of ports, one per line, + to standard output. This listing will then be used in response + to the level 1 and 2 EnumPorts() RPC.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enumports command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>enumports command</code></em> = <code class="literal">/usr/bin/listports</code> +</em></span> +</p></dd><dt><span class="term"><a name="EVENTLOGLIST"></a>eventlog list (G)</span></dt><dd><p>This option defines a list of log names that Samba will + report to the Microsoft EventViewer utility. The listed + eventlogs will be associated with tdb file on disk in the + <code class="filename">$(lockdir)/eventlog</code>. + </p><p> + The administrator must use an external process to parse the normal + Unix logs such as <code class="filename">/var/log/messages</code> + and write then entries to the eventlog tdb files. Refer to the + eventlogadm(8) utility for how to write eventlog entries. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>eventlog list</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>eventlog list</code></em> = <code class="literal">Security Application Syslog Apache</code> +</em></span> +</p></dd><dt><span class="term"><a name="FAKEDIRECTORYCREATETIMES"></a>fake directory create times (S)</span></dt><dd><p>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.</p><p>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.</p><p>However, Unix time semantics mean that the create time + reported by Samba will be updated whenever a file is created or + or deleted in the directory. NMAKE finds all object files in + the object directory. The timestamp of the last one built is then + compared to the timestamp of the object directory. If the + directory's timestamp if newer, then all object files + will be rebuilt. Enabling this option + ensures directories always predate their contents and an NMAKE build + will proceed as expected.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fake directory create times</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="FAKEOPLOCKS"></a>fake oplocks (S)</span></dt><dd><p>Oplocks are the way that SMB clients get permission + from a server to locally cache file operations. If a server grants + an oplock (opportunistic lock) then the client is free to assume + that it is the only one accessing the file and it will aggressively + cache file data. With some oplock types the client may even cache + file open/close operations. This can give enormous performance benefits. + </p><p>When you set <code class="literal">fake oplocks = yes</code>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will + always grant oplock requests no matter how many clients are using the file.</p><p>It is generally much better to use the real <a class="indexterm" name="id316132"></a>oplocks support rather + than this parameter.</p><p>If you enable this option on all read-only shares or + shares that you know will only be accessed from one client at a + time such as physically read-only media like CDROMs, you will see + a big performance improvement on many operations. If you enable + this option on shares where multiple clients may be accessing the + files read-write at the same time you can get data corruption. Use + this option carefully!</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fake oplocks</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="FOLLOWSYMLINKS"></a>follow symlinks (S)</span></dt><dd><p> + This parameter allows the Samba administrator to stop <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> from following symbolic links in a particular share. Setting this + parameter to <code class="constant">no</code> 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 <code class="filename">/etc/passwd</code> in their home directory for instance. However + it will slow filename lookups down slightly. + </p><p> + This option is enabled (i.e. <code class="literal">smbd</code> will follow symbolic links) by default. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>follow symlinks</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="FORCECREATEMODE"></a>force create mode (S)</span></dt><dd><p>This parameter specifies a set of UNIX mode bit + permissions that will <span class="emphasis"><em>always</em></span> be set on a + file created by Samba. This is done by bitwise 'OR'ing these bits onto + the mode bits of a file that is being created or having its + permissions changed. The default for this parameter is (in octal) + 000. The modes in this parameter are bitwise 'OR'ed onto the file + mode after the mask set in the <em class="parameter"><code>create mask</code></em> + parameter is applied.</p><p>The example below would force all created files to have read and execute + permissions set for 'group' and 'other' as well as the + read/write/execute bits set for the 'user'.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force create mode</code></em> = <code class="literal">000</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force create mode</code></em> = <code class="literal">0755</code> +</em></span> +</p></dd><dt><span class="term"><a name="FORCEDIRECTORYMODE"></a>force directory mode (S)</span></dt><dd><p>This parameter specifies a set of UNIX mode bit + permissions that will <span class="emphasis"><em>always</em></span> be set on a directory + created by Samba. This is done by bitwise 'OR'ing these bits onto the + mode bits of a directory that is being created. The default for this + parameter is (in octal) 0000 which will not add any extra permission + bits to a created directory. This operation is done after the mode + mask in the parameter <em class="parameter"><code>directory mask</code></em> is + applied.</p><p>The example below would force all created directories to have read and execute + permissions set for 'group' and 'other' as well as the + read/write/execute bits set for the 'user'.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force directory mode</code></em> = <code class="literal">000</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force directory mode</code></em> = <code class="literal">0755</code> +</em></span> +</p></dd><dt><span class="term"><a name="FORCEDIRECTORYSECURITYMODE"></a>force directory security mode (S)</span></dt><dd><p> + This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating + the UNIX permission on a directory using the native NT security dialog box. + </p><p> + This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this + mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="indexterm" name="id316406"></a>directory security mask, which works in a similar manner to this one, but uses a logical AND instead + of an OR. + </p><p> + Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, + to will enable (1) any flags that are off (0) but which the mask has set to on (1). + </p><p> + If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world + permissions on a directory without restrictions. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + Users who can access the Samba server through other means can easily bypass this restriction, so it is + primarily useful for standalone "appliance" systems. Administrators of most normal systems will + probably want to leave it set as 0000. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>force directory security mode</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force directory security mode</code></em> = <code class="literal">700</code> +</em></span> +</p></dd><dt><span class="term"><a name="GROUP"></a>group</span></dt><dd><p>This parameter is a synonym for force group.</p></dd><dt><span class="term"><a name="FORCEGROUP"></a>force group (S)</span></dt><dd><p>This specifies a UNIX group name that will be + assigned as the default primary group for all users connecting + to this service. This is useful for sharing files by ensuring + that all access to files on service will use the named group for + their permissions checking. Thus, by assigning permissions for this + group to the files and directories within this service the Samba + administrator can restrict or allow sharing of these files.</p><p>In Samba 2.0.5 and above this parameter has extended + functionality in the following way. If the group name listed here + has a '+' character prepended to it then the current user accessing + the share only has the primary group default assigned to this group + if they are already assigned as a member of that group. This allows + an administrator to decide that only users who are already in a + particular group will create files with group ownership set to that + group. This gives a finer granularity of ownership assignment. For + example, the setting <code class="filename">force group = +sys</code> means + that only users who are already in group sys will have their default + primary group assigned to sys when accessing this Samba share. All + other users will retain their ordinary primary group.</p><p> + If the <a class="indexterm" name="id266502"></a>force user parameter is also set the group specified in + <em class="parameter"><code>force group</code></em> will override the primary group + set in <em class="parameter"><code>force user</code></em>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force group</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force group</code></em> = <code class="literal">agroup</code> +</em></span> +</p></dd><dt><span class="term"><a name="FORCEPRINTERNAME"></a>force printername (S)</span></dt><dd><p>When printing from Windows NT (or later), + each printer in <code class="filename">smb.conf</code> has two + associated names which can be used by the client. The first + is the sharename (or shortname) defined in smb.conf. This + is the only printername available for use by Windows 9x clients. + The second name associated with a printer can be seen when + browsing to the "Printers" (or "Printers and Faxes") folder + on the Samba server. This is referred to simply as the printername + (not to be confused with the <em class="parameter"><code>printer name</code></em> option). + </p><p>When assigning a new driver to a printer on a remote + Windows compatible print server such as Samba, the Windows client + will rename the printer to match the driver name just uploaded. + This can result in confusion for users when multiple + printers are bound to the same driver. To prevent Samba from + allowing the printer's printername to differ from the sharename + defined in smb.conf, set <em class="parameter"><code>force printername = yes</code></em>. + </p><p>Be aware that enabling this parameter may affect migrating + printers from a Windows server to Samba since Windows has no way to + force the sharename and printername to match.</p><p>It is recommended that this parameter's value not be changed + once the printer is in use by clients as this could cause a user + not be able to delete printer connections from their local Printers + folder.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force printername</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="FORCESECURITYMODE"></a>force security mode (S)</span></dt><dd><p> + This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating + the UNIX permission on a file using the native NT security dialog box. + </p><p> + This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this + mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="indexterm" name="id316754"></a>security mask, which works similar like this one but uses logical AND instead of OR. + </p><p> + Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, + the user has always set to be on. + </p><p> + If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world + permissions on a file, with no restrictions. + </p><p><span class="emphasis"><em> + Note</em></span> that users who can access the Samba server through other means can easily bypass this + restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most + normal systems will probably want to leave this set to 0000. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force security mode</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force security mode</code></em> = <code class="literal">700</code> +</em></span> +</p></dd><dt><span class="term"><a name="FORCEUNKNOWNACLUSER"></a>force unknown acl user (S)</span></dt><dd><p> + If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or + representation of a user or group id) as the owner or group owner of the file will be silently + mapped into the current UNIX uid or gid of the currently connected user. + </p><p> + This is designed to allow Windows NT clients to copy files and folders containing ACLs that were + created locally on the client machine and contain users local to that machine only (no domain + users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and + groupid of the file owner map to the current connected user. This can only be fixed correctly + when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid. + </p><p> + Try using this parameter when XCOPY /O gives an ACCESS_DENIED error. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force unknown acl user</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="FORCEUSER"></a>force user (S)</span></dt><dd><p>This specifies a UNIX user name that will be + assigned as the default user for all users connecting to this service. + This is useful for sharing files. You should also use it carefully + as using it incorrectly can cause security problems.</p><p>This user name only gets used once a connection is established. + Thus clients still need to connect as a valid user and supply a + valid password. Once connected, all file operations will be performed + as the "forced user", no matter what username the client connected + as. This can be very useful.</p><p>In Samba 2.0.5 and above this parameter also causes the + primary group of the forced user to be used as the primary group + for all file activity. Prior to 2.0.5 the primary group was left + as the primary group of the connecting user (this was a bug).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force user</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force user</code></em> = <code class="literal">auser</code> +</em></span> +</p></dd><dt><span class="term"><a name="FSTYPE"></a>fstype (S)</span></dt><dd><p> + This parameter allows the administrator to configure the string that specifies the type of filesystem a share + is using that is reported by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> + when a client queries the filesystem type for a share. The default type is <code class="constant">NTFS</code> for compatibility + with Windows NT but this can be changed to other strings such as <code class="constant">Samba</code> or <code class="constant">FAT</code> + if required. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fstype</code></em> = <code class="literal">NTFS</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>fstype</code></em> = <code class="literal">Samba</code> +</em></span> +</p></dd><dt><span class="term"><a name="GETQUOTACOMMAND"></a>get quota command (G)</span></dt><dd><p>The <code class="literal">get quota command</code> should only be used + whenever there is no operating system API available from the OS that + samba can use.</p><p>This option is only available with <code class="literal">./configure --with-sys-quotas</code>. + Or on linux when <code class="literal">./configure --with-quotas</code> was used and a working quota api + was found in the system.</p><p>This parameter should specify the path to a script that + queries the quota information for the specified + user/group for the partition that + the specified directory is on.</p><p>Such a script should take 3 arguments:</p><div class="itemizedlist"><ul type="disc"><li><p>directory</p></li><li><p>type of query</p></li><li><p>uid of user or gid of group</p></li></ul></div><p>The type of query can be one of :</p><div class="itemizedlist"><ul type="disc"><li><p>1 - user quotas</p></li><li><p>2 - user default quotas (uid = -1)</p></li><li><p>3 - group quotas</p></li><li><p>4 - group default quotas (gid = -1)</p></li></ul></div><p>This script should print one line as output with spaces between the arguments. The arguments are: + </p><div class="itemizedlist"><ul type="disc"><li><p>Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</p></li><li><p>Arg 2 - number of currently used blocks</p></li><li><p>Arg 3 - the softlimit number of blocks</p></li><li><p>Arg 4 - the hardlimit number of blocks</p></li><li><p>Arg 5 - currently used number of inodes</p></li><li><p>Arg 6 - the softlimit number of inodes</p></li><li><p>Arg 7 - the hardlimit number of inodes</p></li><li><p>Arg 8(optional) - the number of bytes in a block(default is 1024)</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>get quota command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>get quota command</code></em> = <code class="literal">/usr/local/sbin/query_quota</code> +</em></span> +</p></dd><dt><span class="term"><a name="GETWDCACHE"></a>getwd cache (G)</span></dt><dd><p>This is a tuning option. When this is enabled a + caching algorithm will be used to reduce the time taken for getwd() + calls. This can have a significant impact on performance, especially + when the <a class="indexterm" name="id317205"></a>wide smbconfoptions parameter is set to <code class="constant">no</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>getwd cache</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="GUESTACCOUNT"></a>guest account (G)</span></dt><dd><p>This is a username which will be used for access + to services which are specified as <a class="indexterm" name="id317254"></a>guest ok (see below). Whatever privileges this + user has will be available to any client connecting to the guest service. + This user must exist in the password file, but does not require + a valid login. The user account "ftp" is often a good choice + for this parameter. + </p><p>On some systems the default guest account "nobody" may not + be able to print. Use another account in this case. You should test + this by trying to log in as your guest user (perhaps by using the + <code class="literal">su -</code> command) and trying to print using the + system print command such as <code class="literal">lpr(1)</code> or <code class="literal"> + lp(1)</code>.</p><p>This parameter does not accept % macros, because + many parts of the system require this value to be + constant for correct operation.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest account</code></em> = <code class="literal">nobody +# default can be changed at compile-time</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>guest account</code></em> = <code class="literal">ftp</code> +</em></span> +</p></dd><dt><span class="term"><a name="PUBLIC"></a>public</span></dt><dd><p>This parameter is a synonym for guest ok.</p></dd><dt><span class="term"><a name="GUESTOK"></a>guest ok (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code> for + a service, then no password is required to connect to the service. + Privileges will be those of the <a class="indexterm" name="id317373"></a>guest account.</p><p>This paramater nullifies the benifits of setting + <a class="indexterm" name="id317384"></a>restrict anonymous = 2 + </p><p>See the section below on <a class="indexterm" name="id317394"></a>security for more information about this option. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest ok</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="ONLYGUEST"></a>only guest</span></dt><dd><p>This parameter is a synonym for guest only.</p></dd><dt><span class="term"><a name="GUESTONLY"></a>guest only (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code> for + a service, then only guest connections to the service are permitted. + This parameter will have no effect if <a class="indexterm" name="id317465"></a>guest ok is not set for the service.</p><p>See the section below on <a class="indexterm" name="id317476"></a>security for more information about this option. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest only</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="HIDEDOTFILES"></a>hide dot files (S)</span></dt><dd><p>This is a boolean parameter that controls whether + files starting with a dot appear as hidden files.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide dot files</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="HIDEFILES"></a>hide files (S)</span></dt><dd><p>This is a list of files or directories that are not + visible but are accessible. The DOS 'hidden' attribute is applied + to any files or directories that match.</p><p>Each entry in the list must be separated by a '/', + which allows spaces to be included in the entry. '*' + and '?' can be used to specify multiple files or directories + as in DOS wildcards.</p><p>Each entry must be a Unix path, not a DOS path and must + not include the Unix directory separator '/'.</p><p>Note that the case sensitivity option is applicable + in hiding files.</p><p>Setting this parameter will affect the performance of Samba, + as it will be forced to check all files and directories for a match + as they are scanned.</p><p> + The example shown above is based on files that the Macintosh + SMB client (DAVE) available from <a href="http://www.thursby.com" target="_top"> + Thursby</a> creates for internal use, and also still hides + all files beginning with a dot. + </p><p> + An example of us of this parameter is: +</p><pre class="programlisting"> +hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/ +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide files</code></em> = <code class="literal"> +# no file are hidden</code> +</em></span> +</p></dd><dt><span class="term"><a name="HIDESPECIALFILES"></a>hide special files (S)</span></dt><dd><p> + This parameter prevents clients from seeing special files such as sockets, devices and + fifo's in directory listings. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide special files</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="HIDEUNREADABLE"></a>hide unreadable (S)</span></dt><dd><p>This parameter prevents clients from seeing the + existance of files that cannot be read. Defaults to off.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide unreadable</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="HIDEUNWRITEABLEFILES"></a>hide unwriteable files (S)</span></dt><dd><p> + This parameter prevents clients from seeing the existance of files that cannot be written to. + Defaults to off. Note that unwriteable directories are shown as usual. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide unwriteable files</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="HOMEDIRMAP"></a>homedir map (G)</span></dt><dd><p> + If <a class="indexterm" name="id317755"></a>nis homedir is <code class="constant">yes</code>, and <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> is also acting as a Win95/98 <em class="parameter"><code>logon server</code></em> + then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted. + At present, only the Sun auto.home map format is understood. The form of the map is: +</p><pre class="programlisting"> +<code class="literal">username server:/some/file/system</code> +</pre><p> + and the program will extract the servername from before the first ':'. There should probably be a better parsing system + that copes with different map formats and also Amd (another automounter) maps. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + A working NIS client is required on the system for this option to work. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>homedir map</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>homedir map</code></em> = <code class="literal">amd.homedir</code> +</em></span> +</p></dd><dt><span class="term"><a name="HOSTMSDFS"></a>host msdfs (G)</span></dt><dd><p> + If set to <code class="constant">yes</code>, Samba will act as a Dfs server, and allow Dfs-aware clients to browse + Dfs trees hosted on the server. + </p><p> + See also the <a class="indexterm" name="id317862"></a>msdfs root share level parameter. For more information on + setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>host msdfs</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="HOSTNAMELOOKUPS"></a>hostname lookups (G)</span></dt><dd><p>Specifies whether samba should use (expensive) + hostname lookups or use the ip addresses instead. An example place + where hostname lookups are currently used is when checking + the <code class="literal">hosts deny</code> and <code class="literal">hosts allow</code>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hostname lookups</code></em> = <code class="literal">no</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hostname lookups</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="ALLOWHOSTS"></a>allow hosts</span></dt><dd><p>This parameter is a synonym for hosts allow.</p></dd><dt><span class="term"><a name="HOSTSALLOW"></a>hosts allow (S)</span></dt><dd><p>A synonym for this parameter is <a class="indexterm" name="id317998"></a>allow hosts.</p><p>This parameter is a comma, space, or tab delimited + set of hosts which are permitted to access a service.</p><p>If specified in the [global] section then it will + apply to all services, regardless of whether the individual + service has a different setting.</p><p>You can specify the hosts by name or IP number. For + example, you could restrict access to only the hosts on a + Class C subnet with something like <code class="literal">allow hosts = 150.203.5.</code>. + The full syntax of the list is described in the man + page <code class="filename">hosts_access(5)</code>. Note that this man + page may not be present on your system, so a brief description will + be given here also.</p><p>Note that the localhost address 127.0.0.1 will always + be allowed access unless specifically denied by a <a class="indexterm" name="id318036"></a>hosts deny option.</p><p>You can also specify hosts by network/netmask pairs and + by netgroup names if your system supports netgroups. The + <span class="emphasis"><em>EXCEPT</em></span> keyword can also be used to limit a + wildcard list. The following examples may provide some help:</p><p>Example 1: allow all IPs in 150.203.*.*; except one</p><p><code class="literal">hosts allow = 150.203. EXCEPT 150.203.6.66</code></p><p>Example 2: allow hosts that match the given network/netmask</p><p><code class="literal">hosts allow = 150.203.15.0/255.255.255.0</code></p><p>Example 3: allow a couple of hosts</p><p><code class="literal">hosts allow = lapland, arvidsjaur</code></p><p>Example 4: allow only hosts in NIS netgroup "foonet", but + deny access from one particular host</p><p><code class="literal">hosts allow = @foonet</code></p><p><code class="literal">hosts deny = pirate</code></p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note that access still requires suitable user-level passwords.</p></div><p>See <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> for a way of testing your host access + to see if it does what you expect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hosts allow</code></em> = <code class="literal"> +# none (i.e., all hosts permitted access)</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hosts allow</code></em> = <code class="literal">150.203.5. myhost.mynet.edu.au</code> +</em></span> +</p></dd><dt><span class="term"><a name="DENYHOSTS"></a>deny hosts</span></dt><dd><p>This parameter is a synonym for hosts deny.</p></dd><dt><span class="term"><a name="HOSTSDENY"></a>hosts deny (S)</span></dt><dd><p>The opposite of <em class="parameter"><code>hosts allow</code></em> + - hosts listed here are <span class="emphasis"><em>NOT</em></span> permitted access to + services unless the specific services have their own lists to override + this one. Where the lists conflict, the <em class="parameter"><code>allow</code></em> + list takes precedence.</p><p> + In the event that it is necessary to deny all by default, use the keyword + ALL (or the netmask <code class="literal">0.0.0.0/0</code>) and then explicitly specify + to the <a class="indexterm" name="id318224"></a>hosts allow = hosts allow parameter those hosts + that should be permitted access. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hosts deny</code></em> = <code class="literal"> +# none (i.e., no hosts specifically excluded)</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hosts deny</code></em> = <code class="literal">150.203.4. badhost.mynet.edu.au</code> +</em></span> +</p></dd><dt><span class="term"><a name="IDMAPALLOCBACKEND"></a>idmap alloc backend (G)</span></dt><dd><p> + The idmap alloc backend provides a plugin interface for Winbind to use + when allocating Unix uids/gids for Windows SIDs. This option is + to be used in conjunction with the <a class="indexterm" name="id318289"></a>idmap domains + parameter and refers to the name of the idmap module which will provide + the id allocation functionality. Please refer to the man page + for each idmap plugin to determine whether or not the module implements + the allocation feature. The most common plugins are the tdb (<a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>) + and ldap (<a href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>) libraries. + </p><p>Also refer to the <a class="indexterm" name="id318318"></a>idmap alloc config option. + </p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap alloc backend</code></em> = <code class="literal">tdb</code> +</em></span> +</p></dd><dt><span class="term"><a name="IDMAPALLOCCONFIG"></a>idmap alloc config (G)</span></dt><dd><p> + The idmap alloc config prefix provides a means of managing settings + for the backend defined by the <a class="indexterm" name="id318368"></a>idmap alloc backend + parameter. Refer to the man page for each idmap plugin regarding + specific configuration details. + </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="IDMAPBACKEND"></a>idmap backend (G)</span></dt><dd><p> + The idmap backend provides a plugin interface for Winbind to use + varying backends to store SID/uid/gid mapping tables. This + option is mutually exclusive with the newer and more flexible + <a class="indexterm" name="id318404"></a>idmap domains parameter. The main difference + between the "idmap backend" and the "idmap domains" + is that the former only allows on backend for all domains while the + latter supports configuring backends on a per domain basis. + </p><p>Examples of SID/uid/gid backends include tdb (<a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>), + ldap (<a href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>), rid (<a href="idmap_rid.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_rid</span>(8)</span></a>), + and ad (<a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>). + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap backend</code></em> = <code class="literal">tdb</code> +</em></span> +</p></dd><dt><span class="term"><a name="IDMAPCACHETIME"></a>idmap cache time (G)</span></dt><dd><p>This parameter specifies the number of seconds that Winbind's + idmap interface will cache positive SID/uid/gid query results. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap cache time</code></em> = <code class="literal">900</code> +</em></span> +</p></dd><dt><span class="term"><a name="IDMAPCONFIG"></a>idmap config (G)</span></dt><dd><p> + The idmap config prefix provides a means of managing each domain + defined by the <a class="indexterm" name="id318526"></a>idmap domains option using Samba's + parameteric option support. The idmap config prefix should be + followed by the name of the domain, a colon, and a setting specific to + the chosen backend. There are three options available for all domains: + </p><div class="variablelist"><dl><dt><span class="term">backend = backend_name</span></dt><dd><p> + Specifies the name of the idmap plugin to use as the + SID/uid/gid backend for this domain. + </p></dd><dt><span class="term">default = [yes|no]</span></dt><dd><p> + The default domain/backend will be used for searching for + users and groups not belonging to one of the explicitly + listed domains (matched by comparing the account SID and the + domain SID). + </p></dd><dt><span class="term">readonly = [yes|no]</span></dt><dd><p> + Mark the domain as readonly which means that no attempts to + allocate a uid or gid (by the <a class="indexterm" name="id318573"></a>idmap alloc backend) for any user or group in that domain + will be attempted. + </p></dd></dl></div><p> + The following example illustrates how to configure the <a href="idmap_ad.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ad</span>(8)</span></a> + for the CORP domain and the <a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a> backend for all other domains. The + TRUSTEDDOMAINS string is simply a key used to reference the "idmap + config" settings and does not represent the actual name of a domain. + </p><pre class="programlisting"> + idmap domains = CORP TRUSTEDDOMAINS + + idmap config CORP:backend = ad + idmap config CORP:readonly = yes + + idmap config TRUSTEDDOMAINS:backend = tdb + idmap config TRUSTEDDOMAINS:default = yes + idmap config TRUSTEDDOMAINS:range = 1000 - 9999 + </pre><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="IDMAPDOMAINS"></a>idmap domains (G)</span></dt><dd><p> + The idmap domains option defines a list of Windows domains which will each + have a separately configured backend for managing Winbind's SID/uid/gid + tables. This parameter is mutually exclusive with the older <a class="indexterm" name="id318641"></a>idmap backend option. + </p><p> + Values consist of the short domain name for Winbind's primary or collection + of trusted domains. You may also use an arbitrary string to represent a catchall + domain backend for any domain not explicitly listed. + </p><p> + Refer to the <a class="indexterm" name="id318656"></a>idmap config for details about + managing the SID/uid/gid backend for each domain. + </p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap domains</code></em> = <code class="literal">default AD CORP</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDGID"></a>winbind gid</span></dt><dd><p>This parameter is a synonym for idmap gid.</p></dd><dt><span class="term"><a name="IDMAPGID"></a>idmap gid (G)</span></dt><dd><p>The idmap gid parameter specifies the range of group ids + that are allocated for the purpose of mapping UNX groups to NT group + SIDs. This range of group ids should have no + existing local or NIS groups within it as strange conflicts can + occur otherwise.</p><p>See also the <a class="indexterm" name="id318734"></a>idmap backend, <a class="indexterm" name="id318741"></a>idmap domains, and <a class="indexterm" name="id318748"></a>idmap config options. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap gid</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap gid</code></em> = <code class="literal">10000-20000</code> +</em></span> +</p></dd><dt><span class="term"><a name="IDMAPNEGATIVECACHETIME"></a>idmap negative cache time (G)</span></dt><dd><p>This parameter specifies the number of seconds that Winbind's + idmap interface will cache negative SID/uid/gid query results. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap negative cache time</code></em> = <code class="literal">120</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDUID"></a>winbind uid</span></dt><dd><p>This parameter is a synonym for idmap uid.</p></dd><dt><span class="term"><a name="IDMAPUID"></a>idmap uid (G)</span></dt><dd><p> + The idmap uid parameter specifies the range of user ids that are + allocated for use in mapping UNIX users to NT user SIDs. This + range of ids should have no existing local + or NIS users within it as strange conflicts can occur otherwise.</p><p>See also the <a class="indexterm" name="id318876"></a>idmap backend, <a class="indexterm" name="id318883"></a>idmap domains, and <a class="indexterm" name="id318890"></a>idmap config options. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap uid</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap uid</code></em> = <code class="literal">10000-20000</code> +</em></span> +</p></dd><dt><span class="term"><a name="INCLUDE"></a>include (G)</span></dt><dd><p> + This allows you to include one config file inside another. The file is included literally, as though typed + in place. + </p><p> + It takes the standard substitutions, except <em class="parameter"><code>%u</code></em>, + <em class="parameter"><code>%P</code></em> and <em class="parameter"><code>%S</code></em>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>include</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>include</code></em> = <code class="literal">/usr/local/samba/lib/admin_smb.conf</code> +</em></span> +</p></dd><dt><span class="term"><a name="INHERITACLS"></a>inherit acls (S)</span></dt><dd><p>This parameter can be used to ensure that if default acls + exist on parent directories, they are always honored when creating a + new file or subdirectory in these parent directories. The default + behavior is to use the unix mode specified when creating the directory. + Enabling this option sets the unix mode to 0777, thus guaranteeing that + default directory acls are propagated. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit acls</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="INHERITOWNER"></a>inherit owner (S)</span></dt><dd><p>The ownership of new files and directories + is normally governed by effective uid of the connected user. + This option allows the Samba administrator to specify that + the ownership for new files and directories should be controlled + by the ownership of the parent directory.</p><p>Common scenarios where this behavior is useful is in + implementing drop-boxes where users can create and edit files but not + delete them and to ensure that newly create files in a user's + roaming profile directory are actually owner by the user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit owner</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="INHERITPERMISSIONS"></a>inherit permissions (S)</span></dt><dd><p> + The permissions on new files and directories are normally governed by <a class="indexterm" name="id319114"></a>create mask, + <a class="indexterm" name="id319121"></a>directory mask, <a class="indexterm" name="id319128"></a>force create mode and <a class="indexterm" name="id319135"></a>force directory mode but the boolean inherit permissions parameter overrides this. + </p><p>New directories inherit the mode of the parent directory, + including bits such as setgid.</p><p> + New files inherit their read/write bits from the parent directory. Their execute bits continue to be + determined by <a class="indexterm" name="id319151"></a>map archive, <a class="indexterm" name="id319158"></a>map hidden and <a class="indexterm" name="id319166"></a>map system as usual. + </p><p>Note that the setuid bit is <span class="emphasis"><em>never</em></span> set via + inheritance (the code explicitly prohibits this).</p><p>This can be particularly useful on large systems with + many users, perhaps several thousand, to allow a single [homes] + share to be used flexibly by each user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit permissions</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="INTERFACES"></a>interfaces (G)</span></dt><dd><p>This option allows you to override the default + network interfaces list that Samba will use for browsing, name + registration and other NBT traffic. By default Samba will query + the kernel for the list of all active interfaces and use any + interfaces except 127.0.0.1 that are broadcast capable.</p><p>The option takes a list of interface strings. Each string + can be in any of the following forms:</p><div class="itemizedlist"><ul type="disc"><li><p>a network interface name (such as eth0). + This may include shell-like wildcards so eth* will match + any interface starting with the substring "eth"</p></li><li><p>an IP address. In this case the netmask is + determined from the list of interfaces obtained from the + kernel</p></li><li><p>an IP/mask pair. </p></li><li><p>a broadcast/mask pair.</p></li></ul></div><p>The "mask" parameters can either be a bit length (such + as 24 for a C class network) or a full netmask in dotted + decimal form.</p><p>The "IP" parameters above can either be a full dotted + decimal IP address or a hostname which will be looked up via + the OS's normal hostname resolution mechanisms.</p><p> + By default Samba enables all active interfaces that are broadcast capable + except the loopback adaptor (IP address 127.0.0.1). + </p><p> + The example below configures three network interfaces corresponding + to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. + The netmasks of the latter two interfaces would be set to 255.255.255.0. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>interfaces</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>interfaces</code></em> = <code class="literal">eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</code> +</em></span> +</p></dd><dt><span class="term"><a name="INVALIDUSERS"></a>invalid users (S)</span></dt><dd><p>This is a list of users that should not be allowed + to login to this service. This is really a <span class="emphasis"><em>paranoid</em></span> + check to absolutely ensure an improper setting does not breach + your security.</p><p>A name starting with a '@' is interpreted as an NIS + netgroup first (if your system supports NIS), and then as a UNIX + group if the name was not found in the NIS netgroup database.</p><p>A name starting with '+' is interpreted only + by looking in the UNIX group database via the NSS getgrnam() interface. A name starting with + '&' is interpreted only by looking in the NIS netgroup database + (this requires NIS to be working on your system). The characters + '+' and '&' may be used at the start of the name in either order + so the value <em class="parameter"><code>+&group</code></em> means check the + UNIX group database, followed by the NIS netgroup database, and + the value <em class="parameter"><code>&+group</code></em> means check the NIS + netgroup database, followed by the UNIX group database (the + same as the '@' prefix).</p><p>The current servicename is substituted for <em class="parameter"><code>%S</code></em>. + This is useful in the [homes] section.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>invalid users</code></em> = <code class="literal"> +# no invalid users</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>invalid users</code></em> = <code class="literal">root fred admin @wheel</code> +</em></span> +</p></dd><dt><span class="term"><a name="IPRINTSERVER"></a>iprint server (G)</span></dt><dd><p> + This parameter is only applicable if <a class="indexterm" name="id319425"></a>printing is set to <code class="constant">iprint</code>. + </p><p> + If set, this option overrides the ServerName option in the CUPS <code class="filename">client.conf</code>. This is + necessary if you have virtual samba servers that connect to different CUPS daemons. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>iprint server</code></em> = <code class="literal">""</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>iprint server</code></em> = <code class="literal">MYCUPSSERVER</code> +</em></span> +</p></dd><dt><span class="term"><a name="KEEPALIVE"></a>keepalive (G)</span></dt><dd><p>The value of the parameter (an integer) represents + the number of seconds between <em class="parameter"><code>keepalive</code></em> + packets. If this parameter is zero, no keepalive packets will be + sent. Keepalive packets, if sent, allow the server to tell whether + a client is still present and responding.</p><p>Keepalives should, in general, not be needed if the socket + has the SO_KEEPALIVE attribute set on it by default. (see <a class="indexterm" name="id319514"></a>socket options). +Basically you should only use this option if you strike difficulties.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>keepalive</code></em> = <code class="literal">300</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>keepalive</code></em> = <code class="literal">600</code> +</em></span> +</p></dd><dt><span class="term"><a name="KERNELCHANGENOTIFY"></a>kernel change notify (S)</span></dt><dd><p>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. + </p><p>This parameter is only used when your kernel supports + change notification to user programs using the inotify interface. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>kernel change notify</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="KERNELOPLOCKS"></a>kernel oplocks (G)</span></dt><dd><p>For UNIXes that support kernel based <a class="indexterm" name="id319620"></a>oplocks + (currently only IRIX and the Linux 2.4 kernel), this parameter + allows the use of them to be turned on or off.</p><p>Kernel oplocks support allows Samba <em class="parameter"><code>oplocks + </code></em> to be broken whenever a local UNIX process or NFS operation + accesses a file that <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has oplocked. This allows complete + data consistency between SMB/CIFS, NFS and local file access (and is + a <span class="emphasis"><em>very</em></span> cool feature :-).</p><p>This parameter defaults to <code class="constant">on</code>, but is translated + to a no-op on systems that no not have the necessary kernel support. + You should never need to touch this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>kernel oplocks</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="LANMANAUTH"></a>lanman auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to + authenticate users or permit password changes + using the LANMAN password hash. If disabled, only clients which support NT + password hashes (e.g. Windows NT/2000 clients, smbclient, but not + Windows 95/98 or the MS DOS network client) will be able to + connect to the Samba host.</p><p>The LANMAN encrypted response is easily broken, due to it's + case-insensitive nature, and the choice of algorithm. Servers + without Windows 95/98/ME or MS DOS clients are advised to disable + this option. </p><p>Unlike the <code class="literal">encrypt + passwords</code> option, this parameter cannot alter client + behaviour, and the LANMAN response will still be sent over the + network. See the <code class="literal">client lanman + auth</code> to disable this for Samba's clients (such as smbclient)</p><p>If this option, and <code class="literal">ntlm + auth</code> are both disabled, then only NTLMv2 logins will be + permited. Not all clients support NTLMv2, and most will require + special configuration to use it.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lanman auth</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="LARGEREADWRITE"></a>large readwrite (G)</span></dt><dd><p>This parameter determines whether or not + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> supports the new 64k + streaming read and write varient SMB requests introduced with + Windows 2000. Note that due to Windows 2000 client redirector bugs + this requires Samba to be running on a 64-bit capable operating + system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve + performance by 10% with Windows 2000 clients. Defaults to on. Not as + tested as some other Samba code paths.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>large readwrite</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPADMINDN"></a>ldap admin dn (G)</span></dt><dd><p> + The <a class="indexterm" name="id319828"></a>ldap admin dn defines the Distinguished Name (DN) name used by Samba to contact + the ldap server when retreiving user account information. The <a class="indexterm" name="id319836"></a>ldap admin dn is used + in conjunction with the admin dn password stored in the <code class="filename">private/secrets.tdb</code> + file. See the <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> + man page for more information on how to accomplish this. + </p><p> + The <a class="indexterm" name="id319862"></a>ldap admin dn requires a fully specified DN. The <a class="indexterm" name="id319869"></a>ldap suffix is not appended to the <a class="indexterm" name="id319876"></a>ldap admin dn. + </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="LDAPDELETEDN"></a>ldap delete dn (G)</span></dt><dd><p> This parameter specifies whether a delete + operation in the ldapsam deletes the complete entry or only the attributes + specific to Samba. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap delete dn</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPGROUPSUFFIX"></a>ldap group suffix (G)</span></dt><dd><p>This parameter specifies the suffix that is + used for groups when these are added to the LDAP directory. + If this parameter is unset, the value of <a class="indexterm" name="id319950"></a>ldap suffix will be used instead. The suffix string is pre-pended to the + <a class="indexterm" name="id319957"></a>ldap suffix string so use a partial DN.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap group suffix</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap group suffix</code></em> = <code class="literal">ou=Groups</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPIDMAPSUFFIX"></a>ldap idmap suffix (G)</span></dt><dd><p> + This parameters specifies the suffix that is used when storing idmap mappings. If this parameter + is unset, the value of <a class="indexterm" name="id320020"></a>ldap suffix will be used instead. The suffix + string is pre-pended to the <a class="indexterm" name="id320027"></a>ldap suffix string so use a partial DN. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap idmap suffix</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap idmap suffix</code></em> = <code class="literal">ou=Idmap</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPMACHINESUFFIX"></a>ldap machine suffix (G)</span></dt><dd><p> + It specifies where machines should be added to the ldap tree. If this parameter is unset, the value of + <a class="indexterm" name="id320089"></a>ldap suffix will be used instead. The suffix string is pre-pended to the + <a class="indexterm" name="id320097"></a>ldap suffix string so use a partial DN. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap machine suffix</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap machine suffix</code></em> = <code class="literal">ou=Computers</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPPASSWDSYNC"></a>ldap passwd sync (G)</span></dt><dd><p> + This option is used to define whether or not Samba should sync the LDAP password with the NT + and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password + change via SAMBA. + </p><p> + The <a class="indexterm" name="id320164"></a>ldap passwd sync can be set to one of three values: + </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>Yes</code></em> = Try + to update the LDAP, NT and LM passwords and update the pwdLastSet time.</p></li><li><p><em class="parameter"><code>No</code></em> = Update NT and + LM passwords and update the pwdLastSet time.</p></li><li><p><em class="parameter"><code>Only</code></em> = Only update + the LDAP password and let the LDAP server do the rest.</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap passwd sync</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPREPLICATIONSLEEP"></a>ldap replication sleep (G)</span></dt><dd><p> + When Samba is asked to write to a read-only LDAP replica, we are redirected to talk to the read-write master server. + This server then replicates our changes back to the 'local' server, however the replication might take some seconds, + especially over slow links. Certain client activities, particularly domain joins, can become confused by the 'success' + that does not immediately change the LDAP back-end's data. + </p><p> + This option simply causes Samba to wait a short time, to allow the LDAP server to catch up. If you have a particularly + high-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly. + Be aware that no checking is performed that the data has actually replicated. + </p><p> + The value is specified in milliseconds, the maximum value is 5000 (5 seconds). + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap replication sleep</code></em> = <code class="literal">1000</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPSAM:EDITPOSIX"></a>ldapsam:editposix (G)</span></dt><dd><p> + Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller + eliminating the need to set up custom scripts to add and manage the posix users and groups. This option + will instead directly manipulate the ldap tree to create, remove and modify user and group entries. + This option also requires a running winbindd as it is used to allocate new uids/gids on user/group + creation. The allocation range must be therefore configured. + </p><p> + To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly + configured. On virgin servers the default users and groups (Administrator, Guest, Domain Users, + Domain Admins, Domain Guests) can be precreated with the command <code class="literal">net sam + provision</code>. To run this command the ldap server must be running, Winindd must be running and + the smb.conf ldap options must be properly configured. + + The typical ldap setup used with the <a class="indexterm" name="id320317"></a>ldapsam:trusted = yes option + is usually sufficient to use <a class="indexterm" name="id320325"></a>ldapsam:editposix = yes as well. + </p><p> + An example configuration can be the following: + + </p><pre class="programlisting"> + encrypt passwords = true + passdb backend = ldapsam + + ldapsam:trusted=yes + ldapsam:editposix=yes + + ldap admin dn = cn=admin,dc=samba,dc=org + ldap delete dn = yes + ldap group suffix = ou=groups + ldap idmap suffix = ou=idmap + ldap machine suffix = ou=computers + ldap user suffix = ou=users + ldap suffix = dc=samba,dc=org + + idmap backend = ldap:"ldap://localhost" + + idmap uid = 5000-50000 + idmap gid = 5000-50000 + </pre><p> + + This configuration assume the ldap server have been loaded with a base tree like described + in the following ldif: + + </p><pre class="programlisting"> + dn: dc=samba,dc=org + objectClass: top + objectClass: dcObject + objectClass: organization + o: samba.org + dc: samba + + dn: cn=admin,dc=samba,dc=org + objectClass: simpleSecurityObject + objectClass: organizationalRole + cn: admin + description: LDAP administrator + userPassword: secret + + dn: ou=users,dc=samba,dc=org + objectClass: top + objectClass: organizationalUnit + ou: users + + dn: ou=groups,dc=samba,dc=org + objectClass: top + objectClass: organizationalUnit + ou: groups + + dn: ou=idmap,dc=samba,dc=org + objectClass: top + objectClass: organizationalUnit + ou: idmap + + dn: ou=computers,dc=samba,dc=org + objectClass: top + objectClass: organizationalUnit + ou: computers + </pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldapsam:editposix</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPSAM:TRUSTED"></a>ldapsam:trusted (G)</span></dt><dd><p> + By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix-style NSS subsystem to + access user and group information. Due to the way Unix stores user information in /etc/passwd and /etc/group + this inevitably leads to inefficiencies. One important question a user needs to know is the list of groups he + is member of. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS + counterparts in LDAP. UNIX has optimized functions to enumerate group membership. Sadly, other functions that + are used to deal with user and group attributes lack such optimization. + </p><p> + To make Samba scale well in large environments, the <a class="indexterm" name="id320404"></a>ldapsam:trusted = yes + option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the + standard posixAccount/posixGroup attributes. It further assumes that the Samba auxiliary object classes are + stored together with the POSIX data in the same LDAP object. If these assumptions are met, + <a class="indexterm" name="id320414"></a>ldapsam:trusted = yes can be activated and Samba can bypass the + NSS system to query user group memberships. Optimized LDAP queries can greatly speed up domain logon and + administration tasks. Depending on the size of the LDAP database a factor of 100 or more for common queries + is easily achieved. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldapsam:trusted</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPSSL"></a>ldap ssl (G)</span></dt><dd><p>This option is used to define whether or not Samba should + use SSL when connecting to the ldap server + This is <span class="emphasis"><em>NOT</em></span> related to + Samba's previous SSL support which was enabled by specifying the + <code class="literal">--with-ssl</code> option to the <code class="filename">configure</code> + script.</p><p>The <a class="indexterm" name="id320482"></a>ldap ssl can be set to one of three values:</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>Off</code></em> = Never + use SSL when querying the directory.</p></li><li><p><em class="parameter"><code>Start_tls</code></em> = Use + the LDAPv3 StartTLS extended operation (RFC2830) for + communicating with the directory server.</p></li><li><p><em class="parameter"><code>On</code></em> = Use SSL + on the ldaps port when contacting the <em class="parameter"><code>ldap server</code></em>. Only available when the + backwards-compatiblity <code class="literal">--with-ldapsam</code> option is specified + to configure. See <a class="indexterm" name="id320538"></a>passdb backend</p>. + </li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap ssl</code></em> = <code class="literal">start_tls</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPSUFFIX"></a>ldap suffix (G)</span></dt><dd><p>Specifies the base for all ldap suffixes and for storing the sambaDomain object.</p><p> + The ldap suffix will be appended to the values specified for the <a class="indexterm" name="id320590"></a>ldap user suffix, + <a class="indexterm" name="id320597"></a>ldap group suffix, <a class="indexterm" name="id320604"></a>ldap machine suffix, and the + <a class="indexterm" name="id320612"></a>ldap idmap suffix. Each of these should be given only a DN relative to the + <a class="indexterm" name="id320619"></a>ldap suffix. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap suffix</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap suffix</code></em> = <code class="literal">dc=samba,dc=org</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPTIMEOUT"></a>ldap timeout (G)</span></dt><dd><p> + When Samba connects to an ldap server that servermay be down or unreachable. To prevent Samba from hanging whilst + waiting for the connection this parameter specifies in seconds how long Samba should wait before failing the + connect. The default is to only wait fifteen seconds for the ldap server to respond to the connect request. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap timeout</code></em> = <code class="literal">15</code> +</em></span> +</p></dd><dt><span class="term"><a name="LDAPUSERSUFFIX"></a>ldap user suffix (G)</span></dt><dd><p> + This parameter specifies where users are added to the tree. If this parameter is unset, + the value of <a class="indexterm" name="id320721"></a>ldap suffix will be used instead. The suffix + string is pre-pended to the <a class="indexterm" name="id320729"></a>ldap suffix string so use a partial DN. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap user suffix</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap user suffix</code></em> = <code class="literal">ou=people</code> +</em></span> +</p></dd><dt><span class="term"><a name="LEVEL2OPLOCKS"></a>level2 oplocks (S)</span></dt><dd><p>This parameter controls whether Samba supports + level2 (read-only) oplocks on a share.</p><p>Level2, or read-only oplocks allow Windows NT clients + that have an oplock on a file to downgrade from a read-write oplock + to a read-only oplock once a second client opens the file (instead + of releasing all oplocks on a second open, as in traditional, + exclusive oplocks). This allows all openers of the file that + support level2 oplocks to cache the file for read-ahead only (ie. + they may not cache writes or lock requests) and increases performance + for many accesses of files that are not commonly written (such as + application .EXE files).</p><p>Once one of the clients which have a read-only oplock + writes to the file all clients are notified (no reply is needed + or waited for) and told to break their oplocks to "none" and + delete any read-ahead caches.</p><p>It is recommended that this parameter be turned on to + speed access to shared executables.</p><p>For more discussions on level2 oplocks see the CIFS spec.</p><p> + Currently, if <a class="indexterm" name="id320816"></a>kernel oplocks are supported then + level2 oplocks are not granted (even if this parameter is set to + <code class="constant">yes</code>). Note also, the <a class="indexterm" name="id320827"></a>oplocks + parameter must be set to <code class="constant">yes</code> on this share in order for + this parameter to have any effect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>level2 oplocks</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="LMANNOUNCE"></a>lm announce (G)</span></dt><dd><p>This parameter determines if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will produce Lanman announce + broadcasts that are needed by OS/2 clients in order for them to see + the Samba server in their browse list. This parameter can have three + values, <code class="constant">yes</code>, <code class="constant">no</code>, or + <code class="constant">auto</code>. The default is <code class="constant">auto</code>. + If set to <code class="constant">no</code> Samba will never produce these + broadcasts. If set to <code class="constant">yes</code> Samba will produce + Lanman announce broadcasts at a frequency set by the parameter + <a class="indexterm" name="id320908"></a>lm interval. If set to <code class="constant">auto</code> + Samba will not send Lanman announce broadcasts by default but will + listen for them. If it hears such a broadcast on the wire it will + then start sending them at a frequency set by the parameter + <a class="indexterm" name="id320920"></a>lm interval.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lm announce</code></em> = <code class="literal">auto</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lm announce</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="LMINTERVAL"></a>lm interval (G)</span></dt><dd><p>If Samba is set to produce Lanman announce + broadcasts needed by OS/2 clients (see the + <a class="indexterm" name="id320983"></a>lm announce parameter) then this + parameter defines the frequency in seconds with which they will be + made. If this is set to zero then no Lanman announcements will be + made despite the setting of the <a class="indexterm" name="id320992"></a>lm announce + parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lm interval</code></em> = <code class="literal">60</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lm interval</code></em> = <code class="literal">120</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOADPRINTERS"></a>load printers (G)</span></dt><dd><p>A boolean variable that controls whether all + printers in the printcap will be loaded for browsing by default. + See the <a class="indexterm" name="id321055"></a>printers section for + more details.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>load printers</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOCALMASTER"></a>local master (G)</span></dt><dd><p>This option allows <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to try and become a local master browser + on a subnet. If set to <code class="constant">no</code> then <code class="literal"> + nmbd</code> will not attempt to become a local master browser + on a subnet and will also lose in all browsing elections. By + default this value is set to <code class="constant">yes</code>. Setting this value to + <code class="constant">yes</code> doesn't mean that Samba will <span class="emphasis"><em>become</em></span> the + local master browser on a subnet, just that <code class="literal">nmbd</code> + will <span class="emphasis"><em>participate</em></span> in elections for local master browser.</p><p>Setting this value to <code class="constant">no</code> will cause <code class="literal">nmbd</code> <span class="emphasis"><em>never</em></span> to become a local +master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>local master</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOCKDIR"></a>lock dir</span></dt><dd><p>This parameter is a synonym for lock directory.</p></dd><dt><span class="term"><a name="LOCKDIRECTORY"></a>lock directory (G)</span></dt><dd><p>This option specifies the directory where lock + files will be placed. The lock files are used to implement the + <a class="indexterm" name="id321217"></a>max connections option. + </p><p> + Note: This option can not be set inside registry + configurations. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock directory</code></em> = <code class="literal">${prefix}/var/locks</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lock directory</code></em> = <code class="literal">/var/run/samba/locks</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOCKING"></a>locking (S)</span></dt><dd><p>This controls whether or not locking will be + performed by the server in response to lock requests from the + client.</p><p>If <code class="literal">locking = no</code>, all lock and unlock + requests will appear to succeed and all lock queries will report + that the file in question is available for locking.</p><p>If <code class="literal">locking = yes</code>, real locking will be performed + by the server.</p><p>This option <span class="emphasis"><em>may</em></span> be useful for read-only + filesystems which <span class="emphasis"><em>may</em></span> not need locking (such as + CDROM drives), although setting this parameter of <code class="constant">no</code> + is not really recommended even in this case.</p><p>Be careful about disabling locking either globally or in a + specific service, as lack of locking may result in data corruption. + You should never need to set this parameter.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="LOCKSPINCOUNT"></a>lock spin count (G)</span></dt><dd><p>This parameter has been made inoperative in Samba 3.0.24. + The functionality it contolled is now controlled by the parameter + <a class="indexterm" name="id321351"></a>lock spin time. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock spin count</code></em> = <code class="literal">0</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOCKSPINTIME"></a>lock spin time (G)</span></dt><dd><p>The time in microseconds that smbd should + keep waiting to see if a failed lock request can + be granted. This parameter has changed in default + value from Samba 3.0.23 from 10 to 200. The associated + <a class="indexterm" name="id321399"></a>lock spin count parameter is + no longer used in Samba 3.0.24. You should not need + to change the value of this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock spin time</code></em> = <code class="literal">200</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOGFILE"></a>log file (G)</span></dt><dd><p> + This option allows you to override the name of the Samba log file (also known as the debug file). + </p><p> + This option takes the standard substitutions, allowing you to have separate log files for each user or machine. + </p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>log file</code></em> = <code class="literal">/usr/local/samba/var/log.%m</code> +</em></span> +</p></dd><dt><span class="term"><a name="DEBUGLEVEL"></a>debuglevel</span></dt><dd><p>This parameter is a synonym for log level.</p></dd><dt><span class="term"><a name="LOGLEVEL"></a>log level (G)</span></dt><dd><p> + The value of the parameter (a astring) allows the debug level (logging level) to be specified in the + <code class="filename">smb.conf</code> file. This parameter has been extended since the 2.2.x + series, now it allow to specify the debug level for multiple debug classes. This is to give greater + flexibility in the configuration of the system. + </p><p> + The default will be the log level specified on the command line or level zero if none was specified. + </p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>log level</code></em> = <code class="literal">3 passdb:5 auth:10 winbind:2</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOGONDRIVE"></a>logon drive (G)</span></dt><dd><p> + This parameter specifies the local path to which the home directory will be + connected (see <a class="indexterm" name="id321570"></a>logon home) and is only used by NT + Workstations. + </p><p> + Note that this option is only useful if Samba is set up as a logon server. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon drive</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon drive</code></em> = <code class="literal">h:</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOGONHOME"></a>logon home (G)</span></dt><dd><p> + This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC. + It allows you to do + </p><p> + <code class="prompt">C:\></code><strong class="userinput"><code>NET USE H: /HOME</code></strong> + </p><p> + from a command prompt, for example. + </p><p> + This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. + </p><p> + This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a + subdirectory of the user's home directory. This is done in the following way: + </p><p> + <code class="literal">logon home = \\%N\%U\profile</code> + </p><p> + This tells Samba to return the above string, with substitutions made when a client requests the info, generally + in a NetUserGetInfo request. Win9X clients truncate the info to \\server\share when a user does + <code class="literal">net use /home</code> but use the whole string when dealing with profiles. + </p><p> + Note that in prior versions of Samba, the <a class="indexterm" name="id321687"></a>logon path was returned rather than + <em class="parameter"><code>logon home</code></em>. This broke <code class="literal">net use /home</code> + but allowed profiles outside the home directory. The current implementation is correct, and can be used for + profiles if you use the above trick. + </p><p> + Disable this feature by setting <a class="indexterm" name="id321711"></a>logon home = "" - using the empty string. + </p><p> + This option is only useful if Samba is set up as a logon server. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon home</code></em> = <code class="literal">\\%N\%U</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon home</code></em> = <code class="literal">\\remote_smb_server\%U</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOGONPATH"></a>logon path (G)</span></dt><dd><p> + This parameter specifies the directory where roaming profiles (Desktop, NTuser.dat, etc) are + stored. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming + profiles. To find out how to handle roaming profiles for Win 9X system, see the + <a class="indexterm" name="id321780"></a>logon home parameter. + </p><p> + This option takes the standard substitutions, allowing you to have separate logon scripts for each user or + machine. It also specifies the directory from which the "Application Data", <code class="filename">desktop</code>, <code class="filename">start menu</code>, <code class="filename">network neighborhood</code>, <code class="filename">programs</code> and other + folders, and their contents, are loaded and displayed on your Windows NT client. + </p><p> + The share and the path must be readable by the user for the preferences and directories to be loaded onto the + Windows NT client. The share must be writeable when the user logs in for the first time, in order that the + Windows NT client can create the NTuser.dat and other directories. + Thereafter, the directories and any of the contents can, if required, be made read-only. It is not advisable + that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a + <span class="emphasis"><em>MAN</em></span>datory profile). + </p><p> + Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged + in. Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting + this parameter to \\%N\homes\profile_path will cause problems). + </p><p> + This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. + </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p> + Do not quote the value. Setting this as “<span class="quote">\\%N\profile\%U</span>” + will break profile handling. Where the tdbsam or ldapsam passdb backend + is used, at the time the user account is created the value configured + for this parameter is written to the passdb backend and that value will + over-ride the parameter value present in the smb.conf file. Any error + present in the passdb backend account record must be editted using the + appropriate tool (pdbedit on the command-line, or any other locally + provided system tool). + </p></div><p>Note that this option is only useful if Samba is set up as a domain controller.</p><p> + Disable the use of roaming profiles by setting the value of this parameter to the empty string. For + example, <a class="indexterm" name="id321857"></a>logon path = "". Take note that even if the default setting + in the smb.conf file is the empty string, any value specified in the user account settings in the passdb + backend will over-ride the effect of setting this parameter to null. Disabling of all roaming profile use + requires that the user account settings must also be blank. + </p><p> + An example of use is: +</p><pre class="programlisting"> +logon path = \\PROFILESERVER\PROFILE\%U +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon path</code></em> = <code class="literal">\\%N\%U\profile</code> +</em></span> +</p></dd><dt><span class="term"><a name="LOGONSCRIPT"></a>logon script (G)</span></dt><dd><p> + This parameter specifies the batch file (<code class="filename">.bat</code>) or NT command file + (<code class="filename">.cmd</code>) to be downloaded and run on a machine when a user successfully logs in. The file + must contain the DOS style CR/LF line endings. Using a DOS-style editor to create the file is recommended. + </p><p> + The script must be a relative path to the <em class="parameter"><code>[netlogon]</code></em> service. If the [netlogon] + service specifies a <a class="indexterm" name="id321939"></a>path of <code class="filename">/usr/local/samba/netlogon</code>, and <a class="indexterm" name="id321952"></a>logon script = STARTUP.BAT, then the file that will be downloaded is: +</p><pre class="programlisting"> + /usr/local/samba/netlogon/STARTUP.BAT +</pre><p> + </p><p> + The contents of the batch file are entirely your choice. A suggested command would be to add <code class="literal">NET TIME \\SERVER /SET /YES</code>, to force every machine to synchronize clocks with the + same time server. Another use would be to add <code class="literal">NET USE U: \\SERVER\UTILS</code> + for commonly used utilities, or +</p><pre class="programlisting"> +<strong class="userinput"><code>NET USE Q: \\SERVER\ISO9001_QA</code></strong> +</pre><p> + for example. + </p><p> + Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users + write permission on the batch files in a secure environment, as this would allow the batch files to be + arbitrarily modified and security to be breached. + </p><p> + This option takes the standard substitutions, allowing you to have separate logon scripts for each user or + machine. + </p><p> + This option is only useful if Samba is set up as a logon server. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon script</code></em> = <code class="literal">scripts\%U.bat</code> +</em></span> +</p></dd><dt><span class="term"><a name="LPPAUSECOMMAND"></a>lppause command (S)</span></dt><dd><p>This parameter specifies the command to be + executed on the server host in order to stop printing or spooling + a specific print job.</p><p>This command should be a program or script which takes + a printer name and job number to pause the print job. One way + of implementing this is by using job priorities, where jobs + having a too low priority won't be sent to the printer.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name + is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with + the job number (an integer). On HPUX (see <em class="parameter"><code>printing=hpux + </code></em>), if the <em class="parameter"><code>-p%p</code></em> option is added + to the lpq command, the job will show up with the correct status, i.e. + if the job priority is lower than the set fence priority it will + have the PAUSED status, whereas if the priority is equal or higher it + will have the SPOOLED or PRINTING status.</p><p>Note that it is good practice to include the absolute path + in the lppause command as the PATH may not be available to the server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lppause command</code></em> = <code class="literal"> +# Currently no default value is given to + this string, unless the value of the <a class="indexterm" name="id322120"></a>printing + parameter is <code class="constant">SYSV</code>, in which case the default is : + <code class="literal">lp -i %p-%j -H hold</code> or if the value of the + <em class="parameter"><code>printing</code></em> parameter is + <code class="constant">SOFTQ</code>, then the default is: + <code class="literal">qstat -s -j%j -h</code>. </code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lppause command</code></em> = <code class="literal">/usr/bin/lpalt %p-%j -p0</code> +</em></span> +</p></dd><dt><span class="term"><a name="LPQCACHETIME"></a>lpq cache time (G)</span></dt><dd><p>This controls how long lpq info will be cached + for to prevent the <code class="literal">lpq</code> command being called too + often. A separate cache is kept for each variation of the <code class="literal"> + lpq</code> command used by the system, so if you use different + <code class="literal">lpq</code> commands for different users then they won't + share cache information.</p><p>The cache files are stored in <code class="filename">/tmp/lpq.xxxx</code> + where xxxx is a hash of the <code class="literal">lpq</code> command in use.</p><p>The default is 30 seconds, meaning that the cached results + of a previous identical <code class="literal">lpq</code> command will be used + if the cached data is less than 30 seconds old. A large value may + be advisable if your <code class="literal">lpq</code> command is very slow.</p><p>A value of 0 will disable caching completely.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lpq cache time</code></em> = <code class="literal">30</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpq cache time</code></em> = <code class="literal">10</code> +</em></span> +</p></dd><dt><span class="term"><a name="LPQCOMMAND"></a>lpq command (S)</span></dt><dd><p>This parameter specifies the command to be + executed on the server host in order to obtain <code class="literal">lpq + </code>-style printer status information.</p><p>This command should be a program or script which + takes a printer name as its only parameter and outputs printer + status information.</p><p>Currently nine styles of printer status information + are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. + This covers most UNIX systems. You control which type is expected + using the <em class="parameter"><code>printing =</code></em> option.</p><p>Some clients (notably Windows for Workgroups) may not + correctly send the connection number for the printer they are + requesting status information about. To get around this, the + server reports on the first printer service connected to by the + client. This only happens if the connection number sent is invalid.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name + is put in its place. Otherwise it is placed at the end of the + command.</p><p>Note that it is good practice to include the absolute path + in the <em class="parameter"><code>lpq command</code></em> as the <code class="envar">$PATH + </code> may not be available to the server. When compiled with + the CUPS libraries, no <em class="parameter"><code>lpq command</code></em> is + needed because smbd will make a library call to obtain the + print queue listing.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lpq command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpq command</code></em> = <code class="literal">/usr/bin/lpq -P%p</code> +</em></span> +</p></dd><dt><span class="term"><a name="LPRESUMECOMMAND"></a>lpresume command (S)</span></dt><dd><p>This parameter specifies the command to be + executed on the server host in order to restart or continue + printing or spooling a specific print job.</p><p>This command should be a program or script which takes + a printer name and job number to resume the print job. See + also the <a class="indexterm" name="id322423"></a>lppause command parameter.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name + is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with + the job number (an integer).</p><p>Note that it is good practice to include the absolute path + in the <em class="parameter"><code>lpresume command</code></em> as the PATH may not + be available to the server.</p><p>See also the <a class="indexterm" name="id322460"></a>printing parameter.</p><p>Default: Currently no default value is given + to this string, unless the value of the <em class="parameter"><code>printing</code></em> + parameter is <code class="constant">SYSV</code>, in which case the default is :</p><p><code class="literal">lp -i %p-%j -H resume</code></p><p>or if the value of the <em class="parameter"><code>printing</code></em> parameter + is <code class="constant">SOFTQ</code>, then the default is:</p><p><code class="literal">qstat -s -j%j -r</code></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lpresume command</code></em> = <code class="literal">lpresume command = /usr/bin/lpalt %p-%j -p2</code> +</em></span> +</p></dd><dt><span class="term"><a name="LPRMCOMMAND"></a>lprm command (S)</span></dt><dd><p>This parameter specifies the command to be + executed on the server host in order to delete a print job.</p><p>This command should be a program or script which takes + a printer name and job number, and deletes the print job.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name + is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with + the job number (an integer).</p><p>Note that it is good practice to include the absolute + path in the <em class="parameter"><code>lprm command</code></em> as the PATH may not be + available to the server.</p><p> + Examples of use are: +</p><pre class="programlisting"> +lprm command = /usr/bin/lprm -P%p %j + +or + +lprm command = /usr/bin/cancel %p-%j +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lprm command</code></em> = <code class="literal"> determined by printing parameter</code> +</em></span> +</p></dd><dt><span class="term"><a name="MACHINEPASSWORDTIMEOUT"></a>machine password timeout (G)</span></dt><dd><p> + If a Samba server is a member of a Windows NT Domain (see the <a class="indexterm" name="id322626"></a>security = domain parameter) then periodically a running smbd process will try and change + the MACHINE ACCOUNT PASSWORD stored in the TDB called <code class="filename">private/secrets.tdb + </code>. This parameter specifies how often this password will be changed, in seconds. The default is one + week (expressed in seconds), the same as a Windows NT Domain member server. + </p><p> + See also <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>, + and the <a class="indexterm" name="id322653"></a>security = domain parameter. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>machine password timeout</code></em> = <code class="literal">604800</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAGICOUTPUT"></a>magic output (S)</span></dt><dd><p> + This parameter specifies the name of a file which will contain output created by a magic script (see the + <a class="indexterm" name="id322699"></a>magic script parameter below). + </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>If two clients use the same <em class="parameter"><code>magic script + </code></em> in the same directory the output file content is undefined. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>magic output</code></em> = <code class="literal"><magic script name>.out</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>magic output</code></em> = <code class="literal">myfile.txt</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAGICSCRIPT"></a>magic script (S)</span></dt><dd><p>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.</p><p>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.</p><p>If the script generates output, output will be sent to + the file specified by the <a class="indexterm" name="id322784"></a>magic output + parameter (see above).</p><p>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 + <span class="emphasis"><em>as is</em></span> on the host, which for some hosts and + some shells will require filtering at the DOS end.</p><p>Magic scripts are <span class="emphasis"><em>EXPERIMENTAL</em></span> and + should <span class="emphasis"><em>NOT</em></span> be relied upon.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>magic script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>magic script</code></em> = <code class="literal">user.csh</code> +</em></span> +</p></dd><dt><span class="term"><a name="MANGLEDMAP"></a>mangled map (S)</span></dt><dd><p> + This is for those who want to directly map UNIX file names which cannot be represented on + Windows/DOS. The mangling of names is not always what is needed. In particular you may have + documents with file extensions that differ between DOS and UNIX. + For example, under UNIX it is common to use <code class="filename">.html</code> + for HTML files, whereas under Windows/DOS <code class="filename">.htm</code> + is more commonly used. + </p><p> + So to map <code class="filename">html</code> to <code class="filename">htm</code> + you would use: + </p><p> + <a class="indexterm" name="id322898"></a>mangled map = (*.html *.htm). + </p><p> + One very useful case is to remove the annoying <code class="filename">;1</code> off + the ends of filenames on some CDROMs (only visible under some UNIXes). To do this use a map of + (*;1 *;). + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangled map</code></em> = <code class="literal"> +# no mangled map</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangled map</code></em> = <code class="literal">(*;1 *;)</code> +</em></span> +</p></dd><dt><span class="term"><a name="MANGLEDNAMES"></a>mangled names (S)</span></dt><dd><p>This controls whether non-DOS names under UNIX + should be mapped to DOS-compatible names ("mangled") and made visible, + or whether non-DOS names should simply be ignored.</p><p>See the section on <a class="indexterm" name="id322975"></a>name mangling for + details on how to control the mangling process.</p><p>If mangling is used then the mangling algorithm is as follows:</p><div class="itemizedlist"><ul type="disc"><li><p>The first (up to) five alphanumeric characters + before the rightmost dot of the filename are preserved, forced + to upper case, and appear as the first (up to) five characters + of the mangled name.</p></li><li><p>A tilde "~" is appended to the first part of the mangled + name, followed by a two-character unique sequence, based on the + original root name (i.e., the original filename minus its final + extension). The final extension is included in the hash calculation + only if it contains any upper case characters or is longer than three + characters.</p><p>Note that the character to use may be specified using + the <a class="indexterm" name="id323009"></a>mangling char + option, if you don't like '~'.</p></li><li><p>Files whose UNIX name begins with a dot will be + presented as DOS hidden files. The mangled name will be created as + for other filenames, but with the leading dot removed and "___" as + its extension regardless of actual original extension (that's three + underscores).</p></li></ul></div><p>The two-digit hash value consists of upper case alphanumeric characters.</p><p>This algorithm can cause name collisions only if files + in a directory share the same first five alphanumeric characters. + The probability of such a clash is 1/1300.</p><p>The name mangling (if enabled) allows a file to be + copied between UNIX directories from Windows/DOS while retaining + the long UNIX filename. UNIX files can be renamed to a new extension + from Windows/DOS and will retain the same basename. Mangled names + do not change between sessions.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangled names</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="MANGLEPREFIX"></a>mangle prefix (G)</span></dt><dd><p> controls the number of prefix + characters from the original name used when generating + the mangled names. A larger value will give a weaker + hash and therefore more name collisions. The minimum + value is 1 and the maximum value is 6.</p><p> + mangle prefix is effective only when mangling method is hash2. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangle prefix</code></em> = <code class="literal">1</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangle prefix</code></em> = <code class="literal">4</code> +</em></span> +</p></dd><dt><span class="term"><a name="MANGLINGCHAR"></a>mangling char (S)</span></dt><dd><p>This controls what character is used as + the <span class="emphasis"><em>magic</em></span> character in <a class="indexterm" name="id323146"></a>name mangling. The + default is a '~' but this may interfere with some software. Use this option to set + it to whatever you prefer. This is effective only when mangling method is hash.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangling char</code></em> = <code class="literal">~</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangling char</code></em> = <code class="literal">^</code> +</em></span> +</p></dd><dt><span class="term"><a name="MANGLINGMETHOD"></a>mangling method (G)</span></dt><dd><p> controls the algorithm used for the generating + the mangled names. Can take two different values, "hash" and + "hash2". "hash" is the algorithm that was used + used in Samba for many years and was the default in Samba 2.2.x "hash2" is + now the default and is newer and considered a better algorithm (generates less collisions) in + the names. Many Win32 applications store the mangled names and so + changing to algorithms must not be done lightly as these applications + may break unless reinstalled.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangling method</code></em> = <code class="literal">hash2</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangling method</code></em> = <code class="literal">hash</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAPACLINHERIT"></a>map acl inherit (S)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map the 'inherit' and 'protected' + access control entry flags stored in Windows ACLs into an extended attribute + called user.SAMBA_PAI. This parameter only takes effect if Samba is being run + on a platform that supports extended attributes (Linux and IRIX so far) and + allows the Windows 2000 ACL editor to correctly use inheritance with the Samba + POSIX ACL mapping code. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map acl inherit</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAPARCHIVE"></a>map archive (S)</span></dt><dd><p> + This controls whether the DOS archive attribute + should be mapped to the UNIX owner execute bit. The DOS archive bit + is set when a file has been modified since its last backup. One + motivation for this option is to keep Samba/your PC from making + any file it touches from becoming executable under UNIX. This can + be quite annoying for shared source code, documents, etc... + </p><p> + Note that this requires the <a class="indexterm" name="id323326"></a>create mask parameter to be set such that owner + execute bit is not masked out (i.e. it must include 100). See the parameter + <a class="indexterm" name="id323334"></a>create mask for details. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map archive</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAPHIDDEN"></a>map hidden (S)</span></dt><dd><p> + This controls whether DOS style hidden files should be mapped to the UNIX world execute bit. + </p><p> + Note that this requires the <a class="indexterm" name="id323384"></a>create mask to be set such that the world execute + bit is not masked out (i.e. it must include 001). See the parameter <a class="indexterm" name="id323392"></a>create mask + for details. + </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="MAPREADONLY"></a>map read only (S)</span></dt><dd><p> + This controls how the DOS read only attribute should be mapped from a UNIX filesystem. + </p><p> + This parameter can take three different values, which tell <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> how to display the read only attribute on files, where either + <a class="indexterm" name="id323437"></a>store dos attributes is set to <code class="constant">No</code>, or no extended attribute is + present. If <a class="indexterm" name="id323448"></a>store dos attributes is set to <code class="constant">yes</code> then this + parameter is <span class="emphasis"><em>ignored</em></span>. This is a new parameter introduced in Samba version 3.0.21. + </p><p>The three settings are :</p><div class="itemizedlist"><ul type="disc"><li><p> + <code class="constant">Yes</code> - The read only DOS attribute is mapped to the inverse of the user + or owner write bit in the unix permission mode set. If the owner write bit is not set, the + read only attribute is reported as being set on the file. + </p></li><li><p> + <code class="constant">Permissions</code> - The read only DOS attribute is mapped to the effective permissions of + the connecting user, as evaluated by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> by reading the unix permissions and POSIX ACL (if present). + If the connecting user does not have permission to modify the file, the read only attribute + is reported as being set on the file. + </p></li><li><p> + <code class="constant">No</code> - The read only DOS attribute is unaffected by permissions, and can only be set by + the <a class="indexterm" name="id323505"></a>store dos attributes method. This may be useful for exporting mounted CDs. + </p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>map read only</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAPSYSTEM"></a>map system (S)</span></dt><dd><p> + This controls whether DOS style system files should be mapped to the UNIX group execute bit. + </p><p> + Note that this requires the <a class="indexterm" name="id323556"></a>create mask to be set such that the group + execute bit is not masked out (i.e. it must include 010). See the parameter + <a class="indexterm" name="id323564"></a>create mask for details. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map system</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAPTOGUEST"></a>map to guest (G)</span></dt><dd><p>This parameter is only useful in <a class="indexterm" name="id323609"></a>SECURITY = + security modes other than <em class="parameter"><code>security = share</code></em> + and <em class="parameter"><code>security = server</code></em> + - i.e. <code class="constant">user</code>, and <code class="constant">domain</code>.</p><p>This parameter can take four different values, which tell + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> what to do with user + login requests that don't match a valid UNIX user in some way.</p><p>The four settings are :</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">Never</code> - Means user login + requests with an invalid password are rejected. This is the + default.</p></li><li><p><code class="constant">Bad User</code> - Means user + logins with an invalid password are rejected, unless the username + does not exist, in which case it is treated as a guest login and + mapped into the <a class="indexterm" name="id323673"></a>guest account.</p></li><li><p><code class="constant">Bad Password</code> - Means user logins + with an invalid password are treated as a guest login and mapped + into the <a class="indexterm" name="id323690"></a>guest account. Note that + this can cause problems as it means that any user incorrectly typing + their password will be silently logged on as "guest" - and + will not know the reason they cannot access files they think + they should - there will have been no message given to them + that they got their password wrong. Helpdesk services will + <span class="emphasis"><em>hate</em></span> you if you set the <em class="parameter"><code>map to + guest</code></em> parameter this way :-).</p></li><li><p><code class="constant">Bad Uid</code> - Is only applicable when Samba is configured + in some type of domain mode security (security = {domain|ads}) and means that + user logins which are successfully authenticated but which have no valid Unix + user account (and smbd is unable to create one) should be mapped to the defined + guest account. This was the default behavior of Samba 2.x releases. Note that + if a member server is running winbindd, this option should never be required + because the nss_winbind library will export the Windows domain users and groups + to the underlying OS via the Name Service Switch interface.</p></li></ul></div><p>Note that this parameter is needed to set up "Guest" + share services when using <em class="parameter"><code>security</code></em> modes other than + share and server. This is because in these modes the name of the resource being + requested is <span class="emphasis"><em>not</em></span> sent to the server until after + the server has successfully authenticated the client so the server + cannot make authentication decisions at the correct time (connection + to the share) for "Guest" shares. This parameter is not useful with + <em class="parameter"><code>security = server</code></em> as in this security mode + no information is returned about whether a user logon failed due to + a bad username or bad password, the same error is returned from a modern server + in both cases.</p><p>For people familiar with the older Samba releases, this + parameter maps to the old compile-time setting of the <code class="constant"> + GUEST_SESSSETUP</code> value in local.h.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map to guest</code></em> = <code class="literal">Never</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>map to guest</code></em> = <code class="literal">Bad User</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXCONNECTIONS"></a>max connections (S)</span></dt><dd><p>This option allows the number of simultaneous connections to a service to be limited. + If <em class="parameter"><code>max connections</code></em> is greater than 0 then connections + will be refused if this number of connections to the service are already open. A value + of zero mean an unlimited number of connections may be made.</p><p>Record lock files are used to implement this feature. The lock files will be stored in + the directory specified by the <a class="indexterm" name="id323827"></a>lock directory option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max connections</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max connections</code></em> = <code class="literal">10</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXDISKSIZE"></a>max disk size (G)</span></dt><dd><p>This option allows you to put an upper limit + on the apparent size of disks. If you set this option to 100 + then all shares will appear to be not larger than 100 MB in + size.</p><p>Note that this option does not limit the amount of + data you can put on the disk. In the above case you could still + store much more than 100 MB on the disk, but if a client ever asks + for the amount of free disk space or the total disk size then the + result will be bounded by the amount specified in <em class="parameter"><code>max + disk size</code></em>.</p><p>This option is primarily useful to work around bugs + in some pieces of software that can't handle very large disks, + particularly disks over 1GB in size.</p><p>A <em class="parameter"><code>max disk size</code></em> of 0 means no limit.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max disk size</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max disk size</code></em> = <code class="literal">1000</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXLOGSIZE"></a>max log size (G)</span></dt><dd><p> + This option (an integer in kilobytes) specifies the max size the log file should grow to. + Samba periodically checks the size and if it is exceeded it will rename the file, adding + a <code class="filename">.old</code> extension. + </p><p>A size of 0 means no limit. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max log size</code></em> = <code class="literal">5000</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max log size</code></em> = <code class="literal">1000</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXMUX"></a>max mux (G)</span></dt><dd><p>This option controls the maximum number of + outstanding simultaneous SMB operations that Samba tells the client + it will allow. You should never need to set this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max mux</code></em> = <code class="literal">50</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXOPENFILES"></a>max open files (G)</span></dt><dd><p>This parameter limits the maximum number of + open files that one <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> file + serving process may have open for a client at any one time. The + default for this parameter is set very high (10,000) as Samba uses + only one bit per unopened file.</p><p>The limit of the number of open files is usually set + by the UNIX per-process file descriptor limit rather than + this parameter so you should never need to touch this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max open files</code></em> = <code class="literal">10000</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXPRINTJOBS"></a>max print jobs (S)</span></dt><dd><p>This parameter limits the maximum number of + jobs allowable in a Samba printer queue at any given moment. + If this number is exceeded, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will remote "Out of Space" to the client. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max print jobs</code></em> = <code class="literal">1000</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max print jobs</code></em> = <code class="literal">5000</code> +</em></span> +</p></dd><dt><span class="term"><a name="PROTOCOL"></a>protocol</span></dt><dd><p>This parameter is a synonym for max protocol.</p></dd><dt><span class="term"><a name="MAXPROTOCOL"></a>max protocol (G)</span></dt><dd><p>The value of the parameter (a string) is the highest + protocol level that will be supported by the server.</p><p>Possible values are :</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">CORE</code>: Earliest version. No + concept of user names.</p></li><li><p><code class="constant">COREPLUS</code>: Slight improvements on + CORE for efficiency.</p></li><li><p><code class="constant">LANMAN1</code>: First <span class="emphasis"><em> + modern</em></span> version of the protocol. Long filename + support.</p></li><li><p><code class="constant">LANMAN2</code>: Updates to Lanman1 protocol.</p></li><li><p><code class="constant">NT1</code>: Current up to date version of the protocol. + Used by Windows NT. Known as CIFS.</p></li></ul></div><p>Normally this option should not be set as the automatic + negotiation phase in the SMB protocol takes care of choosing + the appropriate protocol.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max protocol</code></em> = <code class="literal">NT1</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max protocol</code></em> = <code class="literal">LANMAN1</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXREPORTEDPRINTJOBS"></a>max reported print jobs (S)</span></dt><dd><p> + This parameter limits the maximum number of jobs displayed in a port monitor for + Samba printer queue at any given moment. If this number is exceeded, the excess + jobs will not be shown. A value of zero means there is no limit on the number of + print jobs reported. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max reported print jobs</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max reported print jobs</code></em> = <code class="literal">1000</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXSMBDPROCESSES"></a>max smbd processes (G)</span></dt><dd><p>This parameter limits the maximum number of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> processes concurrently running on a system and is intended + as a stopgap to prevent degrading service to clients in the event that the server has insufficient + resources to handle more than this number of connections. Remember that under normal operating + conditions, each user will have an <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> associated with him or her to handle connections to all + shares from a given host.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max smbd processes</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max smbd processes</code></em> = <code class="literal">1000</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXSTATCACHESIZE"></a>max stat cache size (G)</span></dt><dd><p>This parameter limits the size in memory of any + <em class="parameter"><code>stat cache</code></em> being used + to speed up case insensitive name mappings. This parameter is + the number of kilobyte (1024) units the stat cache can use. + A value of zero means unlimited which is not advised aѕ it can + use a lot of memory. + You should not need to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max stat cache size</code></em> = <code class="literal">256</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max stat cache size</code></em> = <code class="literal">100</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXTTL"></a>max ttl (G)</span></dt><dd><p>This option tells <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> what the default 'time to live' + of NetBIOS names should be (in seconds) when <code class="literal">nmbd</code> is + requesting a name using either a broadcast packet or from a WINS server. You should + never need to change this parameter. The default is 3 days.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max ttl</code></em> = <code class="literal">259200</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXWINSTTL"></a>max wins ttl (G)</span></dt><dd><p>This option tells <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when acting as a WINS server + (<a class="indexterm" name="id324595"></a>wins support = yes) what the maximum + 'time to live' of NetBIOS names that <code class="literal">nmbd</code> + will grant will be (in seconds). You should never need to change this + parameter. The default is 6 days (518400 seconds).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max wins ttl</code></em> = <code class="literal">518400</code> +</em></span> +</p></dd><dt><span class="term"><a name="MAXXMIT"></a>max xmit (G)</span></dt><dd><p>This option controls the maximum packet size + that will be negotiated by Samba. The default is 16644, which + matches the behavior of Windows 2000. A value below 2048 is likely to cause problems. + You should never need to change this parameter from its default value. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max xmit</code></em> = <code class="literal">16644</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max xmit</code></em> = <code class="literal">8192</code> +</em></span> +</p></dd><dt><span class="term"><a name="MESSAGECOMMAND"></a>message command (G)</span></dt><dd><p>This specifies what command to run when the + server receives a WinPopup style message.</p><p>This would normally be a command that would + deliver the message somehow. How this is to be done is + up to your imagination.</p><p>An example is: +</p><pre class="programlisting"> +<code class="literal">message command = csh -c 'xedit %s;rm %s' &</code> +</pre><p> + </p><p>This delivers the message using <code class="literal">xedit</code>, then + removes it afterwards. <span class="emphasis"><em>NOTE THAT IT IS VERY IMPORTANT + THAT THIS COMMAND RETURN IMMEDIATELY</em></span>. 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).</p><p>All messages are delivered as the global guest user. + The command takes the standard substitutions, although <em class="parameter"><code> + %u</code></em> won't work (<em class="parameter"><code>%U</code></em> may be better + in this case).</p><p>Apart from the standard substitutions, some additional + ones apply. In particular:</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>%s</code></em> = the filename containing + the message.</p></li><li><p><em class="parameter"><code>%t</code></em> = the destination that + the message was sent to (probably the server name).</p></li><li><p><em class="parameter"><code>%f</code></em> = who the message + is from.</p></li></ul></div><p>You could make this command send mail, or whatever else + takes your fancy. Please let us know of any really interesting + ideas you have.</p><p> + Here's a way of sending the messages as mail to root: +</p><pre class="programlisting"> +<code class="literal">message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s</code> +</pre><p> + </p><p>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. + </p><p> + If you want to silently delete it then try: +</p><pre class="programlisting"> +<code class="literal">message command = rm %s</code> +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>message command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>message command</code></em> = <code class="literal">csh -c 'xedit %s; rm %s' &</code> +</em></span> +</p></dd><dt><span class="term"><a name="MINPRINTSPACE"></a>min print space (S)</span></dt><dd><p>This sets the minimum amount of free disk + space that must be available before a user will be able to spool + a print job. It is specified in kilobytes. The default is 0, which + means a user can always spool a print job.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min print space</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>min print space</code></em> = <code class="literal">2000</code> +</em></span> +</p></dd><dt><span class="term"><a name="MINPROTOCOL"></a>min protocol (G)</span></dt><dd><p>The value of the parameter (a string) is the + lowest SMB protocol dialect than Samba will support. Please refer + to the <a class="indexterm" name="id324954"></a>max protocol + parameter for a list of valid protocol names and a brief description + of each. You may also wish to refer to the C source code in + <code class="filename">source/smbd/negprot.c</code> for a listing of known protocol + dialects supported by clients.</p><p>If you are viewing this parameter as a security measure, you should + also refer to the <a class="indexterm" name="id324973"></a>lanman auth parameter. Otherwise, you should never need + to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min protocol</code></em> = <code class="literal">CORE</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>min protocol</code></em> = <code class="literal">NT1</code> +</em></span> +</p></dd><dt><span class="term"><a name="MINRECEIVEFILESIZE"></a>min receivefile size (G)</span></dt><dd><p>This option changes the behavior of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when processing SMBwriteX calls. Any incoming +SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will +be passed to any underlying kernel recvfile or splice system call (if there is no such +call Samba will emulate in user space). This allows zero-copy writes directly from network +socket buffers into the filesystem buffer cache, if available. It may improve performance +but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the +normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be +nonzero. The maximum value is 128k. Values greater than 128k will be silently set to 128k.</p><p>Note this option will have NO EFFECT if set on a SMB signed connection.</p><p>The default is zero, which diables this option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min receivefile size</code></em> = <code class="literal">0</code> +</em></span> +</p></dd><dt><span class="term"><a name="MINWINSTTL"></a>min wins ttl (G)</span></dt><dd><p>This option tells <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> + when acting as a WINS server (<a class="indexterm" name="id325104"></a>wins support = yes) what the minimum 'time to live' + of NetBIOS names that <code class="literal">nmbd</code> will grant will be (in + seconds). You should never need to change this parameter. The default + is 6 hours (21600 seconds).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min wins ttl</code></em> = <code class="literal">21600</code> +</em></span> +</p></dd><dt><span class="term"><a name="MSDFSPROXY"></a>msdfs proxy (S)</span></dt><dd><p>This parameter indicates that the share is a + stand-in for another CIFS share whose location is specified by + the value of the parameter. When clients attempt to connect to + this share, they are redirected to the proxied share using + the SMB-Dfs protocol.</p><p>Only Dfs roots can act as proxy shares. Take a look at the + <a class="indexterm" name="id325163"></a>msdfs root and <a class="indexterm" name="id325170"></a>host msdfs + options to find out how to set up a Dfs root share.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>msdfs proxy</code></em> = <code class="literal">\otherserver\someshare</code> +</em></span> +</p></dd><dt><span class="term"><a name="MSDFSROOT"></a>msdfs root (S)</span></dt><dd><p>If set to <code class="constant">yes</code>, Samba treats the + share as a Dfs root and allows clients to browse the + distributed file system tree rooted at the share directory. + Dfs links are specified in the share directory by symbolic + links of the form <code class="filename">msdfs:serverA\\shareA,serverB\\shareB</code> + and so on. For more information on setting up a Dfs tree on + Samba, refer to the MSDFS chapter in the Samba3-HOWTO book.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>msdfs root</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="NAMECACHETIMEOUT"></a>name cache timeout (G)</span></dt><dd><p>Specifies the number of seconds it takes before + entries in samba's hostname resolve cache time out. If + the timeout is set to 0. the caching is disabled. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>name cache timeout</code></em> = <code class="literal">660</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>name cache timeout</code></em> = <code class="literal">0</code> +</em></span> +</p></dd><dt><span class="term"><a name="NAMERESOLVEORDER"></a>name resolve order (G)</span></dt><dd><p>This option is used by the programs in the Samba + suite to determine what naming services to use and in what order + to resolve host names to IP addresses. Its main purpose to is to + control how netbios name resolution is performed. The option takes a space + separated string of name resolution options.</p><p>The options are: "lmhosts", "host", + "wins" and "bcast". They cause names to be + resolved as follows:</p><div class="itemizedlist"><ul type="disc"><li><p> + <code class="constant">lmhosts</code> : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then + any name type matches for lookup. + </p></li><li><p> + <code class="constant">host</code> : Do a standard host name to IP address resolution, using the system + <code class="filename">/etc/hosts </code>, NIS, or DNS lookups. This method of name resolution is + operating system depended for instance on IRIX or Solaris this may be controlled by the <code class="filename">/etc/nsswitch.conf</code> file. Note that this method is used only if the NetBIOS name + type being queried is the 0x20 (server) name type or 0x1c (domain controllers). The latter case is only + useful for active directory domains and results in a DNS query for the SRV RR entry matching + _ldap._tcp.domain. + </p></li><li><p><code class="constant">wins</code> : Query a name with + the IP address listed in the <a class="indexterm" name="id325382"></a>WINSSERVER parameter. If no WINS server has + been specified this method will be ignored.</p></li><li><p><code class="constant">bcast</code> : Do a broadcast on + each of the known local interfaces listed in the <a class="indexterm" name="id325399"></a>interfaces + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet.</p></li></ul></div><p>The example below will cause the local lmhosts file to be examined + first, followed by a broadcast attempt, followed by a normal + system hostname lookup.</p><p>When Samba is functioning in ADS security mode (<code class="literal">security = ads</code>) + it is advised to use following settings for <em class="parameter"><code>name resolve order</code></em>:</p><p><code class="literal">name resolve order = wins bcast</code></p><p>DC lookups will still be done via DNS, but fallbacks to netbios names will + not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>name resolve order</code></em> = <code class="literal">lmhosts host wins bcast</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>name resolve order</code></em> = <code class="literal">lmhosts bcast host</code> +</em></span> +</p></dd><dt><span class="term"><a name="NETBIOSALIASES"></a>netbios aliases (G)</span></dt><dd><p>This is a list of NetBIOS names that nmbd will + advertise as additional names by which the Samba server is known. This allows one machine + to appear in browse lists under multiple names. If a machine is acting as a browse server + or logon server none of these names will be advertised as either browse server or logon + servers, only the primary name of the machine will be advertised with these capabilities. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>netbios aliases</code></em> = <code class="literal"> +# empty string (no additional names)</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>netbios aliases</code></em> = <code class="literal">TEST TEST1 TEST2</code> +</em></span> +</p></dd><dt><span class="term"><a name="NETBIOSNAME"></a>netbios name (G)</span></dt><dd><p> + This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component + of the host's DNS name. If a machine is a browse server or logon server this name (or the first component of + the hosts DNS name) will be the name that these services are advertised under. + </p><p> + There is a bug in Samba-3 that breaks operation of browsing and access to shares if the netbios name + is set to the literal name <code class="literal">PIPE</code>. To avoid this problem, do not name your Samba-3 + server <code class="literal">PIPE</code>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>netbios name</code></em> = <code class="literal"> +# machine DNS name</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>netbios name</code></em> = <code class="literal">MYNAME</code> +</em></span> +</p></dd><dt><span class="term"><a name="NETBIOSSCOPE"></a>netbios scope (G)</span></dt><dd><p>This sets the NetBIOS scope that Samba will + operate under. This should not be set unless every machine + on your LAN also sets this value.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>netbios scope</code></em> = <code class="literal"></code> +</em></span> +</p></dd><dt><span class="term"><a name="NISHOMEDIR"></a>nis homedir (G)</span></dt><dd><p>Get the home share server from a NIS map. For + UNIX systems that use an automounter, the user's home directory + will often be mounted on a workstation on demand from a remote + server. </p><p>When the Samba logon server is not the actual home directory + server, but is mounting the home directories via NFS then two + network hops would be required to access the users home directory + if the logon server told the client to use itself as the SMB server + for home directories (one over SMB and one over NFS). This can + be very slow.</p><p>This option allows Samba to return the home share as + being on a different server to the logon server and as + long as a Samba daemon is running on the home directory server, + it will be mounted on the Samba client directly from the directory + server. When Samba is returning the home share to the client, it + will consult the NIS map specified in + <a class="indexterm" name="id325685"></a>homedir map and return the server + listed there.</p><p>Note that for this option to work there must be a working + NIS system and the Samba server with this option must also + be a logon server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nis homedir</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="NTACLSUPPORT"></a>nt acl support (S)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map + UNIX permissions into Windows NT access control lists. The UNIX + permissions considered are the the traditional UNIX owner and + group permissions, as well as POSIX ACLs set on any files or + directories. This parameter was formally a global parameter in + releases prior to 2.2.2.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt acl support</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="NTLMAUTH"></a>ntlm auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to + authenticate users using the NTLM encrypted password response. + If disabled, either the lanman password hash or an NTLMv2 response + will need to be sent by the client.</p><p>If this option, and <code class="literal">lanman + auth</code> are both disabled, then only NTLMv2 logins will be + permited. Not all clients support NTLMv2, and most will require + special configuration to us it.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ntlm auth</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="NTPIPESUPPORT"></a>nt pipe support (G)</span></dt><dd><p>This boolean parameter controls whether + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow Windows NT + clients to connect to the NT SMB specific <code class="constant">IPC$</code> + pipes. This is a developer debugging option and can be left + alone.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt pipe support</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="NTSTATUSSUPPORT"></a>nt status support (G)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will negotiate NT specific status + support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone. + If this option is set to <code class="constant">no</code> then Samba offers + exactly the same DOS error codes that versions prior to Samba 2.2.3 + reported.</p><p>You should not need to ever disable this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt status support</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="NULLPASSWORDS"></a>null passwords (G)</span></dt><dd><p>Allow or disallow client access to accounts that have null passwords. </p><p>See also <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>null passwords</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="OBEYPAMRESTRICTIONS"></a>obey pam restrictions (G)</span></dt><dd><p>When Samba 3.0 is configured to enable PAM support + (i.e. --with-pam), this parameter will control whether or not Samba + should obey PAM's account and session management directives. The + default behavior is to use PAM for clear text authentication only + and to ignore any account or session management. Note that Samba + always ignores PAM for authentication in the case of <a class="indexterm" name="id326002"></a>encrypt passwords = yes. The reason + is that PAM modules cannot support the challenge/response + authentication mechanism needed in the presence of SMB password encryption. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>obey pam restrictions</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="ONLYUSER"></a>only user (S)</span></dt><dd><p>This is a boolean option that controls whether + connections with usernames not in the <em class="parameter"><code>user</code></em> + list will be allowed. By default this option is disabled so that a + client can supply a username to be used by the server. Enabling + this parameter will force the server to only use the login + names from the <em class="parameter"><code>user</code></em> list and is only really + useful in <a class="indexterm" name="id326064"></a>security = share level security.</p><p>Note that this also means Samba won't try to deduce + usernames from the service name. This can be annoying for + the [homes] section. To get around this you could use <code class="literal">user = + %S</code> which means your <em class="parameter"><code>user</code></em> list + will be just the service name, which for home directories is the + name of the user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>only user</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="OPLOCKBREAKWAITTIME"></a>oplock break wait time (G)</span></dt><dd><p> + This is a tuning parameter added due to bugs in both Windows 9x and WinNT. If Samba responds to a client too + quickly when that client issues an SMB that can cause an oplock break request, then the network client can + fail and not respond to the break request. This tuning parameter (which is set in milliseconds) is the amount + of time Samba will wait before sending an oplock break request to such (broken) clients. + </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p> + DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplock break wait time</code></em> = <code class="literal">0</code> +</em></span> +</p></dd><dt><span class="term"><a name="OPLOCKCONTENTIONLIMIT"></a>oplock contention limit (S)</span></dt><dd><p> + This is a <span class="emphasis"><em>very</em></span> advanced <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> tuning option to improve the efficiency of the + granting of oplocks under multiple client contention for the same file. + </p><p> + In brief it specifies a number, which causes <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>not to grant an oplock even when requested if the + approximate number of clients contending for an oplock on the same file goes over this + limit. This causes <code class="literal">smbd</code> to behave in a similar + way to Windows NT. + </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p> + DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplock contention limit</code></em> = <code class="literal">2</code> +</em></span> +</p></dd><dt><span class="term"><a name="OPLOCKS"></a>oplocks (S)</span></dt><dd><p> + This boolean option tells <code class="literal">smbd</code> whether to + issue oplocks (opportunistic locks) to file open requests on this + share. The oplock code can dramatically (approx. 30% or more) improve + the speed of access to files on Samba servers. It allows the clients + to aggressively cache files locally and you may want to disable this + option for unreliable network environments (it is turned on by + default in Windows NT Servers). For more information see the file + <code class="filename">Speed.txt</code> in the Samba + <code class="filename">docs/</code> directory. + </p><p> + Oplocks may be selectively turned off on certain files with a share. See + the <a class="indexterm" name="id326275"></a>veto oplock files parameter. On some systems + oplocks are recognized by the underlying operating system. This + allows data synchronization between all access to oplocked files, + whether it be via Samba or NFS or a local UNIX process. See the + <a class="indexterm" name="id326284"></a>kernel oplocks parameter for details. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplocks</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="OS2DRIVERMAP"></a>os2 driver map (G)</span></dt><dd><p>The parameter is used to define the absolute + path to a file containing a mapping of Windows NT printer driver + names to OS/2 printer driver names. The format is:</p><p><nt driver name> = <os2 driver name>.<device name></p><p>For example, a valid entry using the HP LaserJet 5 + printer driver would appear as <code class="literal">HP LaserJet 5L = LASERJET.HP + LaserJet 5L</code>.</p><p> + The need for the file is due to the printer driver namespace problem described in + the chapter on Classical Printing in the Samba3-HOWTO book. For more + details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>os2 driver map</code></em> = <code class="literal"></code> +</em></span> +</p></dd><dt><span class="term"><a name="OSLEVEL"></a>os level (G)</span></dt><dd><p> + This integer value controls what level Samba advertises itself as for browse elections. The value of this + parameter determines whether <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> has a chance of becoming a local master browser for the <a class="indexterm" name="id326397"></a>workgroup in the local broadcast area. +</p><p><span class="emphasis"><em> + Note:</em></span> By default, Samba will win a local master browsing election over all Microsoft operating + systems except a Windows NT 4.0/2000 Domain Controller. This means that a misconfigured Samba host can + effectively isolate a subnet for browsing purposes. This parameter is largely auto-configured in the Samba-3 + release series and it is seldom necessary to manually override the default setting. Please refer to + chapter 9 of the Samba-3 HOWTO document for further information regarding the use of this parameter. + <span class="emphasis"><em>Note:</em></span> The maximum value for this parameter is 255. If you use higher values, counting + will start at 0! + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>os level</code></em> = <code class="literal">20</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>os level</code></em> = <code class="literal">65</code> +</em></span> +</p></dd><dt><span class="term"><a name="PAMPASSWORDCHANGE"></a>pam password change (G)</span></dt><dd><p>With the addition of better PAM support in Samba 2.2, + this parameter, it is possible to use PAM's password change control + flag for Samba. If enabled, then PAM will be used for password + changes when requested by an SMB client instead of the program listed in + <a class="indexterm" name="id326476"></a>passwd program. + It should be possible to enable this without changing your + <a class="indexterm" name="id326484"></a>passwd chat parameter for most setups.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>pam password change</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="PANICACTION"></a>panic action (G)</span></dt><dd><p>This is a Samba developer option that allows a + system command to be called when either <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> or <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> crashes. This is usually used to + draw attention to the fact that a problem occurred. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>panic action</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>panic action</code></em> = <code class="literal">"/bin/sleep 90000"</code> +</em></span> +</p></dd><dt><span class="term"><a name="PARANOIDSERVERSECURITY"></a>paranoid server security (G)</span></dt><dd><p>Some version of NT 4.x allow non-guest + users with a bad passowrd. When this option is enabled, samba will not + use a broken NT 4.x server as password server, but instead complain + to the logs and exit. + </p><p>Disabling this option prevents Samba from making + this check, which involves deliberatly attempting a + bad logon to the remote server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>paranoid server security</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSDBBACKEND"></a>passdb backend (G)</span></dt><dd><p>This option allows the administrator to chose which backend + will be used for storing user and possibly group information. This allows + you to swap between dfferent storage mechanisms without recompile. </p><p>The parameter value is divided into two parts, the backend's name, and a 'location' + string that has meaning only to that particular backed. These are separated + by a : character.</p><p>Available backends can include: + </p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">smbpasswd</code> - The default smbpasswd + backend. Takes a path to the smbpasswd file as an optional argument. + </p></li><li><p><code class="literal">tdbsam</code> - The TDB based password storage + backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb + in the <a class="indexterm" name="id326681"></a>private dir directory.</p></li><li><p><code class="literal">ldapsam</code> - The LDAP based passdb + backend. Takes an LDAP URL as an optional argument (defaults to + <code class="literal">ldap://localhost</code>)</p><p>LDAP connections should be secured where possible. This may be done using either + Start-TLS (see <a class="indexterm" name="id326710"></a>ldap ssl) or by + specifying <em class="parameter"><code>ldaps://</code></em> in + the URL argument. </p><p>Multiple servers may also be specified in double-quotes, if your + LDAP libraries supports the LDAP URL notation. + (OpenLDAP does). + </p></li></ul></div><p> + + </p> + Examples of use are: +<pre class="programlisting"> +passdb backend = tdbsam:/etc/samba/private/passdb.tdb + +or + +passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com" +</pre><p>Default: <span class="emphasis"><em><em class="parameter"><code>passdb backend</code></em> = <code class="literal">smbpasswd</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSDBEXPANDEXPLICIT"></a>passdb expand explicit (G)</span></dt><dd><p> + This parameter controls whether Samba substitutes %-macros in the passdb fields if they are explicitly set. We + used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable + %G_osver% in which %G would have been substituted by the user's primary group. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passdb expand explicit</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSWDCHAT"></a>passwd chat (G)</span></dt><dd><p>This string controls the <span class="emphasis"><em>"chat"</em></span> + conversation that takes places between <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and the local password changing + program to change the user's password. The string describes a + sequence of response-receive pairs that <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> uses to determine what to send to the + <a class="indexterm" name="id326839"></a>passwd program and what to expect back. If the expected output is not + received then the password is not changed.</p><p>This chat sequence is often quite site specific, depending + on what local methods are used for password control (such as NIS + etc).</p><p>Note that this parameter only is only used if the <a class="indexterm" name="id326855"></a>unix password sync parameter is set to <code class="constant">yes</code>. This sequence is + then called <span class="emphasis"><em>AS ROOT</em></span> when the SMB password in the + smbpasswd file is being changed, without access to the old password + cleartext. This means that root must be able to reset the user's password without + knowing the text of the previous password. In the presence of + NIS/YP, this means that the <a class="indexterm" name="id326872"></a>passwd program must + be executed on the NIS master. + </p><p>The string can contain the macro <em class="parameter"><code>%n</code></em> which is substituted + for the new password. The old passsword (<em class="parameter"><code>%o</code></em>) is only available when + <a class="indexterm" name="id326895"></a>encrypt passwords has been disabled. + The chat sequence can also contain the standard macros + \n, \r, \t and \s to give line-feed, carriage-return, tab + and space. The chat sequence string can also contain + a '*' which matches any sequence of characters. Double quotes can + be used to collect strings with spaces in them into a single + string.</p><p>If the send string in any part of the chat sequence is a full + stop ".", then no string is sent. Similarly, if the + expect string is a full stop then no string is expected.</p><p>If the <a class="indexterm" name="id326913"></a>pam password change parameter is set to <code class="constant">yes</code>, the + chat pairs may be matched in any order, and success is determined by the PAM result, not any particular + output. The \n macro is ignored for PAM conversions. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat</code></em> = <code class="literal">*new*password* %n\n*new*password* %n\n *changed*</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>passwd chat</code></em> = <code class="literal">"*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSWDCHATDEBUG"></a>passwd chat debug (G)</span></dt><dd><p>This boolean specifies if the passwd chat script + parameter is run in <span class="emphasis"><em>debug</em></span> mode. In this mode the + strings passed to and received from the passwd chat are printed + in the <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> log with a + <a class="indexterm" name="id326995"></a>debug level + of 100. This is a dangerous option as it will allow plaintext passwords + to be seen in the <code class="literal">smbd</code> log. It is available to help + Samba admins debug their <em class="parameter"><code>passwd chat</code></em> scripts + when calling the <em class="parameter"><code>passwd program</code></em> and should + be turned off after this has been done. This option has no effect if the + <a class="indexterm" name="id327022"></a>pam password change + parameter is set. This parameter is off by default.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat debug</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSWDCHATTIMEOUT"></a>passwd chat timeout (G)</span></dt><dd><p>This integer specifies the number of seconds smbd will wait for an initial + answer from a passwd chat script being run. Once the initial answer is received + the subsequent answers must be received in one tenth of this time. The default it + two seconds.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat timeout</code></em> = <code class="literal">2</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSWDPROGRAM"></a>passwd program (G)</span></dt><dd><p>The name of a program that can be used to set + UNIX user passwords. Any occurrences of <em class="parameter"><code>%u</code></em> + will be replaced with the user name. The user name is checked for + existence before calling the password changing program.</p><p>Also note that many passwd programs insist in <span class="emphasis"><em>reasonable + </em></span> passwords, such as a minimum length, or the inclusion + of mixed case chars and digits. This can pose a problem as some clients + (such as Windows for Workgroups) uppercase the password before sending + it.</p><p><span class="emphasis"><em>Note</em></span> that if the <em class="parameter"><code>unix + password sync</code></em> parameter is set to <code class="constant">yes + </code> then this program is called <span class="emphasis"><em>AS ROOT</em></span> + before the SMB password in the smbpasswd + file is changed. If this UNIX password change fails, then + <code class="literal">smbd</code> will fail to change the SMB password also + (this is by design).</p><p>If the <em class="parameter"><code>unix password sync</code></em> parameter + is set this parameter <span class="emphasis"><em>MUST USE ABSOLUTE PATHS</em></span> + for <span class="emphasis"><em>ALL</em></span> programs called, and must be examined + for security implications. Note that by default <em class="parameter"><code>unix + password sync</code></em> is set to <code class="constant">no</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd program</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>passwd program</code></em> = <code class="literal">/bin/passwd %u</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSWORDLEVEL"></a>password level (G)</span></dt><dd><p>Some client/server combinations have difficulty + with mixed-case passwords. One offending client is Windows for + Workgroups, which for some reason forces passwords to upper + case when using the LANMAN1 protocol, but leaves them alone when + using COREPLUS! Another problem child is the Windows 95/98 + family of operating systems. These clients upper case clear + text passwords even when NT LM 0.12 selected by the protocol + negotiation request/response.</p><p>This parameter defines the maximum number of characters + that may be upper case in passwords.</p><p>For example, say the password given was "FRED". If <em class="parameter"><code> + password level</code></em> is set to 1, the following combinations + would be tried if "FRED" failed:</p><p>"Fred", "fred", "fRed", "frEd","freD"</p><p>If <em class="parameter"><code>password level</code></em> was set to 2, + the following combinations would also be tried: </p><p>"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</p><p>And so on.</p><p>The higher value this parameter is set to the more likely + it is that a mixed case password will be matched against a single + case password. However, you should be aware that use of this + parameter reduces security and increases the time taken to + process a new connection.</p><p>A value of zero will cause only two attempts to be + made - the password as is and the password in all-lower case.</p><p>This parameter is used only when using plain-text passwords. It is + not at all used when encrypted passwords as in use (that is the default + since samba-3.0.0). Use this only when <a class="indexterm" name="id327287"></a>encrypt passwords = No.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>password level</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password level</code></em> = <code class="literal">4</code> +</em></span> +</p></dd><dt><span class="term"><a name="PASSWORDSERVER"></a>password server (G)</span></dt><dd><p>By specifying the name of another SMB server + or Active Directory domain controller with this option, + and using <code class="literal">security = [ads|domain|server]</code> + it is possible to get Samba to + to do all its username/password validation using a specific remote server.</p><p>This option sets the name or IP address of the password server to use. + New syntax has been added to support defining the port to use when connecting + to the server the case of an ADS realm. To define a port other than the + default LDAP port of 389, add the port number using a colon after the + name or IP address (e.g. 192.168.1.100:389). If you do not specify a port, + Samba will use the standard LDAP port of tcp/389. Note that port numbers + have no effect on password servers for Windows NT 4.0 domains or netbios + connections.</p><p>If parameter is a name, it is looked up using the + parameter <a class="indexterm" name="id327369"></a>name resolve order and so may resolved + by any method and order described in that parameter.</p><p>The password server must be a machine capable of using + the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in + user level security mode.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Using a password server means your UNIX box (running + Samba) is only as secure as your password server. <span class="emphasis"><em>DO NOT + CHOOSE A PASSWORD SERVER THAT YOU DON'T COMPLETELY TRUST</em></span>. + </p></div><p>Never point a Samba server at itself for password serving. + This will cause a loop and could lock up your Samba server!</p><p>The name of the password server takes the standard + substitutions, but probably the only useful one is <em class="parameter"><code>%m + </code></em>, which means the Samba server will use the incoming + client as the password server. If you use this then you better + trust your clients, and you had better restrict them with hosts allow!</p><p>If the <em class="parameter"><code>security</code></em> parameter is set to + <code class="constant">domain</code> or <code class="constant">ads</code>, then the list of machines in this + option must be a list of Primary or Backup Domain controllers for the + Domain or the character '*', as the Samba server is effectively + in that domain, and will use cryptographically authenticated RPC calls + to authenticate the user logging on. The advantage of using <code class="literal"> + security = domain</code> is that if you list several hosts in the + <em class="parameter"><code>password server</code></em> option then <code class="literal">smbd + </code> will try each in turn till it finds one that responds. This + is useful in case your primary server goes down.</p><p>If the <em class="parameter"><code>password server</code></em> option is set + to the character '*', then Samba will attempt to auto-locate the + Primary or Backup Domain controllers to authenticate against by + doing a query for the name <code class="constant">WORKGROUP<1C></code> + and then contacting each server returned in the list of IP + addresses from the name resolution source. </p><p>If the list of servers contains both names/IP's and the '*' + character, the list is treated as a list of preferred + domain controllers, but an auto lookup of all remaining DC's + will be added to the list as well. Samba will not attempt to optimize + this list by locating the closest DC.</p><p>If the <em class="parameter"><code>security</code></em> parameter is + set to <code class="constant">server</code>, then there are different + restrictions that <code class="literal">security = domain</code> doesn't + suffer from:</p><div class="itemizedlist"><ul type="disc"><li><p>You may list several password servers in + the <em class="parameter"><code>password server</code></em> parameter, however if an + <code class="literal">smbd</code> makes a connection to a password server, + and then the password server fails, no more users will be able + to be authenticated from this <code class="literal">smbd</code>. This is a + restriction of the SMB/CIFS protocol when in <code class="literal">security = server + </code> mode and cannot be fixed in Samba.</p></li><li><p>If you are using a Windows NT server as your + password server then you will have to ensure that your users + are able to login from the Samba server, as when in <code class="literal"> + security = server</code> mode the network logon will appear to + come from there rather than from the users workstation.</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal">NT-PDC, NT-BDC1, NT-BDC2, *</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal">windc.mydomain.com:389 192.168.1.101 *</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal">*</code> +</em></span> +</p></dd><dt><span class="term"><a name="DIRECTORY"></a>directory</span></dt><dd><p>This parameter is a synonym for path.</p></dd><dt><span class="term"><a name="PATH"></a>path (S)</span></dt><dd><p>This parameter specifies a directory to which + the user of the service is to be given access. In the case of + printable services, this is where print data will spool prior to + being submitted to the host for printing.</p><p>For a printable service offering guest access, the service + should be readonly and the path should be world-writeable and + have the sticky bit set. This is not mandatory of course, but + you probably won't get the results you expect if you do + otherwise.</p><p>Any occurrences of <em class="parameter"><code>%u</code></em> in the path + will be replaced with the UNIX username that the client is using + on this connection. Any occurrences of <em class="parameter"><code>%m</code></em> + will be replaced by the NetBIOS name of the machine they are + connecting from. These replacements are very useful for setting + up pseudo home directories for users.</p><p>Note that this path will be based on <a class="indexterm" name="id327672"></a>root dir + if one was specified.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>path</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>path</code></em> = <code class="literal">/home/fred</code> +</em></span> +</p></dd><dt><span class="term"><a name="PIDDIRECTORY"></a>pid directory (G)</span></dt><dd><p> + This option specifies the directory where pid files will be placed. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>pid directory</code></em> = <code class="literal">${prefix}/var/locks</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>pid directory</code></em> = <code class="literal">pid directory = /var/run/</code> +</em></span> +</p></dd><dt><span class="term"><a name="POSIXLOCKING"></a>posix locking (S)</span></dt><dd><p> + The <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> + daemon maintains an database of file locks obtained by SMB clients. The default behavior is + to map this internal database to POSIX locks. This means that file locks obtained by SMB clients are + consistent with those seen by POSIX compliant applications accessing the files via a non-SMB + method (e.g. NFS or local file access). You should never need to disable this parameter. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>posix locking</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="POSTEXEC"></a>postexec (S)</span></dt><dd><p>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.</p><p>An interesting example may be to unmount server + resources:</p><p><code class="literal">postexec = /etc/umount /cdrom</code></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>postexec</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>postexec</code></em> = <code class="literal">echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log</code> +</em></span> +</p></dd><dt><span class="term"><a name="EXEC"></a>exec</span></dt><dd><p>This parameter is a synonym for preexec.</p></dd><dt><span class="term"><a name="PREEXEC"></a>preexec (S)</span></dt><dd><p>This option specifies a command to be run whenever + the service is connected to. It takes the usual substitutions.</p><p>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:</p><p> + <code class="literal">preexec = csh -c 'echo \"Welcome to %S!\" | + /usr/local/samba/bin/smbclient -M %m -I %I' & </code> + </p><p>Of course, this could get annoying after a while :-)</p><p> + See also <a class="indexterm" name="id327950"></a>preexec close and <a class="indexterm" name="id327957"></a>postexec. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preexec</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preexec</code></em> = <code class="literal">echo \"%u connected to %S from %m (%I)\" >> /tmp/log</code> +</em></span> +</p></dd><dt><span class="term"><a name="PREEXECCLOSE"></a>preexec close (S)</span></dt><dd><p> + This boolean option controls whether a non-zero return code from <a class="indexterm" name="id328019"></a>preexec + should close the service being connected to. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preexec close</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="PREFEREDMASTER"></a>prefered master</span></dt><dd><p>This parameter is a synonym for preferred master.</p></dd><dt><span class="term"><a name="PREFERREDMASTER"></a>preferred master (G)</span></dt><dd><p> + This boolean parameter controls if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> is a preferred master browser for its workgroup. + </p><p> + If this is set to <code class="constant">yes</code>, on startup, <code class="literal">nmbd</code> will force + an election, and it will have a slight advantage in winning the election. It is recommended that this + parameter is used in conjunction with <a class="indexterm" name="id328108"></a>domain master = yes, so that + <code class="literal">nmbd</code> can guarantee becoming a domain master. + </p><p> + Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) + that are preferred master browsers on the same subnet, they will each periodically and continuously attempt + to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing + capabilities. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preferred master</code></em> = <code class="literal">auto</code> +</em></span> +</p></dd><dt><span class="term"><a name="AUTOSERVICES"></a>auto services</span></dt><dd><p>This parameter is a synonym for preload.</p></dd><dt><span class="term"><a name="PRELOAD"></a>preload (G)</span></dt><dd><p>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.</p><p> + Note that if you just want all printers in your + printcap file loaded then the <a class="indexterm" name="id328193"></a>load printers + option is easier. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preload</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preload</code></em> = <code class="literal">fred lp colorlp</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRELOADMODULES"></a>preload modules (G)</span></dt><dd><p>This is a list of paths to modules that should + be loaded into smbd before a client connects. This improves + the speed of smbd when reacting to new connections somewhat. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal">/usr/lib/samba/passdb/mysql.so</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRESERVECASE"></a>preserve case (S)</span></dt><dd><p> + This controls if new filenames are created with the case that the client passes, or if + they are forced to be the <a class="indexterm" name="id328311"></a>default case. + </p><p> + See the section on <a href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a> for a fuller discussion. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preserve case</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRINTOK"></a>print ok</span></dt><dd><p>This parameter is a synonym for printable.</p></dd><dt><span class="term"><a name="PRINTABLE"></a>printable (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code>, then + clients may open, write to and submit spool files on the directory + specified for the service. </p><p>Note that a printable service will ALWAYS allow writing + to the service path (user privileges permitting) via the spooling + of print data. The <a class="indexterm" name="id328500"></a>read only parameter controls only non-printing access to + the resource.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printable</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRINTCAPCACHETIME"></a>printcap cache time (G)</span></dt><dd><p>This option specifies the number of seconds before the printing + subsystem is again asked for the known printers. If the value + is greater than 60 the initial waiting time is set to 60 seconds + to allow an earlier first rescan of the printing subsystem. + </p><p>Setting this parameter to 0 disables any rescanning for new + or removed printers after the initial startup. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printcap cache time</code></em> = <code class="literal">750</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printcap cache time</code></em> = <code class="literal">600</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRINTCAP"></a>printcap</span></dt><dd><p>This parameter is a synonym for printcap name.</p></dd><dt><span class="term"><a name="PRINTCAPNAME"></a>printcap name (S)</span></dt><dd><p> + This parameter may be used to override the compiled-in default printcap name used by the server (usually + <code class="filename"> /etc/printcap</code>). See the discussion of the <a href="#PRINTERSSECT" title="The [printers] section">[printers]</a> section above for reasons why you might want to do this. + </p><p> + To use the CUPS printing interface set <code class="literal">printcap name = cups </code>. This should + be supplemented by an addtional setting <a class="indexterm" name="id328654"></a>printing = cups in the [global] + section. <code class="literal">printcap name = cups</code> will use the "dummy" printcap + created by CUPS, as specified in your CUPS configuration file. + </p><p> + On System V systems that use <code class="literal">lpstat</code> to + list available printers you can use <code class="literal">printcap name = lpstat + </code> to automatically obtain lists of available printers. This + is the default for systems that define SYSV at configure time in + Samba (this includes most System V based systems). If <em class="parameter"><code> + printcap name</code></em> is set to <code class="literal">lpstat</code> on + these systems then Samba will launch <code class="literal">lpstat -v</code> and + attempt to parse the output to obtain a printer list. + </p><p> + A minimal printcap file would look something like this: +</p><pre class="programlisting"> +print1|My Printer 1 +print2|My Printer 2 +print3|My Printer 3 +print4|My Printer 4 +print5|My Printer 5 +</pre><p> + where the '|' separates aliases of a printer. The fact that the second alias has a space in + it gives a hint to Samba that it's a comment. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + Under AIX the default printcap name is <code class="filename">/etc/qconfig</code>. Samba will + assume the file is in AIX <code class="filename">qconfig</code> format if the string <code class="filename">qconfig</code> appears in the printcap filename. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>printcap name</code></em> = <code class="literal">/etc/printcap</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printcap name</code></em> = <code class="literal">/etc/myprintcap</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRINTCOMMAND"></a>print command (S)</span></dt><dd><p>After a print job has finished spooling to + a service, this command will be used via a <code class="literal">system()</code> + call to process the spool file. Typically the command specified will + submit the spool file to the host's printing subsystem, but there + is no requirement that this be the case. The server will not remove + the spool file, so whatever command you specify should remove the + spool file when it has been processed, otherwise you will need to + manually remove old spool files.</p><p>The print command is simply a text string. It will be used + verbatim after macro substitutions have been made:</p><p>%s, %f - the path to the spool + file name</p><p>%p - the appropriate printer + name</p><p>%J - the job + name as transmitted by the client.</p><p>%c - The number of printed pages + of the spooled job (if known).</p><p>%z - the size of the spooled + print job (in bytes)</p><p>The print command <span class="emphasis"><em>MUST</em></span> contain at least + one occurrence of <em class="parameter"><code>%s</code></em> or <em class="parameter"><code>%f + </code></em> - the <em class="parameter"><code>%p</code></em> is optional. At the time + a job is submitted, if no printer name is supplied the <em class="parameter"><code>%p + </code></em> will be silently removed from the printer command.</p><p>If specified in the [global] section, the print command given + will be used for any printable service that does not have its own + print command specified.</p><p>If there is neither a specified print command for a + printable service nor a global print command, spool files will + be created but not processed and (most importantly) not removed.</p><p>Note that printing may fail on some UNIXes from the + <code class="constant">nobody</code> account. If this happens then create + an alternative guest account that can print and set the <a class="indexterm" name="id328877"></a>guest account + in the [global] section.</p><p>You can form quite complex print commands by realizing + that they are just passed to a shell. For example the following + will log a print job, print the file, then remove it. Note that + ';' is the usual separator for command in shell scripts.</p><p><code class="literal">print command = echo Printing %s >> + /tmp/print.log; lpr -P %p %s; rm %s</code></p><p>You may have to vary this command considerably depending + on how you normally print files on your system. The default for + the parameter varies depending on the setting of the <a class="indexterm" name="id328903"></a>printing + parameter.</p><p>Default: For <code class="literal">printing = BSD, AIX, QNX, LPRNG + or PLP :</code></p><p><code class="literal">print command = lpr -r -P%p %s</code></p><p>For <code class="literal">printing = SYSV or HPUX :</code></p><p><code class="literal">print command = lp -c -d%p %s; rm %s</code></p><p>For <code class="literal">printing = SOFTQ :</code></p><p><code class="literal">print command = lp -d%p -s %s; rm %s</code></p><p>For printing = CUPS : If SAMBA is compiled against + libcups, then <a class="indexterm" name="id328959"></a>printcap = cups + uses the CUPS API to + submit jobs, etc. Otherwise it maps to the System V + commands with the -oraw option for printing, i.e. it + uses <code class="literal">lp -c -d%p -oraw; rm %s</code>. + With <code class="literal">printing = cups</code>, + and if SAMBA is compiled against libcups, any manually + set print command will be ignored.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>print command</code></em> = <code class="literal">/usr/local/samba/bin/myprintscript %p %s</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRINTERADMIN"></a>printer admin (S)</span></dt><dd><p> + This lists users who can do anything to printers + via the remote administration interfaces offered + by MS-RPC (usually using a NT workstation). + This parameter can be set per-share or globally. + Note: The root user always has admin rights. Use + caution with use in the global stanza as this can + cause side effects. + </p><p> + This parameter has been marked deprecated in favor + of using the SePrintOperatorPrivilege and individual + print security descriptors. It will be removed in a future release. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printer admin</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printer admin</code></em> = <code class="literal">admin, @staff</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRINTER"></a>printer</span></dt><dd><p>This parameter is a synonym for printer name.</p></dd><dt><span class="term"><a name="PRINTERNAME"></a>printer name (S)</span></dt><dd><p> + This parameter specifies the name of the printer to which print jobs spooled through a printable service + will be sent. + </p><p> + If specified in the [global] section, the printer name given will be used for any printable service that + does not have its own printer name specified. + </p><p> + The default value of the <a class="indexterm" name="id329116"></a>printer name may be <code class="literal">lp</code> on many + systems. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printer name</code></em> = <code class="literal">none</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printer name</code></em> = <code class="literal">laserwriter</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRINTING"></a>printing (S)</span></dt><dd><p>This parameters controls how printer status information is + interpreted on your system. It also affects the default values for + the <em class="parameter"><code>print command</code></em>, <em class="parameter"><code>lpq command</code></em>, <em class="parameter"><code>lppause command </code></em>, <em class="parameter"><code>lpresume command</code></em>, and <em class="parameter"><code>lprm command</code></em> if specified in the + [global] section.</p><p>Currently nine printing styles are supported. They are + <code class="constant">BSD</code>, <code class="constant">AIX</code>, + <code class="constant">LPRNG</code>, <code class="constant">PLP</code>, + <code class="constant">SYSV</code>, <code class="constant">HPUX</code>, + <code class="constant">QNX</code>, <code class="constant">SOFTQ</code>, + and <code class="constant">CUPS</code>.</p><p>To see what the defaults are for the other print + commands when using the various options use the <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> program.</p><p>This option can be set on a per printer basis. Please be + aware however, that you must place any of the various printing + commands (e.g. print command, lpq command, etc...) after defining + the value for the <em class="parameter"><code>printing</code></em> option since it will + reset the printing commands to default values.</p><p>See also the discussion in the <a href="#PRINTERSSECT" title="The [printers] section"> + [printers]</a> section.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="PRINTJOBUSERNAME"></a>printjob username (S)</span></dt><dd><p>This parameter specifies which user information will be + passed to the printing system. Usually, the username is sent, + but in some cases, e.g. the domain prefix is useful, too.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printjob username</code></em> = <code class="literal">%U</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printjob username</code></em> = <code class="literal">%D\%U</code> +</em></span> +</p></dd><dt><span class="term"><a name="PRIVATEDIR"></a>private dir (G)</span></dt><dd><p>This parameters defines the directory + smbd will use for storing such files as <code class="filename">smbpasswd</code> + and <code class="filename">secrets.tdb</code>. +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>private dir</code></em> = <code class="literal">${prefix}/private</code> +</em></span> +</p></dd><dt><span class="term"><a name="PROFILEACLS"></a>profile acls (S)</span></dt><dd><p> + This boolean parameter was added to fix the problems that people have been + having with storing user profiles on Samba shares from Windows 2000 or + Windows XP clients. New versions of Windows 2000 or Windows XP service + packs do security ACL checking on the owner and ability to write of the + profile directory stored on a local workstation when copied from a Samba + share. + </p><p> + When not in domain mode with winbindd then the security info copied + onto the local workstation has no meaning to the logged in user (SID) on + that workstation so the profile storing fails. Adding this parameter + onto a share used for profile storage changes two things about the + returned Windows ACL. Firstly it changes the owner and group owner + of all reported files and directories to be BUILTIN\\Administrators, + BUILTIN\\Users respectively (SIDs S-1-5-32-544, S-1-5-32-545). Secondly + it adds an ACE entry of "Full Control" to the SID BUILTIN\\Users to + every returned ACL. This will allow any Windows 2000 or XP workstation + user to access the profile. + </p><p> + Note that if you have multiple users logging + on to a workstation then in order to prevent them from being able to access + each others profiles you must remove the "Bypass traverse checking" advanced + user right. This will prevent access to other users profile directories as + the top level profile directory (named after the user) is created by the + workstation profile code and has an ACL restricting entry to the directory + tree to the owning user. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>profile acls</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="QUEUEPAUSECOMMAND"></a>queuepause command (S)</span></dt><dd><p>This parameter specifies the command to be + executed on the server host in order to pause the printer queue.</p><p>This command should be a program or script which takes + a printer name as its only parameter and stops the printer queue, + such that no longer jobs are submitted to the printer.</p><p>This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name + is put in its place. Otherwise it is placed at the end of the command. + </p><p>Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>queuepause command</code></em> = <code class="literal">disable %p</code> +</em></span> +</p></dd><dt><span class="term"><a name="QUEUERESUMECOMMAND"></a>queueresume command (S)</span></dt><dd><p>This parameter specifies the command to be + executed on the server host in order to resume the printer queue. It + is the command to undo the behavior that is caused by the + previous parameter (<a class="indexterm" name="id329545"></a>queuepause command).</p><p>This command should be a program or script which takes + a printer name as its only parameter and resumes the printer queue, + such that queued jobs are resubmitted to the printer.</p><p>This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name + is put in its place. Otherwise it is placed at the end of the + command.</p><p>Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>queueresume command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>queueresume command</code></em> = <code class="literal">enable %p</code> +</em></span> +</p></dd><dt><span class="term"><a name="READLIST"></a>read list (S)</span></dt><dd><p> + This is a list of users that are given read-only access to a service. If the connecting user is in this list + then they will not be given write access, no matter what the <a class="indexterm" name="id329631"></a>read only option is set + to. The list can include group names using the syntax described in the <a class="indexterm" name="id329639"></a>invalid users + parameter. + </p><p>This parameter will not work with the <a class="indexterm" name="id329650"></a>security = share in + Samba 3.0. This is by design.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read list</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>read list</code></em> = <code class="literal">mary, @students</code> +</em></span> +</p></dd><dt><span class="term"><a name="READONLY"></a>read only (S)</span></dt><dd><p>An inverted synonym is <a class="indexterm" name="id329711"></a>writeable.</p><p>If this parameter is <code class="constant">yes</code>, then users + of a service may not create or modify files in the service's + directory.</p><p>Note that a printable service (<code class="literal">printable = yes</code>) + will <span class="emphasis"><em>ALWAYS</em></span> allow writing to the directory + (user privileges permitting), but only via spooling operations.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read only</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="READRAW"></a>read raw (G)</span></dt><dd><p>This parameter controls whether or not the server + will support the raw read SMB requests when transferring data + to clients.</p><p>If enabled, raw reads allow reads of 65535 bytes in + one packet. This typically provides a major performance benefit. + </p><p>However, some clients either negotiate the allowable + block size incorrectly or are incapable of supporting larger block + sizes, and for these clients you may need to disable raw reads.</p><p>In general this parameter should be viewed as a system tuning + tool and left severely alone.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read raw</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="REALM"></a>realm (G)</span></dt><dd><p>This option specifies the kerberos realm to use. The realm is + used as the ADS equivalent of the NT4 <code class="literal">domain</code>. It + is usually set to the DNS name of the kerberos server. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>realm</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>realm</code></em> = <code class="literal">mysambabox.mycompany.com</code> +</em></span> +</p></dd><dt><span class="term"><a name="REGISTRYSHARES"></a>registry shares (G)</span></dt><dd><p> + This turns on or off support for share definitions read from + registry. Shares defined in <span class="emphasis"><em>smb.conf</em></span> take + precedence over shares with the same name defined in + registry. See the section on registry-based configuration + for details. + </p><p> + Note that this parameter defaults to <span class="emphasis"><em>no</em></span>, + but it is set to <span class="emphasis"><em>yes</em></span> when + <em class="parameter"><code>config bakend</code></em> is set + to <span class="emphasis"><em>registry</em></span>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>registry shares</code></em> = <code class="literal">no</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>registry shares</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="REMOTEANNOUNCE"></a>remote announce (G)</span></dt><dd><p> + This option allows you to setup <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>to periodically announce itself + to arbitrary IP addresses with an arbitrary workgroup name. + </p><p> + 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. + </p><p> + For example: +</p><pre class="programlisting"> +<code class="literal">remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF</code> +</pre><p> + the above line would cause <code class="literal">nmbd</code> 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 <a class="indexterm" name="id330010"></a>workgroup parameter + is used instead. + </p><p> + 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. + </p><p> + See the chapter on Network Browsing in the Samba-HOWTO book. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>remote announce</code></em> = <code class="literal"></code> +</em></span> +</p></dd><dt><span class="term"><a name="REMOTEBROWSESYNC"></a>remote browse sync (G)</span></dt><dd><p> + This option allows you to setup <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> 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. + </p><p> + 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. + </p><p> + For example: +</p><pre class="programlisting"> +<em class="parameter"><code>remote browse sync = 192.168.2.255 192.168.4.255</code></em> +</pre><p> + the above line would cause <code class="literal">nmbd</code> to request the master browser on the + specified subnets or addresses to synchronize their browse lists with + the local server. + </p><p> + 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. + </p><p> + The <a class="indexterm" name="id330111"></a>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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>remote browse sync</code></em> = <code class="literal"></code> +</em></span> +</p></dd><dt><span class="term"><a name="RENAMEUSERSCRIPT"></a>rename user script (G)</span></dt><dd><p> + This is the full pathname to a script that will be run as root by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> under special circumstances described below. + </p><p> + When a user with admin authority or SeAddUserPrivilege rights renames a user (e.g.: from the NT4 User Manager + for Domains), this script will be run to rename the POSIX user. Two variables, <code class="literal">%uold</code> and + <code class="literal">%unew</code>, will be substituted with the old and new usernames, respectively. The script should + return 0 upon successful completion, and nonzero otherwise. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + The script has all responsibility to rename all the necessary data that is accessible in this posix method. + This can mean different requirements for different backends. The tdbsam and smbpasswd backends will take care + of the contents of their respective files, so the script is responsible only for changing the POSIX username, and + other data that may required for your circumstances, such as home directory. Please also consider whether or + not you need to rename the actual home directories themselves. The ldapsam backend will not make any changes, + because of the potential issues with renaming the LDAP naming attribute. In this case the script is + responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that + needs to change for other applications using the same directory. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>rename user script</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="RESETONZEROVC"></a>reset on zero vc (G)</span></dt><dd><p> + This boolean option controls whether an incoming session setup + should kill other connections coming from the same IP. This matches + the default Windows 2003 behaviour. + + Setting this parameter to yes becomes necessary when you have a flaky + network and windows decides to reconnect while the old connection + still has files with share modes open. These files become inaccessible + over the new connection. + + The client sends a zero VC on the new connection, and Windows 2003 + kills all other connections coming from the same IP. This way the + locked files are accessible again. + + Please be aware that enabling this option will kill connections behind + a masquerading router. + + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>reset on zero vc</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="RESTRICTANONYMOUS"></a>restrict anonymous (G)</span></dt><dd><p>The setting of this parameter determines whether user and + group list information is returned for an anonymous connection. + and mirrors the effects of the +</p><pre class="programlisting"> +HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\ + Control\LSA\RestrictAnonymous +</pre><p> + registry key in Windows 2000 and Windows NT. When set to 0, user + and group list information is returned to anyone who asks. When set + to 1, only an authenticated user can retrive user and + group list information. For the value 2, supported by + Windows 2000/XP and Samba, no anonymous connections are allowed at + all. This can break third party and Microsoft + applications which expect to be allowed to perform + operations anonymously.</p><p> + The security advantage of using restrict anonymous = 1 is dubious, + as user and group list information can be obtained using other + means. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + The security advantage of using restrict anonymous = 2 is removed + by setting <a class="indexterm" name="id330306"></a>guest ok = yes on any share. + </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>restrict anonymous</code></em> = <code class="literal">0</code> +</em></span> +</p></dd><dt><span class="term"><a name="ROOT"></a>root</span></dt><dd><p>This parameter is a synonym for root directory.</p></dd><dt><span class="term"><a name="ROOTDIR"></a>root dir</span></dt><dd><p>This parameter is a synonym for root directory.</p></dd><dt><span class="term"><a name="ROOTDIRECTORY"></a>root directory (G)</span></dt><dd><p>The server will <code class="literal">chroot()</code> (i.e. + Change its root directory) to this directory on startup. This is + not strictly necessary for secure operation. Even without it the + server will deny access to files not in one of the service entries. + It may also check for, and deny access to, soft links to other + parts of the filesystem, or attempts to use ".." in file names + to access other directories (depending on the setting of the + <a class="indexterm" name="id330408"></a>wide smbconfoptions parameter). + </p><p>Adding a <em class="parameter"><code>root directory</code></em> entry other + than "/" adds an extra level of security, but at a price. It + absolutely ensures that no access is given to files not in the + sub-tree specified in the <em class="parameter"><code>root directory</code></em> + option, <span class="emphasis"><em>including</em></span> some files needed for + complete operation of the server. To maintain full operability + of the server you will need to mirror some system files + into the <em class="parameter"><code>root directory</code></em> tree. In particular + you will need to mirror <code class="filename">/etc/passwd</code> (or a + subset of it), and any binaries or configuration files needed for + printing (if required). The set of files that must be mirrored is + operating system dependent.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root directory</code></em> = <code class="literal">/</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>root directory</code></em> = <code class="literal">/homes/smb</code> +</em></span> +</p></dd><dt><span class="term"><a name="ROOTPOSTEXEC"></a>root postexec (S)</span></dt><dd><p> + This is the same as the <em class="parameter"><code>postexec</code></em> + parameter except that the command is run as root. This is useful for + unmounting filesystems (such as CDROMs) after a connection is closed. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root postexec</code></em> = <code class="literal"></code> +</em></span> +</p></dd><dt><span class="term"><a name="ROOTPREEXEC"></a>root preexec (S)</span></dt><dd><p> + This is the same as the <em class="parameter"><code>preexec</code></em> + parameter except that the command is run as root. This is useful for + mounting filesystems (such as CDROMs) when a connection is opened. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root preexec</code></em> = <code class="literal"></code> +</em></span> +</p></dd><dt><span class="term"><a name="ROOTPREEXECCLOSE"></a>root preexec close (S)</span></dt><dd><p>This is the same as the <em class="parameter"><code>preexec close + </code></em> parameter except that the command is run as root.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root preexec close</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="SECURITY"></a>security (G)</span></dt><dd><p>This option affects how clients respond to + Samba and is one of the most important settings in the <code class="filename"> + smb.conf</code> file.</p><p>The option sets the "security mode bit" in replies to + protocol negotiations with <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to turn share level security on or off. Clients decide + based on this bit whether (and how) to transfer user and password + information to the server.</p><p>The default is <code class="literal">security = user</code>, as this is + the most common setting needed when talking to Windows 98 and + Windows NT.</p><p>The alternatives are <code class="literal">security = share</code>, + <code class="literal">security = server</code> or <code class="literal">security = domain + </code>.</p><p>In versions of Samba prior to 2.0.0, the default was + <code class="literal">security = share</code> mainly because that was + the only option at one stage.</p><p>There is a bug in WfWg that has relevance to this + setting. When in user or server level security a WfWg client + will totally ignore the username and password you type in the "connect + drive" dialog box. This makes it very difficult (if not impossible) + to connect to a Samba service as anyone except the user that + you are logged into WfWg as.</p><p>If your PCs use usernames that are the same as their + usernames on the UNIX machine then you will want to use + <code class="literal">security = user</code>. If you mostly use usernames + that don't exist on the UNIX box then use <code class="literal">security = + share</code>.</p><p>You should also use <code class="literal">security = share</code> if you + want to mainly setup shares without a password (guest shares). This + is commonly used for a shared printer server. It is more difficult + to setup guest shares with <code class="literal">security = user</code>, see + the <a class="indexterm" name="id330741"></a>map to guestparameter for details.</p><p>It is possible to use <code class="literal">smbd</code> in a <span class="emphasis"><em> + hybrid mode</em></span> where it is offers both user and share + level security under different <a class="indexterm" name="id330762"></a>NetBIOS aliases. </p><p>The different settings will now be explained.</p><p><a name="SECURITYEQUALSSHARE"></a><span class="emphasis"><em>SECURITY = SHARE</em></span></p><p>When clients connect to a share level security server they + need not log onto the server with a valid username and password before + attempting to connect to a shared resource (although modern clients + such as Windows 95/98 and Windows NT will send a logon request with + a username but no password when talking to a <code class="literal">security = share + </code> server). Instead, the clients send authentication information + (passwords) on a per-share basis, at the time they attempt to connect + to that share.</p><p>Note that <code class="literal">smbd</code> <span class="emphasis"><em>ALWAYS</em></span> + uses a valid UNIX user to act on behalf of the client, even in + <code class="literal">security = share</code> level security.</p><p>As clients are not required to send a username to the server + in share level security, <code class="literal">smbd</code> uses several + techniques to determine the correct UNIX user to use on behalf + of the client.</p><p>A list of possible UNIX usernames to match with the given + client password is constructed using the following methods :</p><div class="itemizedlist"><ul type="disc"><li><p>If the <a class="indexterm" name="id330838"></a>guest only parameter is set, then all the other + stages are missed and only the <a class="indexterm" name="id330845"></a>guest account username is checked. + </p></li><li><p>Is a username is sent with the share connection + request, then this username (after mapping - see <a class="indexterm" name="id330860"></a>username map), + is added as a potential username. + </p></li><li><p>If the client did a previous <span class="emphasis"><em>logon + </em></span> request (the SessionSetup SMB call) then the + username sent in this SMB will be added as a potential username. + </p></li><li><p>The name of the service the client requested is + added as a potential username. + </p></li><li><p>The NetBIOS name of the client is added to + the list as a potential username. + </p></li><li><p>Any users on the <a class="indexterm" name="id330900"></a>user list are added as potential usernames. + </p></li></ul></div><p>If the <em class="parameter"><code>guest only</code></em> parameter is + not set, then this list is then tried with the supplied password. + The first user for whom the password matches will be used as the + UNIX user.</p><p>If the <em class="parameter"><code>guest only</code></em> parameter is + set, or no username can be determined then if the share is marked + as available to the <em class="parameter"><code>guest account</code></em>, then this + guest user will be used, otherwise access is denied.</p><p>Note that it can be <span class="emphasis"><em>very</em></span> confusing + in share-level security as to which UNIX username will eventually + be used in granting access.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION"> + NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p><a name="SECURITYEQUALSUSER"></a><span class="emphasis"><em>SECURITY = USER</em></span></p><p>This is the default security setting in Samba 3.0. + With user-level security a client must first "log-on" with a + valid username and password (which can be mapped using the <a class="indexterm" name="id330969"></a>username map + parameter). Encrypted passwords (see the <a class="indexterm" name="id330977"></a>encrypted passwords parameter) can also + be used in this security mode. Parameters such as <a class="indexterm" name="id330985"></a>user and <a class="indexterm" name="id330992"></a>guest only if set are then applied and + may change the UNIX user to use on this connection, but only after + the user has been successfully authenticated.</p><p><span class="emphasis"><em>Note</em></span> that the name of the resource being + requested is <span class="emphasis"><em>not</em></span> sent to the server until after + the server has successfully authenticated the client. This is why + guest shares don't work in user level security without allowing + the server to automatically map unknown users into the <a class="indexterm" name="id331011"></a>guest account. + See the <a class="indexterm" name="id331019"></a>map to guest parameter for details on doing this.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p><a name="SECURITYEQUALSDOMAIN"></a><span class="emphasis"><em>SECURITY = DOMAIN</em></span></p><p>This mode will only work correctly if <a href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> has been used to add this + machine into a Windows NT Domain. It expects the <a class="indexterm" name="id331057"></a>encrypted passwords + parameter to be set to <code class="constant">yes</code>. In this + mode Samba will try to validate the username/password by passing + it to a Windows NT Primary or Backup Domain Controller, in exactly + the same way that a Windows NT Server would do.</p><p><span class="emphasis"><em>Note</em></span> that a valid UNIX user must still + exist as well as the account on the Domain Controller to allow + Samba to have a valid UNIX account to map file access to.</p><p><span class="emphasis"><em>Note</em></span> that from the client's point + of view <code class="literal">security = domain</code> is the same + as <code class="literal">security = user</code>. It only + affects how the server deals with the authentication, + it does not in any way affect what the client sees.</p><p><span class="emphasis"><em>Note</em></span> that the name of the resource being + requested is <span class="emphasis"><em>not</em></span> sent to the server until after + the server has successfully authenticated the client. This is why + guest shares don't work in user level security without allowing + the server to automatically map unknown users into the <a class="indexterm" name="id331107"></a>guest account. + See the <a class="indexterm" name="id331114"></a>map to guest parameter for details on doing this.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION"> + NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="indexterm" name="id331135"></a>password server parameter and + the <a class="indexterm" name="id331142"></a>encrypted passwords parameter.</p><p><a name="SECURITYEQUALSSERVER"></a><span class="emphasis"><em>SECURITY = SERVER</em></span></p><p> + In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an + NT box. If this fails it will revert to <code class="literal">security = user</code>. It expects the + <a class="indexterm" name="id331169"></a>encrypted passwords parameter to be set to <code class="constant">yes</code>, unless the remote + server does not support them. However note that if encrypted passwords have been negotiated then Samba cannot + revert back to checking the UNIX password file, it must have a valid <code class="filename">smbpasswd</code> file to check users against. See the chapter about the User Database in + the Samba HOWTO Collection for details on how to set this up. +</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This mode of operation has + significant pitfalls since it is more vulnerable to + man-in-the-middle attacks and server impersonation. In particular, + this mode of operation can cause significant resource consuption on + the PDC, as it must maintain an active connection for the duration + of the user's session. Furthermore, if this connection is lost, + there is no way to reestablish it, and futher authentications to the + Samba server may fail (from a single client, till it disconnects). + </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>From the client's point of + view <code class="literal">security = server</code> is the + same as <code class="literal">security = user</code>. It + only affects how the server deals with the authentication, it does + not in any way affect what the client sees.</p></div><p><span class="emphasis"><em>Note</em></span> that the name of the resource being + requested is <span class="emphasis"><em>not</em></span> sent to the server until after + the server has successfully authenticated the client. This is why + guest shares don't work in user level security without allowing + the server to automatically map unknown users into the <a class="indexterm" name="id331226"></a>guest account. + See the <a class="indexterm" name="id331234"></a>map to guest parameter for details on doing this.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION"> + NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="indexterm" name="id331255"></a>password server parameter and the + <a class="indexterm" name="id331262"></a>encrypted passwords parameter.</p><p><a name="SECURITYEQUALSADS"></a><span class="emphasis"><em>SECURITY = ADS</em></span></p><p>In this mode, Samba will act as a domain member in an ADS realm. To operate + in this mode, the machine running Samba will need to have Kerberos installed + and configured and Samba will need to be joined to the ADS realm using the + net utility. </p><p>Note that this mode does NOT make Samba operate as a Active Directory Domain + Controller. </p><p>Read the chapter about Domain Membership in the HOWTO for details.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>security</code></em> = <code class="literal">USER</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>security</code></em> = <code class="literal">DOMAIN</code> +</em></span> +</p></dd><dt><span class="term"><a name="SECURITYMASK"></a>security mask (S)</span></dt><dd><p> + This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the + UNIX permission on a file using the native NT security dialog box. + </p><p> + This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting + any bits not in this mask. Make sure not to mix up this parameter with <a class="indexterm" name="id331354"></a>force security mode, which works in a manner similar to this one but uses a logical OR instead of an AND. + </p><p> + Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the + file permissions regardless of the previous status of this bits on the file. + </p><p> + If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file. + </p><p><span class="emphasis"><em> + Note</em></span> that users who can access the Samba server through other means can easily bypass this + restriction, so it is primarily useful for standalone "appliance" systems. Administrators of + most normal systems will probably want to leave it set to <code class="constant">0777</code>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0777</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0770</code> +</em></span> +</p></dd><dt><span class="term"><a name="SERVERSCHANNEL"></a>server schannel (G)</span></dt><dd><p> + This controls whether the server offers or even demands the use of the netlogon schannel. + <a class="indexterm" name="id331438"></a>server schannel = no does not offer the schannel, <a class="indexterm" name="id331446"></a>server schannel = auto offers the schannel but does not enforce it, and <a class="indexterm" name="id331453"></a>server schannel = yes denies access if the client is not able to speak netlogon schannel. + This is only the case for Windows NT4 before SP4. + </p><p> + Please note that with this set to <code class="literal">no</code> you will have to apply the WindowsXP + <code class="filename">WinXP_SignOrSeal.reg</code> registry patch found in the docs/registry subdirectory of the Samba distribution tarball. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>server schannel</code></em> = <code class="literal">auto</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>server schannel</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="SERVERSIGNING"></a>server signing (G)</span></dt><dd><p>This controls whether the server offers or requires + the client it talks to to use SMB signing. Possible values + are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span> + and <span class="emphasis"><em>disabled</em></span>. + </p><p>When set to auto, SMB signing is offered, but not enforced. + When set to mandatory, SMB signing is required and if set + to disabled, SMB signing is not offered either.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>server signing</code></em> = <code class="literal">Disabled</code> +</em></span> +</p></dd><dt><span class="term"><a name="SERVERSTRING"></a>server string (G)</span></dt><dd><p>This controls what string will show up in the printer comment box in print + manager and next to the IPC connection in <code class="literal">net view</code>. It + can be any string that you wish to show to your users.</p><p>It also sets what will appear in browse lists next + to the machine name.</p><p>A <em class="parameter"><code>%v</code></em> will be replaced with the Samba + version number.</p><p>A <em class="parameter"><code>%h</code></em> will be replaced with the + hostname.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>server string</code></em> = <code class="literal">Samba %v</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>server string</code></em> = <code class="literal">University of GNUs Samba Server</code> +</em></span> +</p></dd><dt><span class="term"><a name="SETDIRECTORY"></a>set directory (S)</span></dt><dd><p> + If <code class="literal">set directory = no</code>, then users of the + service may not use the setdir command to change directory. + </p><p> + The <code class="literal">setdir</code> command is only implemented + in the Digital Pathworks client. See the Pathworks documentation + for details. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set directory</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="SETPRIMARYGROUPSCRIPT"></a>set primary group script (G)</span></dt><dd><p>Thanks to the Posix subsystem in NT a Windows User has a + primary group in addition to the auxiliary groups. This script + sets the primary group in the unix userdatase when an + administrator sets the primary group from the windows user + manager or when fetching a SAM with <code class="literal">net rpc + vampire</code>. <em class="parameter"><code>%u</code></em> will be replaced + with the user whose primary group is to be set. + <em class="parameter"><code>%g</code></em> will be replaced with the group to + set.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set primary group script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>set primary group script</code></em> = <code class="literal">/usr/sbin/usermod -g '%g' '%u'</code> +</em></span> +</p></dd><dt><span class="term"><a name="SETQUOTACOMMAND"></a>set quota command (G)</span></dt><dd><p>The <code class="literal">set quota command</code> should only be used + whenever there is no operating system API available from the OS that + samba can use.</p><p>This option is only available if Samba was configured with the argument <code class="literal">--with-sys-quotas</code> or + on linux when <code class="literal">./configure --with-quotas</code> was used and a working quota api + was found in the system. Most packages are configured with these options already.</p><p>This parameter should specify the path to a script that + can set quota for the specified arguments.</p><p>The specified script should take the following arguments:</p><div class="itemizedlist"><ul type="disc"><li><p>1 - quota type + </p><div class="itemizedlist"><ul type="circle"><li><p>1 - user quotas</p></li><li><p>2 - user default quotas (uid = -1)</p></li><li><p>3 - group quotas</p></li><li><p>4 - group default quotas (gid = -1)</p></li></ul></div><p> + </p></li><li><p>2 - id (uid for user, gid for group, -1 if N/A)</p></li><li><p>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</p></li><li><p>4 - block softlimit</p></li><li><p>5 - block hardlimit</p></li><li><p>6 - inode softlimit</p></li><li><p>7 - inode hardlimit</p></li><li><p>8(optional) - block size, defaults to 1024</p></li></ul></div><p>The script should output at least one line of data on success. And nothing on failure.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set quota command</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>set quota command</code></em> = <code class="literal">/usr/local/sbin/set_quota</code> +</em></span> +</p></dd><dt><span class="term"><a name="SHAREMODES"></a>share modes (S)</span></dt><dd><p>This enables or disables the honoring of + the <em class="parameter"><code>share modes</code></em> during a file open. These + modes are used by clients to gain exclusive read or write access + to a file.</p><p>These open modes are not directly supported by UNIX, so + they are simulated using shared memory, or lock files if your + UNIX doesn't support shared memory (almost all do).</p><p>The share modes that are enabled by this option are + <code class="constant">DENY_DOS</code>, <code class="constant">DENY_ALL</code>, + <code class="constant">DENY_READ</code>, <code class="constant">DENY_WRITE</code>, + <code class="constant">DENY_NONE</code> and <code class="constant">DENY_FCB</code>. + </p><p>This option gives full share compatibility and enabled + by default.</p><p>You should <span class="emphasis"><em>NEVER</em></span> turn this parameter + off as many Windows applications will break if you do so.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>share modes</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="SHORTPRESERVECASE"></a>short preserve case (S)</span></dt><dd><p> + This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of + suitable length, are created upper case, or if they are forced to be the <a class="indexterm" name="id332044"></a>default case. + This option can be use with <a class="indexterm" name="id332051"></a>preserve case = yes to permit long filenames + to retain their case, while short names are lowered. + </p><p>See the section on <a href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>short preserve case</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="SHOWADDPRINTERWIZARD"></a>show add printer wizard (G)</span></dt><dd><p>With the introduction of MS-RPC based printing support + for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will + appear on Samba hosts in the share listing. Normally this folder will + contain an icon for the MS Add Printer Wizard (APW). However, it is + possible to disable this feature regardless of the level of privilege + of the connected user.</p><p>Under normal circumstances, the Windows NT/2000 client will + open a handle on the printer server with OpenPrinterEx() asking for + Administrator privileges. If the user does not have administrative + access on the print server (i.e is not root or a member of the + <em class="parameter"><code>printer admin</code></em> group), the OpenPrinterEx() + call fails and the client makes another open call with a request for + a lower privilege level. This should succeed, however the APW + icon will not be displayed.</p><p>Disabling the <em class="parameter"><code>show add printer wizard</code></em> + parameter will always cause the OpenPrinterEx() on the server + to fail. Thus the APW icon will never be displayed. +</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This does not prevent the same user from having + administrative privilege on an individual printer.</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>show add printer wizard</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="SHUTDOWNSCRIPT"></a>shutdown script (G)</span></dt><dd><p>This a full path name to a script called by + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that should + start a shutdown procedure.</p><p>If the connected user posseses the <code class="constant">SeRemoteShutdownPrivilege</code>, + right, this command will be run as user.</p><p>The %z %t %r %f variables are expanded as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>%z</code></em> will be substituted with the + shutdown message sent to the server.</p></li><li><p><em class="parameter"><code>%t</code></em> will be substituted with the + number of seconds to wait before effectively starting the + shutdown procedure.</p></li><li><p><em class="parameter"><code>%r</code></em> will be substituted with the + switch <span class="emphasis"><em>-r</em></span>. It means reboot after shutdown + for NT.</p></li><li><p><em class="parameter"><code>%f</code></em> will be substituted with the + switch <span class="emphasis"><em>-f</em></span>. It means force the shutdown + even if applications do not respond for NT.</p></li></ul></div><p>Shutdown script example: +</p><pre class="programlisting"> +#!/bin/bash + +$time=0 +let "time/60" +let "time++" + +/sbin/shutdown $3 $4 +$time $1 & +</pre><p> + Shutdown does not return so we need to launch it in background. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>shutdown script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>shutdown script</code></em> = <code class="literal">/usr/local/samba/sbin/shutdown %m %t %r %f</code> +</em></span> +</p></dd><dt><span class="term"><a name="SMBENCRYPT"></a>smb encrypt (S)</span></dt><dd><p>This is a new feature introduced with Samba 3.2 and above. It is an + extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions. + SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt + and sign every request/response in a SMB protocol stream. When + enabled it provides a secure method of SMB/CIFS communication, + similar to an ssh protected session, but using SMB/CIFS authentication + to negotiate encryption and signing keys. Currently this is only + supported by Samba 3.2 smbclient, and hopefully soon Linux CIFSFS + and MacOS/X clients. Windows clients do not support this feature. + </p><p>This controls whether the server offers or requires + the client it talks to to use SMB encryption. Possible values + are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span> + and <span class="emphasis"><em>disabled</em></span>. This may be set on a per-share + basis, but clients may chose to encrypt the entire session, not + just traffic to a specific share. If this is set to mandatory + then all traffic to a share <span class="emphasis"><em>must</em></span> must + be encrypted once the connection has been made to the share. + The server would return "access denied" to all non-encrypted + requests on such a share. Selecting encrypted traffic reduces + throughput as smaller packet sizes must be used (no huge UNIX + style read/writes allowed) as well as the overhead of encrypting + and signing all the data. + </p><p>If SMB encryption is selected, Windows style SMB signing (see + the <a class="indexterm" name="id332354"></a>server signing option) is no longer necessary, + as the GSSAPI flags use select both signing and sealing of the data. + </p><p>When set to auto, SMB encryption is offered, but not enforced. + When set to mandatory, SMB encryption is required and if set + to disabled, SMB encryption can not be negotiated.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb encrypt</code></em> = <code class="literal">auto</code> +</em></span> +</p></dd><dt><span class="term"><a name="SMBPASSWDFILE"></a>smb passwd file (G)</span></dt><dd><p>This option sets the path to the encrypted smbpasswd file. By + default the path to the smbpasswd file is compiled into Samba.</p><p> + An example of use is: +</p><pre class="programlisting"> +smb passwd file = /etc/samba/smbpasswd +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb passwd file</code></em> = <code class="literal">${prefix}/private/smbpasswd</code> +</em></span> +</p></dd><dt><span class="term"><a name="SMBPORTS"></a>smb ports (G)</span></dt><dd><p>Specifies which ports the server should listen on for SMB traffic.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb ports</code></em> = <code class="literal">445 139</code> +</em></span> +</p></dd><dt><span class="term"><a name="SOCKETADDRESS"></a>socket address (G)</span></dt><dd><p>This option allows you to control what + address Samba will listen for connections on. This is used to + support multiple virtual interfaces on the one server, each + with a different configuration.</p><p>By default Samba will accept connections on any + address.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>socket address</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>socket address</code></em> = <code class="literal">192.168.2.20</code> +</em></span> +</p></dd><dt><span class="term"><a name="SOCKETOPTIONS"></a>socket options (G)</span></dt><dd><p>This option allows you to set socket options + to be used when talking with the client.</p><p>Socket options are controls on the networking layer + of the operating systems which allow the connection to be + tuned.</p><p>This option will typically be used to tune your Samba server + for optimal performance for your local network. There is no way + that Samba can know what the optimal parameters are for your net, + so you must experiment and choose them yourself. We strongly + suggest you read the appropriate documentation for your operating + system first (perhaps <code class="literal">man + setsockopt</code> will help).</p><p>You may find that on some systems Samba will say + "Unknown socket option" when you supply an option. This means you + either incorrectly typed it or you need to add an include file + to includes.h for your OS. If the latter is the case please + send the patch to <a href="mailto:samba-technical@samba.org" target="_top"> + samba-technical@samba.org</a>.</p><p>Any of the supported socket options may be combined + in any way you like, as long as your OS allows it.</p><p>This is the list of socket options currently settable + using this option:</p><div class="itemizedlist"><ul type="disc"><li><p>SO_KEEPALIVE</p></li><li><p>SO_REUSEADDR</p></li><li><p>SO_BROADCAST</p></li><li><p>TCP_NODELAY</p></li><li><p>IPTOS_LOWDELAY</p></li><li><p>IPTOS_THROUGHPUT</p></li><li><p>SO_SNDBUF *</p></li><li><p>SO_RCVBUF *</p></li><li><p>SO_SNDLOWAT *</p></li><li><p>SO_RCVLOWAT *</p></li></ul></div><p>Those marked with a <span class="emphasis"><em>'*'</em></span> take an integer + argument. The others can optionally take a 1 or 0 argument to enable + or disable the option, by default they will be enabled if you + don't specify 1 or 0.</p><p>To specify an argument use the syntax SOME_OPTION = VALUE + for example <code class="literal">SO_SNDBUF = 8192</code>. Note that you must + not have any spaces before or after the = sign.</p><p>If you are on a local network then a sensible option + might be:</p><p><code class="literal">socket options = IPTOS_LOWDELAY</code></p><p>If you have a local network then you could try:</p><p><code class="literal">socket options = IPTOS_LOWDELAY TCP_NODELAY</code></p><p>If you are on a wide area network then perhaps try + setting IPTOS_THROUGHPUT. </p><p>Note that several of the options may cause your Samba + server to fail completely. Use these options with caution!</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>socket options</code></em> = <code class="literal">TCP_NODELAY</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>socket options</code></em> = <code class="literal">IPTOS_LOWDELAY</code> +</em></span> +</p></dd><dt><span class="term"><a name="STATCACHE"></a>stat cache (G)</span></dt><dd><p>This parameter determines if <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will use a cache in order to + speed up case insensitive name mappings. You should never need + to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>stat cache</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="STOREDOSATTRIBUTES"></a>store dos attributes (S)</span></dt><dd><p> + If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or + READ-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such + as occurs with <a class="indexterm" name="id332794"></a>map hidden and <a class="indexterm" name="id332801"></a>map readonly). When set, DOS + attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or + directory. For no other mapping to occur as a fall-back, the parameters <a class="indexterm" name="id332810"></a>map hidden, + <a class="indexterm" name="id332817"></a>map system, <a class="indexterm" name="id332824"></a>map archive and <a class="indexterm" name="id332831"></a>map readonly must be set to off. This parameter writes the DOS attributes as a string into the extended + attribute named "user.DOSATTRIB". This extended attribute is explicitly hidden from smbd clients requesting an + EA list. On Linux the filesystem must have been mounted with the mount option user_xattr in order for + extended attributes to work, also extended attributes must be compiled into the Linux kernel. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>store dos attributes</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="STRICTALLOCATE"></a>strict allocate (S)</span></dt><dd><p>This is a boolean that controls the handling of + disk space allocation in the server. When this is set to <code class="constant">yes</code> + the server will change from UNIX behaviour of not committing real + disk storage blocks when a file is extended to the Windows behaviour + of actually forcing the disk system to allocate real storage blocks + when a file is created or extended to be a given size. In UNIX + terminology this means that Samba will stop creating sparse files. + This can be slow on some systems.</p><p>When strict allocate is <code class="constant">no</code> the server does sparse + disk block allocation when a file is extended.</p><p>Setting this to <code class="constant">yes</code> can help Samba return + out of quota messages on systems that are restricting the disk quota + of users.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict allocate</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="STRICTLOCKING"></a>strict locking (S)</span></dt><dd><p> + This is an enumerated type that controls the handling of file locking in the server. When this is set to <code class="constant">yes</code>, + the server will check every read and write access for file locks, and deny access if locks exist. This can be slow on + some systems. + </p><p> + When strict locking is set to Auto (the default), the server performs file lock checks only on non-oplocked files. + As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for + inproved performance. + </p><p> + When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them. + </p><p> + Well-behaved clients always ask for lock checks when it is important. So in the vast majority of cases, + <code class="literal">strict locking = Auto</code> or + <code class="literal">strict locking = no</code> is acceptable. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict locking</code></em> = <code class="literal">Auto</code> +</em></span> +</p></dd><dt><span class="term"><a name="STRICTSYNC"></a>strict sync (S)</span></dt><dd><p>Many Windows applications (including the Windows 98 explorer + shell) seem to confuse flushing buffer contents to disk with doing + a sync to disk. Under UNIX, a sync call forces the process to be + suspended until the kernel has ensured that all outstanding data in + kernel disk buffers has been safely stored onto stable storage. + This is very slow and should only be done rarely. Setting this + parameter to <code class="constant">no</code> (the default) means that + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> ignores the Windows + applications requests for a sync call. There is only a possibility + of losing data if the operating system itself that Samba is running + on crashes, so there is little danger in this default setting. In + addition, this fixes many performance problems that people have + reported with the new Windows98 explorer shell file copies.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict sync</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="SVCCTLLIST"></a>svcctl list (G)</span></dt><dd><p>This option defines a list of init scripts that smbd + will use for starting and stopping Unix services via the Win32 + ServiceControl API. This allows Windows administrators to + utilize the MS Management Console plug-ins to manage a + Unix server running Samba.</p><p>The administrator must create a directory + name <code class="filename">svcctl</code> in Samba's $(libdir) + and create symbolic links to the init scripts in + <code class="filename">/etc/init.d/</code>. The name of the links + must match the names given as part of the <em class="parameter"><code>svcctl list</code></em>. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>svcctl list</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>svcctl list</code></em> = <code class="literal">cups postfix portmap httpd</code> +</em></span> +</p></dd><dt><span class="term"><a name="SYNCALWAYS"></a>sync always (S)</span></dt><dd><p>This is a boolean parameter that controls + whether writes will always be written to stable storage before + the write call returns. If this is <code class="constant">no</code> then the server will be + guided by the client's request in each write call (clients can + set a bit indicating that a particular write should be synchronous). + If this is <code class="constant">yes</code> then every write will be followed by a <code class="literal">fsync() + </code> call to ensure the data is written to disk. Note that + the <em class="parameter"><code>strict sync</code></em> parameter must be set to + <code class="constant">yes</code> in order for this parameter to have + any affect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>sync always</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="SYSLOG"></a>syslog (G)</span></dt><dd><p> + This parameter maps how Samba debug messages are logged onto the system syslog logging levels. + Samba debug level zero maps onto syslog <code class="constant">LOG_ERR</code>, debug level one maps onto + <code class="constant">LOG_WARNING</code>, debug level two maps onto <code class="constant">LOG_NOTICE</code>, + debug level three maps onto LOG_INFO. All higher levels are mapped to <code class="constant">LOG_DEBUG</code>. + </p><p> + This parameter sets the threshold for sending messages to syslog. Only messages with debug + level less than this value will be sent to syslog. There still will be some + logging to log.[sn]mbd even if <span class="emphasis"><em>syslog only</em></span> is enabled. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>syslog</code></em> = <code class="literal">1</code> +</em></span> +</p></dd><dt><span class="term"><a name="SYSLOGONLY"></a>syslog only (G)</span></dt><dd><p> + If this parameter is set then Samba debug messages are logged into the system + syslog only, and not to the debug log files. There still will be some + logging to log.[sn]mbd even if <span class="emphasis"><em>syslog only</em></span> is enabled. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>syslog only</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="TEMPLATEHOMEDIR"></a>template homedir (G)</span></dt><dd><p>When filling out the user information for a Windows NT + user, the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this + parameter to fill in the home directory for that user. If the + string <em class="parameter"><code>%D</code></em> is present it + is substituted with the user's Windows NT domain name. If the + string <em class="parameter"><code>%U</code></em> is present it + is substituted with the user's Windows NT user name.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>template homedir</code></em> = <code class="literal">/home/%D/%U</code> +</em></span> +</p></dd><dt><span class="term"><a name="TEMPLATESHELL"></a>template shell (G)</span></dt><dd><p>When filling out the user information for a Windows NT + user, the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this + parameter to fill in the login shell for that user.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="TIMEOFFSET"></a>time offset (G)</span></dt><dd><p>This parameter is a setting in minutes to add + to the normal GMT to local time conversion. This is useful if + you are serving a lot of PCs that have incorrect daylight + saving time handling.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>time offset</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>time offset</code></em> = <code class="literal">60</code> +</em></span> +</p></dd><dt><span class="term"><a name="TIMESERVER"></a>time server (G)</span></dt><dd><p>This parameter determines if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> advertises itself as a time server to Windows +clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>time server</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="UNIXCHARSET"></a>unix charset (G)</span></dt><dd><p>Specifies the charset the unix machine + Samba runs on uses. Samba needs to know this in order to be able to + convert text to the charsets other SMB clients use. + </p><p>This is also the charset Samba will use when specifying arguments + to scripts that it invokes. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix charset</code></em> = <code class="literal">UTF8</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>unix charset</code></em> = <code class="literal">ASCII</code> +</em></span> +</p></dd><dt><span class="term"><a name="UNIXEXTENSIONS"></a>unix extensions (G)</span></dt><dd><p>This boolean parameter controls whether Samba + implments the CIFS UNIX extensions, as defined by HP. + These extensions enable Samba to better serve UNIX CIFS clients + by supporting features such as symbolic links, hard links, etc... + These extensions require a similarly enabled client, and are of + no current use to Windows clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix extensions</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="UNIXPASSWORDSYNC"></a>unix password sync (G)</span></dt><dd><p>This boolean parameter controls whether Samba + attempts to synchronize the UNIX password with the SMB password + when the encrypted SMB password in the smbpasswd file is changed. + If this is set to <code class="constant">yes</code> the program specified in the <em class="parameter"><code>passwd + program</code></em>parameter is called <span class="emphasis"><em>AS ROOT</em></span> - + to allow the new UNIX password to be set without access to the + old UNIX password (as the SMB password change code has no + access to the old password cleartext, only the new).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix password sync</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="UPDATEENCRYPTED"></a>update encrypted (G)</span></dt><dd><p> + This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed) + password in the smbpasswd file to be updated automatically as they log on. This option allows a site to + migrate from plaintext password authentication (users authenticate with plaintext password over the + wire, and are checked against a UNIX account atabase) to encrypted password authentication (the SMB + challenge/response authentication mechanism) without forcing all users to re-enter their passwords via + smbpasswd at the time the change is made. This is a convenience option to allow the change over to encrypted + passwords to be made over a longer period. Once all users have encrypted representations of their passwords + in the smbpasswd file this parameter should be set to <code class="constant">no</code>. + </p><p> + In order for this parameter to be operative the <a class="indexterm" name="id333687"></a>encrypt passwords parameter must + be set to <code class="constant">no</code>. The default value of <a class="indexterm" name="id333698"></a>encrypt passwords = Yes. Note: This must be set to <code class="constant">no</code> for this <a class="indexterm" name="id333709"></a>update encrypted to work. + </p><p> + Note that even when this parameter is set a user authenticating to <code class="literal">smbd</code> + must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) + passwords. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>update encrypted</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="USECLIENTDRIVER"></a>use client driver (S)</span></dt><dd><p>This parameter applies only to Windows NT/2000 + clients. It has no effect on Windows 95/98/ME clients. When + serving a printer to Windows NT/2000 clients without first installing + a valid printer driver on the Samba host, the client will be required + to install a local printer driver. From this point on, the client + will treat the print as a local printer and not a network printer + connection. This is much the same behavior that will occur + when <code class="literal">disable spoolss = yes</code>. + </p><p>The differentiating factor is that under normal + circumstances, the NT/2000 client will attempt to open the network + printer using MS-RPC. The problem is that because the client + considers the printer to be local, it will attempt to issue the + OpenPrinterEx() call requesting access rights associated with the + logged on user. If the user possesses local administator rights but + not root privilege on the Samba host (often the case), the + OpenPrinterEx() call will fail. The result is that the client will + now display an "Access Denied; Unable to connect" message + in the printer queue window (even though jobs may successfully be + printed). </p><p>If this parameter is enabled for a printer, then any attempt + to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped + to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() + call to succeed. <span class="emphasis"><em>This parameter MUST not be able enabled + on a print share which has valid print driver installed on the Samba + server.</em></span></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use client driver</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="USEKERBEROSKEYTAB"></a>use kerberos keytab (G)</span></dt><dd><p> + Specifies whether Samba should attempt to maintain service principals in the systems + keytab file for <code class="constant">host/FQDN</code> and <code class="constant">cifs/FQDN</code>. + </p><p> + When you are using the heimdal Kerberos libraries, you must also specify the following in + <code class="filename">/etc/krb5.conf</code>: +</p><pre class="programlisting"> +[libdefaults] +default_keytab_name = FILE:/etc/krb5.keytab +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use kerberos keytab</code></em> = <code class="literal">False</code> +</em></span> +</p></dd><dt><span class="term"><a name="USEMMAP"></a>use mmap (G)</span></dt><dd><p>This global parameter determines if the tdb internals of Samba can + depend on mmap working correctly on the running system. Samba requires a coherent + mmap/read-write system memory cache. Currently only HPUX does not have such a + coherent cache, and so this parameter is set to <code class="constant">no</code> by + default on HPUX. On all other systems this parameter should be left alone. This + parameter is provided to help the Samba developers track down problems with + the tdb internal code. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use mmap</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="USER"></a>user</span></dt><dd><p>This parameter is a synonym for username.</p></dd><dt><span class="term"><a name="USERS"></a>users</span></dt><dd><p>This parameter is a synonym for username.</p></dd><dt><span class="term"><a name="USERNAME"></a>username (S)</span></dt><dd><p>Multiple users may be specified in a comma-delimited + list, in which case the supplied password will be tested against + each username in turn (left to right).</p><p>The <em class="parameter"><code>username</code></em> line is needed only when + the PC is unable to supply its own username. This is the case + for the COREPLUS protocol or where your users have different WfWg + usernames to UNIX usernames. In both these cases you may also be + better using the \\server\share%user syntax instead.</p><p>The <em class="parameter"><code>username</code></em> line is not a great + solution in many cases as it means Samba will try to validate + the supplied password against each of the usernames in the + <em class="parameter"><code>username</code></em> line in turn. This is slow and + a bad idea for lots of users in case of duplicate passwords. + You may get timeouts or security breaches using this parameter + unwisely.</p><p>Samba relies on the underlying UNIX security. This + parameter does not restrict who can login, it just offers hints + to the Samba server as to what usernames might correspond to the + supplied password. Users can login as whoever they please and + they will be able to do no more damage than if they started a + telnet session. The daemon runs as the user that they log in as, + so they cannot do anything that user cannot do.</p><p>To restrict a service to a particular set of users you + can use the <a class="indexterm" name="id334024"></a>valid users parameter.</p><p>If any of the usernames begin with a '@' then the name + will be looked up first in the NIS netgroups list (if Samba + is compiled with netgroup support), followed by a lookup in + the UNIX groups database and will expand to a list of all users + in the group of that name.</p><p>If any of the usernames begin with a '+' then the name + will be looked up only in the UNIX groups database and will + expand to a list of all users in the group of that name.</p><p>If any of the usernames begin with a '&' then the name + will be looked up only in the NIS netgroups database (if Samba + is compiled with netgroup support) and will expand to a list + of all users in the netgroup group of that name.</p><p>Note that searching though a groups database can take + quite some time, and some clients may time out during the + search.</p><p>See the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT + USERNAME/PASSWORD VALIDATION</a> for more information on how + this parameter determines access to the services.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal"> +# The guest account if a guest service, + else <empty string>.</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal">fred, mary, jack, jane, @users, @pcgroup</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERNAMELEVEL"></a>username level (G)</span></dt><dd><p>This option helps Samba to try and 'guess' at + the real UNIX username, as many DOS clients send an all-uppercase + username. By default Samba tries all lowercase, followed by the + username with the first letter capitalized, and fails if the + username is not found on the UNIX machine.</p><p>If this parameter is set to non-zero the behavior changes. + This parameter is a number that specifies the number of uppercase + combinations to try while trying to determine the UNIX user name. The + higher the number the more combinations will be tried, but the slower + the discovery of usernames will be. Use this parameter when you have + strange usernames on your UNIX machine, such as <code class="constant">AstrangeUser + </code>.</p><p>This parameter is needed only on UNIX systems that have case + sensitive usernames.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username level</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username level</code></em> = <code class="literal">5</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERNAMEMAP"></a>username map (G)</span></dt><dd><p> + This option allows you to specify a file containing a mapping of usernames from the clients to the server. + This can be used for several purposes. The most common is to map usernames that users use on DOS or Windows + machines to those that the UNIX box uses. The other is to map multiple users to a single username so that they + can more easily share files. + </p><p> + Please note that for user or share mode security, the username map is applied prior to validating the user + credentials. Domain member servers (domain or ads) apply the username map after the user has been + successfully authenticated by the domain controller and require fully qualified enties in the map table (e.g. + biddle = DOMAIN\foo). + </p><p> + The map file is parsed line by line. Each line should contain a single UNIX username on the left then a '=' + followed by a list of usernames on the right. The list of usernames on the right may contain names of the form + @group in which case they will match any UNIX username in that group. The special client name '*' is a + wildcard and matches any name. Each line of the map file may be up to 1023 characters long. + </p><p> + The file is processed on each line by taking the supplied username and comparing it with each username on the + right hand side of the '=' signs. If the supplied name matches any of the names on the right hand side then it + is replaced with the name on the left. Processing then continues with the next line. + </p><p> + If any line begins with a '#' or a ';' then it is ignored. + </p><p> + If any line begins with an '!' then the processing will stop after that line if a mapping was done by the + line. Otherwise mapping continues with every line being processed. Using '!' is most useful when you have a + wildcard mapping line later in the file. + </p><p> + For example to map from the name <code class="constant">admin</code> or <code class="constant">administrator</code> to the UNIX + name <code class="constant"> root</code> you would use: +</p><pre class="programlisting"> +<code class="literal">root = admin administrator</code> +</pre><p> + Or to map anyone in the UNIX group <code class="constant">system</code> to the UNIX name <code class="constant">sys</code> you would use: +</p><pre class="programlisting"> +<code class="literal">sys = @system</code> +</pre><p> + </p><p> + You can have as many mappings as you like in a username map file. + </p><p> + If your system supports the NIS NETGROUP option then the netgroup database is checked before the <code class="filename">/etc/group </code> database for matching groups. + </p><p> + You can map Windows usernames that have spaces in them by using double quotes around the name. For example: +</p><pre class="programlisting"> +<code class="literal">tridge = "Andrew Tridgell"</code> +</pre><p> + would map the windows username "Andrew Tridgell" to the unix username "tridge". + </p><p> + The following example would map mary and fred to the unix user sys, and map the rest to guest. Note the use of the + '!' to tell Samba to stop processing if it gets a match on that line: +</p><pre class="programlisting"> +!sys = mary fred +guest = * +</pre><p> + </p><p> + Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \\server\fred and + <code class="constant">fred</code> is remapped to <code class="constant">mary</code> then you will actually be connecting to + \\server\mary and will need to supply a password suitable for <code class="constant">mary</code> not + <code class="constant">fred</code>. The only exception to this is the username passed to the <a class="indexterm" name="id334332"></a>password server (if you have one). The password server will receive whatever username the client + supplies without modification. + </p><p> + Also note that no reverse mapping is done. The main effect this has is with printing. Users who have been + mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don't own the print + job. + </p><p> + Samba versions prior to 3.0.8 would only support reading the fully qualified username (e.g.: DOMAIN\user) from + the username map when performing a kerberos login from a client. However, when looking up a map entry for a + user authenticated by NTLM[SSP], only the login name would be used for matches. This resulted in inconsistent + behavior sometimes even on the same server. + </p><p> + The following functionality is obeyed in version 3.0.8 and later: + </p><p> + When performing local authentication, the username map is applied to the login name before attempting to authenticate + the connection. + </p><p> + When relying upon a external domain controller for validating authentication requests, smbd will apply the username map + to the fully qualified username (i.e. DOMAIN\user) only after the user has been successfully authenticated. + </p><p> + An example of use is: +</p><pre class="programlisting"> +username map = /usr/local/samba/lib/users.map +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username map</code></em> = <code class="literal"> +# no username map</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERNAMEMAPSCRIPT"></a>username map script (G)</span></dt><dd><p>This script is a mutually exclusive alternative to the + <a class="indexterm" name="id334414"></a>username map parameter. This parameter + specifies and external program or script that must accept a single + command line option (the username transmitted in the authentication + request) and return a line line on standard output (the name to which + the account should mapped). In this way, it is possible to store + username map tables in an LDAP or NIS directory services. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal">/etc/samba/scripts/mapusers.sh</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERSHAREALLOWGUESTS"></a>usershare allow guests (G)</span></dt><dd><p>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 + <em class="parameter"><code>guest ok = yes</code></em> in a share + definition. Due to the security sensitive nature of this the default + is set to off.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare allow guests</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERSHAREMAXSHARES"></a>usershare max shares (G)</span></dt><dd><p>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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare max shares</code></em> = <code class="literal">0</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERSHAREOWNERONLY"></a>usershare owner only (G)</span></dt><dd><p>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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare owner only</code></em> = <code class="literal">True</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERSHAREPATH"></a>usershare path (G)</span></dt><dd><p>This parameter specifies the absolute path of the directory on the + filesystem used to store the user defined share definition files. + This directory must be owned by root, and have no access for + other, and be writable only by the group owner. In addition the + "sticky" bit must also be set, restricting rename and delete to + owners of a file (in the same way the /tmp directory is usually configured). + Members of the group owner of this directory are the users allowed to create + usershares. If this parameter is undefined then no user defined + shares are allowed. + </p><p> + For example, a valid usershare directory might be /usr/local/samba/lib/usershares, + set up as follows. + </p><p> + </p><pre class="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/ + </pre><p> + </p><p> + In this case, only members of the group "power_users" can create user defined shares. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare path</code></em> = <code class="literal">NULL</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERSHAREPREFIXALLOWLIST"></a>usershare prefix allow list (G)</span></dt><dd><p>This parameter specifies a list of absolute pathnames + the root of which are allowed to be exported by user defined share definitions. + If the pathname exported doesn't start with one of the strings in this + list the user defined share will not be allowed. This allows the Samba + administrator to restrict the directories on the system that can be + exported by user defined shares. + </p><p> + 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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare prefix allow list</code></em> = <code class="literal">NULL</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare prefix allow list</code></em> = <code class="literal">/home /data /space</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERSHAREPREFIXDENYLIST"></a>usershare prefix deny list (G)</span></dt><dd><p>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. + </p><p> + 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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare prefix deny list</code></em> = <code class="literal">NULL</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare prefix deny list</code></em> = <code class="literal">/etc /dev /private</code> +</em></span> +</p></dd><dt><span class="term"><a name="USERSHARETEMPLATESHARE"></a>usershare template share (G)</span></dt><dd><p>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. + </p><p> + 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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare template share</code></em> = <code class="literal">NULL</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare template share</code></em> = <code class="literal">template_share</code> +</em></span> +</p></dd><dt><span class="term"><a name="USESENDFILE"></a>use sendfile (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code>, and the <code class="constant">sendfile()</code> + system call is supported by the underlying operating system, then some SMB read calls + (mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that + are exclusively oplocked. This may make more efficient use of the system CPU's + and cause Samba to be faster. Samba automatically turns this off for clients + that use protocol levels lower than NT LM 0.12 and when it detects a client is + Windows 9x (using sendfile from Linux will cause these clients to fail). + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use sendfile</code></em> = <code class="literal">false</code> +</em></span> +</p></dd><dt><span class="term"><a name="USESPNEGO"></a>use spnego (G)</span></dt><dd><p>This variable controls controls whether samba will try + to use Simple and Protected NEGOciation (as specified by rfc2478) with + WindowsXP and Windows2000 clients to agree upon an authentication mechanism. +</p><p> + Unless further issues are discovered with our SPNEGO + implementation, there is no reason this should ever be + disabled.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use spnego</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="UTMP"></a>utmp (G)</span></dt><dd><p> + This boolean parameter is only available if Samba has been configured and compiled + with the option <code class="literal">--with-utmp</code>. If set to + <code class="constant">yes</code> 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. + </p><p> + 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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>utmp</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="UTMPDIRECTORY"></a>utmp directory (G)</span></dt><dd><p>This parameter is only available if Samba has + been configured and compiled with the option <code class="literal"> + --with-utmp</code>. 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 + <code class="filename">/var/run/utmp</code> on Linux).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>utmp directory</code></em> = <code class="literal"> +# Determined automatically</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>utmp directory</code></em> = <code class="literal">/var/run/utmp</code> +</em></span> +</p></dd><dt><span class="term"><a name="-VALID"></a>-valid (S)</span></dt><dd><p> 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. + </p><p> + 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. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>-valid</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="VALIDUSERS"></a>valid users (S)</span></dt><dd><p> + This is a list of users that should be allowed to login to this service. Names starting with + '@', '+' and '&' are interpreted using the same rules as described in the + <em class="parameter"><code>invalid users</code></em> parameter. + </p><p> + If this is empty (the default) then any user can login. If a username is in both this list + and the <em class="parameter"><code>invalid users</code></em> list then access is denied + for that user. + </p><p> + The current servicename is substituted for <em class="parameter"><code>%S</code></em>. + This is useful in the [homes] section. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>valid users</code></em> = <code class="literal"> +# No valid users list (anyone can login) </code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>valid users</code></em> = <code class="literal">greg, @pcusers</code> +</em></span> +</p></dd><dt><span class="term"><a name="VETOFILES"></a>veto files (S)</span></dt><dd><p> + This is a list of files and directories that are neither visible nor accessible. Each entry in + the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' + can be used to specify multiple files or directories as in DOS wildcards. + </p><p> + Each entry must be a unix path, not a DOS path and must <span class="emphasis"><em>not</em></span> include the + unix directory separator '/'. + </p><p> + Note that the <a class="indexterm" name="id335230"></a>case sensitive option is applicable in vetoing files. + </p><p> + One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when + trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this + deletion will <span class="emphasis"><em>fail</em></span> unless you also set the <a class="indexterm" name="id335247"></a>delete veto files + parameter to <em class="parameter"><code>yes</code></em>. + </p><p> + Setting this parameter will affect the performance of Samba, as it will be forced to check all files + and directories for a match as they are scanned. + </p><p> + Examples of use include: +</p><pre class="programlisting"> +; Veto any files containing the word Security, +; any ending in .tmp, and any directory containing the +; word root. +veto files = /*Security*/*.tmp/*root*/ + +; Veto the Apple specific files that a NetAtalk server +; creates. +veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>veto files</code></em> = <code class="literal">No files or directories are vetoed.</code> +</em></span> +</p></dd><dt><span class="term"><a name="VETOOPLOCKFILES"></a>veto oplock files (S)</span></dt><dd><p> + This parameter is only valid when the <a class="indexterm" name="id335315"></a>oplocks + parameter is turned on for a share. It allows the Samba administrator + to selectively turn off the granting of oplocks on selected files that + match a wildcarded list, similar to the wildcarded list used in the + <a class="indexterm" name="id335324"></a>veto files parameter. + </p><p> + You might want to do this on files that you know will be heavily contended + for by clients. A good example of this is in the NetBench SMB benchmark + program, which causes heavy client contention for files ending in + <code class="filename">.SEM</code>. To cause Samba not to grant + oplocks on these files you would use the line (either in the [global] + section or in the section for the particular NetBench share. + </p><p> + An example of use is: +</p><pre class="programlisting"> +veto oplock files = /.*SEM/ +</pre><p> + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>veto oplock files</code></em> = <code class="literal"> +# No files are vetoed for oplock grants</code> +</em></span> +</p></dd><dt><span class="term"><a name="VFSOBJECT"></a>vfs object</span></dt><dd><p>This parameter is a synonym for vfs objects.</p></dd><dt><span class="term"><a name="VFSOBJECTS"></a>vfs objects (S)</span></dt><dd><p>This parameter specifies the backend names which + are used for Samba VFS I/O operations. By default, normal + disk I/O operations are used but these can be overloaded + with one or more VFS objects. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>vfs objects</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>vfs objects</code></em> = <code class="literal">extd_audit recycle</code> +</em></span> +</p></dd><dt><span class="term"><a name="VOLUME"></a>volume (S)</span></dt><dd><p>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.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>volume</code></em> = <code class="literal"> +# the name of the share</code> +</em></span> +</p></dd><dt><span class="term"><a name="WIDELINKS"></a>wide links (S)</span></dt><dd><p>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.</p><p>Note that setting this parameter can have a negative + effect on your server performance due to the extra system calls + that Samba has to do in order to perform the link checks.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wide links</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDCACHETIME"></a>winbind cache time (G)</span></dt><dd><p>This parameter specifies the number of + seconds the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon will cache + user and group information before querying a Windows NT server + again.</p><p> + This does not apply to authentication requests, these are always + evaluated in real time unless the <a class="indexterm" name="id335568"></a>winbind offline logon option has been enabled. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind cache time</code></em> = <code class="literal">300</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDENUMGROUPS"></a>winbind enum groups (G)</span></dt><dd><p>On large installations using <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be necessary to suppress + the enumeration of groups through the <code class="literal">setgrent()</code>, + <code class="literal">getgrent()</code> and + <code class="literal">endgrent()</code> group of system calls. If + the <em class="parameter"><code>winbind enum groups</code></em> parameter is + <code class="constant">no</code>, calls to the <code class="literal">getgrent()</code> system + call will not return any data. </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Turning off group enumeration may cause some programs to behave oddly. </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind enum groups</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDENUMUSERS"></a>winbind enum users (G)</span></dt><dd><p>On large installations using <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be + necessary to suppress the enumeration of users through the <code class="literal">setpwent()</code>, + <code class="literal">getpwent()</code> and + <code class="literal">endpwent()</code> group of system calls. If + the <em class="parameter"><code>winbind enum users</code></em> parameter is + <code class="constant">no</code>, calls to the <code class="literal">getpwent</code> system call + will not return any data. </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Turning off user + enumeration may cause some programs to behave oddly. For + example, the finger program relies on having access to the + full user list when searching for matching + usernames. </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind enum users</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDEXPANDGROUPS"></a>winbind expand groups (G)</span></dt><dd><p>This option controls the maximum depth that winbindd + will traverse when flattening nested group memberships + of Windows domain groups. This is different from the + <a class="indexterm" name="id335788"></a>winbind nested groups option + which implements the Windows NT4 model of local group + nesting. The "winbind expand groups" + parameter specifically applies to the membership of + domain groups.</p><p>Be aware that a high value for this parameter can + result in system slowdown as the main parent winbindd daemon + must perform the group unrolling and will be unable to answer + incoming NSS or authentication requests during this time.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind expand groups</code></em> = <code class="literal">1</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDNESTEDGROUPS"></a>winbind nested groups (G)</span></dt><dd><p>If set to yes, this parameter activates the support for nested + groups. Nested groups are also called local groups or + aliases. They work like their counterparts in Windows: Nested + groups are defined locally on any machine (they are shared + between DC's through their SAM) and can contain users and + global groups from any trusted SAM. To be able to use nested + groups, you need to run nss_winbind.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind nested groups</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDNORMALIZENAMES"></a>winbind normalize names (G)</span></dt><dd><p>This parameter controls whether winbindd will replace + whitespace in user and group names with an underscore (_) character. + For example, whether the name "Space Kadet" should be + replaced with the string "space_kadet". + Frequently Unix shell scripts will have difficulty with usernames + contains whitespace due to the default field separator in the shell. + Do not enable this option if the underscore character is used in + account names within your domain + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind normalize names</code></em> = <code class="literal">no</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind normalize names</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDNSSINFO"></a>winbind nss info (G)</span></dt><dd><p>This parameter is designed to control how Winbind retrieves Name + Service Information to construct a user's home directory and login shell. + Currently the following settings are available: + + </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>template</code></em> + - The default, using the parameters of <em class="parameter"><code>template + shell</code></em> and <em class="parameter"><code>template homedir</code></em>) + </p></li><li><p><em class="parameter"><code>sfu</code></em> + - When Samba is running in security = ads and your Active Directory + Domain Controller does support the Microsoft "Services for Unix" (SFU) + LDAP schema, winbind can retrieve the login shell and the home + directory attributes directly from your Directory Server. Note that + retrieving UID and GID from your ADS-Server requires to + use <em class="parameter"><code>idmap backend</code></em> = ad + or <em class="parameter"><code>idmap config DOMAIN:backend</code></em> = ad + as well. + </p></li></ul></div><p> + +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind nss info</code></em> = <code class="literal">template</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind nss info</code></em> = <code class="literal">template sfu</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDOFFLINELOGON"></a>winbind offline logon (G)</span></dt><dd><p>This parameter is designed to control whether Winbind should + allow to login with the <em class="parameter"><code>pam_winbind</code></em> + module using Cached Credentials. If enabled, winbindd will store user credentials + from successful logins encrypted in a local cache. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind offline logon</code></em> = <code class="literal">false</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind offline logon</code></em> = <code class="literal">true</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDREFRESHTICKETS"></a>winbind refresh tickets (G)</span></dt><dd><p>This parameter is designed to control whether Winbind should refresh Kerberos Tickets + retrieved using the <em class="parameter"><code>pam_winbind</code></em> module. + +</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind refresh tickets</code></em> = <code class="literal">false</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind refresh tickets</code></em> = <code class="literal">true</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDRPCONLY"></a>winbind rpc only (G)</span></dt><dd><p> + Setting this parameter to <code class="literal">yes</code> forces + winbindd to use RPC instead of LDAP to retrieve information from Domain + Controllers. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind rpc only</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDSEPARATOR"></a>winbind separator (G)</span></dt><dd><p>This parameter allows an admin to define the character + used when listing a username of the form of <em class="replaceable"><code>DOMAIN + </code></em>\<em class="replaceable"><code>user</code></em>. This parameter + is only applicable when using the <code class="filename">pam_winbind.so</code> + and <code class="filename">nss_winbind.so</code> modules for UNIX services. + </p><p>Please note that setting this parameter to + causes problems + with group membership at least on glibc systems, as the character + + is used as a special character for NIS in /etc/group.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind separator</code></em> = <code class="literal">'\'</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind separator</code></em> = <code class="literal">+</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDTRUSTEDDOMAINSONLY"></a>winbind trusted domains only (G)</span></dt><dd><p> + This parameter is designed to allow Samba servers that are members + of a Samba controlled domain to use UNIX accounts distributed via NIS, + rsync, or LDAP as the uid's for winbindd users in the hosts primary domain. + Therefore, the user <code class="literal">DOMAIN\user1</code> would be mapped to + the account user1 in /etc/passwd instead of allocating a new uid for him or her. + </p><p> + This parameter is now deprecated in favor of the newer idmap_nss backend. + Refer to the <a class="indexterm" name="id336317"></a>idmap domains smb.conf option and + the <a href="idmap_nss.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_nss</span>(8)</span></a> man page for more information. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind trusted domains only</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINBINDUSEDEFAULTDOMAIN"></a>winbind use default domain (G)</span></dt><dd><p>This parameter specifies whether the + <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon should operate on users + without domain component in their username. Users without a domain + component are treated as is part of the winbindd server's own + domain. While this does not benifit Windows users, it makes SSH, FTP and + e-mail function in a way much closer to the way they + would in a native unix system.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind use default domain</code></em> = <code class="literal">no</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind use default domain</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINSHOOK"></a>wins hook (G)</span></dt><dd><p>When Samba is running as a WINS server this + allows you to call an external program for all changes to the + WINS database. The primary use for this option is to allow the + dynamic update of external name resolution databases such as + dynamic DNS.</p><p>The wins hook parameter specifies the name of a script + or executable that will be called as follows:</p><p><code class="literal">wins_hook operation name nametype ttl IP_list</code></p><div class="itemizedlist"><ul type="disc"><li><p>The first argument is the operation and is + one of "add", "delete", or + "refresh". In most cases the operation + can be ignored as the rest of the parameters + provide sufficient information. Note that + "refresh" may sometimes be called when + the name has not previously been added, in that + case it should be treated as an add.</p></li><li><p>The second argument is the NetBIOS name. If the + name is not a legal name then the wins hook is not called. + Legal names contain only letters, digits, hyphens, underscores + and periods.</p></li><li><p>The third argument is the NetBIOS name + type as a 2 digit hexadecimal number. </p></li><li><p>The fourth argument is the TTL (time to live) + for the name in seconds.</p></li><li><p>The fifth and subsequent arguments are the IP + addresses currently registered for that name. If this list is + empty then the name should be deleted.</p></li></ul></div><p>An example script that calls the BIND dynamic DNS update + program <code class="literal">nsupdate</code> is provided in the examples + directory of the Samba source code. </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="WINSPROXY"></a>wins proxy (G)</span></dt><dd><p>This is a boolean that controls if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will respond to broadcast name + queries on behalf of other hosts. You may need to set this + to <code class="constant">yes</code> for some older clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins proxy</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINSSERVER"></a>wins server (G)</span></dt><dd><p>This specifies the IP address (or DNS name: IP + address for preference) of the WINS server that <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> should register with. If you have a WINS server on + your network then you should set this to the WINS server's IP.</p><p>You should point this at your WINS server if you have a + multi-subnetted network.</p><p>If you want to work in multiple namespaces, you can + give every wins server a 'tag'. For each tag, only one + (working) server will be queried for a name. The tag should be + separated from the ip address by a colon. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>You need to set up Samba to point + to a WINS server if you have multiple subnets and wish cross-subnet + browsing to work correctly.</p></div><p>See the chapter in the Samba3-HOWTO on Network Browsing.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins server</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wins server</code></em> = <code class="literal">mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61 + +# For this example when querying a certain name, 192.19.200.1 will + be asked first and if that doesn't respond 192.168.2.61. If either + of those doesn't know the name 192.168.3.199 will be queried.</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wins server</code></em> = <code class="literal">192.9.200.1 192.168.2.61</code> +</em></span> +</p></dd><dt><span class="term"><a name="WINSSUPPORT"></a>wins support (G)</span></dt><dd><p>This boolean controls if the <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> process in Samba will act as a WINS server. You should + not set this to <code class="constant">yes</code> unless you have a multi-subnetted network and + you wish a particular <code class="literal">nmbd</code> to be your WINS server. + Note that you should <span class="emphasis"><em>NEVER</em></span> set this to <code class="constant">yes</code> + on more than one machine in your network.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins support</code></em> = <code class="literal">no</code> +</em></span> +</p></dd><dt><span class="term"><a name="WORKGROUP"></a>workgroup (G)</span></dt><dd><p>This controls what workgroup your server will + appear to be in when queried by clients. Note that this parameter + also controls the Domain name used with + the <a class="indexterm" name="id336750"></a>security = domain + setting.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>workgroup</code></em> = <code class="literal">WORKGROUP</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>workgroup</code></em> = <code class="literal">MYGROUP</code> +</em></span> +</p></dd><dt><span class="term"><a name="WRITABLE"></a>writable</span></dt><dd><p>This parameter is a synonym for writeable.</p></dd><dt><span class="term"><a name="WRITEABLE"></a>writeable (S)</span></dt><dd><p>Inverted synonym for <a class="indexterm" name="id336834"></a>read only.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="WRITECACHESIZE"></a>write cache size (S)</span></dt><dd><p>If this integer parameter is set to non-zero value, + Samba will create an in-memory cache for each oplocked file + (it does <span class="emphasis"><em>not</em></span> do this for + non-oplocked files). All writes that the client does not request + to be flushed directly to disk will be stored in this cache if possible. + The cache is flushed onto disk when a write comes in whose offset + would not fit into the cache or when the file is closed by the client. + Reads for the file are also served from this cache if the data is stored + within it.</p><p>This cache allows Samba to batch client writes into a more + efficient write size for RAID disks (i.e. writes may be tuned to + be the RAID stripe size) and can improve performance on systems + where the disk subsystem is a bottleneck but there is free + memory for userspace programs.</p><p>The integer parameter specifies the size of this cache + (per oplocked file) in bytes.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write cache size</code></em> = <code class="literal">0</code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>write cache size</code></em> = <code class="literal">262144 +# for a 256k cache size per file</code> +</em></span> +</p></dd><dt><span class="term"><a name="WRITELIST"></a>write list (S)</span></dt><dd><p> + This is a list of users that are given read-write access to a service. If the + connecting user is in this list then they will be given write access, no matter + what the <a class="indexterm" name="id336942"></a>read only option is set to. The list can + include group names using the @group syntax. + </p><p> + Note that if a user is in both the read list and the write list then they will be + given write access. + </p><p> + By design, this parameter will not work with the + <a class="indexterm" name="id336958"></a>security = share in Samba 3.0. + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write list</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>write list</code></em> = <code class="literal">admin, root, @staff</code> +</em></span> +</p></dd><dt><span class="term"><a name="WRITERAW"></a>write raw (G)</span></dt><dd><p>This parameter controls whether or not the server + will support raw write SMB's when transferring data from clients. + You should never need to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write raw</code></em> = <code class="literal">yes</code> +</em></span> +</p></dd><dt><span class="term"><a name="WTMPDIRECTORY"></a>wtmp directory (G)</span></dt><dd><p> + This parameter is only available if Samba has been configured and compiled with the option <code class="literal"> + --with-utmp</code>. 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. + </p><p> + By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually + <code class="filename">/var/run/wtmp</code> on Linux). + </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wtmp directory</code></em> = <code class="literal"></code> +</em></span> +</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wtmp directory</code></em> = <code class="literal">/var/log/wtmp</code> +</em></span> +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id337116"></a><h2>WARNINGS</h2><p> + Although the configuration file permits service names to contain spaces, your client software may not. + Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility. + </p><p> + On a similar note, many clients - especially DOS clients - limit service names to eight characters. + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has no such + limitation, but attempts to connect from such clients will fail if they truncate the service names. For this + reason you should probably keep your service names down to eight characters in length. + </p><p> + Use of the <code class="literal">[homes]</code> and <code class="literal">[printers]</code> special sections make life + for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme + care when designing these sections. In particular, ensure that the permissions on spool directories are + correct. + </p></div><div class="refsect1" lang="en"><a name="id337159"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id337169"></a><h2>SEE ALSO</h2><p> + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>, <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>, <a href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a>, <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a>, <a href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id337249"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. + </p><p> + The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion + to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by + Alexander Bokovoy. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbcacls.1.html b/docs/htmldocs/manpages/smbcacls.1.html new file mode 100644 index 0000000000..ffbf336c0b --- /dev/null +++ b/docs/htmldocs/manpages/smbcacls.1.html @@ -0,0 +1,93 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcacls</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcacls.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbcacls — Set or get ACLs on an NT file or directory names</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbcacls</code> {//server/share} {filename} [-D acls] [-M acls] [-a acls] [-S acls] [-C name] [-G name] [--numeric] [-t] [-U username] [-h] [-d]</p></div></div><div class="refsect1" lang="en"><a name="id299261"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">smbcacls</code> program manipulates NT Access Control + Lists (ACLs) on SMB file shares. </p></div><div class="refsect1" lang="en"><a name="id266723"></a><h2>OPTIONS</h2><p>The following options are available to the <code class="literal">smbcacls</code> program. + The format of ACLs is described in the section ACL FORMAT </p><div class="variablelist"><dl><dt><span class="term">-a acls</span></dt><dd><p>Add the ACLs specified to the ACL list. Existing + access control entries are unchanged. </p></dd><dt><span class="term">-M acls</span></dt><dd><p>Modify the mask value (permissions) for the ACLs + specified on the command line. An error will be printed for each + ACL specified that was not already present in the ACL list + </p></dd><dt><span class="term">-D acls</span></dt><dd><p>Delete any ACLs specified on the command line. + An error will be printed for each ACL specified that was not + already present in the ACL list. </p></dd><dt><span class="term">-S acls</span></dt><dd><p>This command sets the ACLs on the file with + only the ones specified on the command line. All other ACLs are + erased. Note that the ACL specified must contain at least a revision, + type, owner and group for the call to succeed. </p></dd><dt><span class="term">-U username</span></dt><dd><p>Specifies a username used to connect to the + specified service. The username may be of the form "username" in + which case the user is prompted to enter in a password and the + workgroup specified in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file is + used, or "username%password" or "DOMAIN\username%password" and the + password and workgroup names are used as provided. </p></dd><dt><span class="term">-C name</span></dt><dd><p>The owner of a file or directory can be changed + to the name given using the <em class="parameter"><code>-C</code></em> option. + The name can be a sid in the form S-1-x-y-z or a name resolved + against the server specified in the first argument. </p><p>This command is a shortcut for -M OWNER:name. + </p></dd><dt><span class="term">-G name</span></dt><dd><p>The group owner of a file or directory can + be changed to the name given using the <em class="parameter"><code>-G</code></em> + option. The name can be a sid in the form S-1-x-y-z or a name + resolved against the server specified n the first argument. + </p><p>This command is a shortcut for -M GROUP:name.</p></dd><dt><span class="term">--numeric</span></dt><dd><p>This option displays all ACL information in numeric + format. The default is to convert SIDs to names and ACE types + and masks to a readable string format. </p></dd><dt><span class="term">-t</span></dt><dd><p> + Don't actually do anything, only validate the correctness of + the arguments. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266940"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id267004"></a><h2>ACL FORMAT</h2><p>The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following: </p><pre class="programlisting"> +REVISION:<revision number> +OWNER:<sid or name> +GROUP:<sid or name> +ACL:<sid or name>:<type>/<flags>/<mask> +</pre><p>The revision of the ACL specifies the internal Windows + NT ACL revision for the security descriptor. + If not specified it defaults to 1. Using values other than 1 may + cause strange behaviour. </p><p>The owner and group specify the owner and group sids for the + object. If a SID in the format S-1-x-y-z is specified this is used, + otherwise the name specified is resolved using the server on which + the file or directory resides. </p><p>ACLs specify permissions granted to the SID. This SID again + can be specified in S-1-x-y-z format or as a name in which case + it is resolved against the server on which the file or directory + resides. The type, flags and mask values determine the type of + access granted to the SID. </p><p>The type can be either 0 or 1 corresponding to ALLOWED or + DENIED access to the SID. The flags values are generally + zero for file ACLs and either 9 or 2 for directory ACLs. Some + common flags are: </p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1</code></p></li><li><p><code class="constant">#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2</code></p></li><li><p><code class="constant">#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4</code></p></li><li><p><code class="constant">#define SEC_ACE_FLAG_INHERIT_ONLY 0x8</code></p></li></ul></div><p>At present flags can only be specified as decimal or + hexadecimal values.</p><p>The mask is a value which expresses the access right + granted to the SID. It can be given as a decimal or hexadecimal value, + or by using one of the following text strings which map to the NT + file permissions of the same name. </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>R</em></span> - Allow read access </p></li><li><p><span class="emphasis"><em>W</em></span> - Allow write access</p></li><li><p><span class="emphasis"><em>X</em></span> - Execute permission on the object</p></li><li><p><span class="emphasis"><em>D</em></span> - Delete the object</p></li><li><p><span class="emphasis"><em>P</em></span> - Change permissions</p></li><li><p><span class="emphasis"><em>O</em></span> - Take ownership</p></li></ul></div><p>The following combined permissions can be specified:</p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>READ</em></span> - Equivalent to 'RX' + permissions</p></li><li><p><span class="emphasis"><em>CHANGE</em></span> - Equivalent to 'RXWD' permissions + </p></li><li><p><span class="emphasis"><em>FULL</em></span> - Equivalent to 'RWXDPO' + permissions</p></li></ul></div></div><div class="refsect1" lang="en"><a name="id308009"></a><h2>EXIT STATUS</h2><p>The <code class="literal">smbcacls</code> program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values. </p><p>If the operation succeeded, smbcacls returns and exit + status of 0. If <code class="literal">smbcacls</code> couldn't connect to the specified server, + or there was an error getting or setting the ACLs, an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned. </p></div><div class="refsect1" lang="en"><a name="id308038"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308049"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p><code class="literal">smbcacls</code> was written by Andrew Tridgell + and Tim Potter.</p><p>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done + by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbclient.1.html b/docs/htmldocs/manpages/smbclient.1.html new file mode 100644 index 0000000000..e965d241a3 --- /dev/null +++ b/docs/htmldocs/manpages/smbclient.1.html @@ -0,0 +1,508 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbclient</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbclient.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbclient — ftp-like client to access SMB/CIFS resources + on servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbclient</code> [-b <buffer size>] [-d debuglevel] [-e] [-L <netbios name>] [-U username] [-I destinationIP] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-k] [-P] [-c <command>]</p></div><div class="cmdsynopsis"><p><code class="literal">smbclient</code> {servicename} [password] [-b <buffer size>] [-d debuglevel] [-e] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l log-basename] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]</p></div></div><div class="refsect1" lang="en"><a name="id266947"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbclient</code> is a client that can + 'talk' to an SMB/CIFS server. It offers an interface + similar to that of the ftp program (see <a href="ftp.1.html"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a>). + Operations include things like getting files from the server + to the local machine, putting files from the local machine to + the server, retrieving directory information from the server + and so on. </p></div><div class="refsect1" lang="en"><a name="id266984"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">servicename</span></dt><dd><p>servicename is the name of the service + you want to use on the server. A service name takes the form + <code class="filename">//server/service</code> where <em class="parameter"><code>server + </code></em> is the NetBIOS name of the SMB/CIFS server + offering the desired service and <em class="parameter"><code>service</code></em> + is the name of the service offered. Thus to connect to + the service "printer" on the SMB/CIFS server "smbserver", + you would use the servicename <code class="filename">//smbserver/printer + </code></p><p>Note that the server name required is NOT necessarily + the IP (DNS) host name of the server ! The name required is + a NetBIOS server name, which may or may not be the + same as the IP hostname of the machine running the server. + </p><p>The server name is looked up according to either + the <em class="parameter"><code>-R</code></em> parameter to <code class="literal">smbclient</code> or + using the name resolve order parameter in + the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file, + allowing an administrator to change the order and methods + by which server names are looked up. </p></dd><dt><span class="term">password</span></dt><dd><p>The password required to access the specified + service on the specified server. If this parameter is + supplied, the <em class="parameter"><code>-N</code></em> option (suppress + password prompt) is assumed. </p><p>There is no default password. If no password is supplied + on the command line (either by using this parameter or adding + a password to the <em class="parameter"><code>-U</code></em> option (see + below)) and the <em class="parameter"><code>-N</code></em> option is not + specified, the client will prompt for a password, even if + the desired service does not require one. (If no password is + required, simply press ENTER to provide a null password.) + </p><p>Note: Some servers (including OS/2 and Windows for + Workgroups) insist on an uppercase password. Lowercase + or mixed case passwords may be rejected by these servers. + </p><p>Be cautious about including passwords in scripts. + </p></dd><dt><span class="term">-R <name resolve order></span></dt><dd><p>This option is used by the programs in the Samba + suite to determine what naming services and in what order to resolve + host names to IP addresses. The option takes a space-separated + string of different name resolution options.</p><p>The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">lmhosts</code>: Lookup an IP + address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see + the <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> for details) then + any name type matches for lookup.</p></li><li><p><code class="constant">host</code>: Do a standard host + name to IP address resolution, using the system <code class="filename">/etc/hosts + </code>, NIS, or DNS lookups. This method of name resolution + is operating system dependent, for instance on IRIX or Solaris this + may be controlled by the <code class="filename">/etc/nsswitch.conf</code> + file). Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</p></li><li><p><code class="constant">wins</code>: Query a name with + the IP address listed in the <em class="parameter"><code>wins server</code></em> + parameter. If no WINS server has + been specified this method will be ignored.</p></li><li><p><code class="constant">bcast</code>: Do a broadcast on + each of the known local interfaces listed in the + <em class="parameter"><code>interfaces</code></em> + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet.</p></li></ul></div><p>If this parameter is not set then the name resolve order + defined in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file parameter + (name resolve order) will be used. </p><p>The default order is lmhosts, host, wins, bcast and without + this parameter or any entry in the <em class="parameter"><code>name resolve order + </code></em> parameter of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file the name resolution + methods will be attempted in this order. </p></dd><dt><span class="term">-M NetBIOS name</span></dt><dd><p>This options allows you to send messages, using + the "WinPopup" protocol, to another computer. Once a connection is + established you then type your message, pressing ^D (control-D) to + end. </p><p>If the receiving computer is running WinPopup the user will + receive the message and probably a beep. If they are not running + WinPopup the message will be lost, and no error message will + occur. </p><p>The message is also automatically truncated if the message + is over 1600 bytes, as this is the limit of the protocol. + </p><p> + One useful trick is to pipe the message through <code class="literal">smbclient</code>. + For example: smbclient -M FRED < mymessage.txt will send the + message in the file <code class="filename">mymessage.txt</code> to the + machine FRED. + </p><p>You may also find the <em class="parameter"><code>-U</code></em> and + <em class="parameter"><code>-I</code></em> options useful, as they allow you to + control the FROM and TO parts of the message. </p><p>See the <em class="parameter"><code>message command</code></em> parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> for a description of how to handle incoming + WinPopup messages in Samba. </p><p><span class="emphasis"><em>Note</em></span>: Copy WinPopup into the startup group + on your WfWg PCs if you want them to always be able to receive + messages. </p></dd><dt><span class="term">-p port</span></dt><dd><p>This number is the TCP port number that will be used + when making connections to the server. The standard (well-known) + TCP port number for an SMB/CIFS server is 139, which is the + default. </p></dd><dt><span class="term">-P</span></dt><dd><p> + Make queries to the external server using the machine account of the local server. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><em class="replaceable"><code>IP address</code></em> is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named + SMB/CIFS server by looking it up via the NetBIOS name resolution + mechanism described above in the <em class="parameter"><code>name resolve order</code></em> + parameter above. Using this parameter will force the client + to assume that the server is on the machine with the specified IP + address and the NetBIOS name component of the resource being + connected to will be ignored. </p><p>There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above. </p></dd><dt><span class="term">-E</span></dt><dd><p>This parameter causes the client to write messages + to the standard error stream (stderr) rather than to the standard + output stream. </p><p>By default, the client writes messages to standard output + - typically the user's tty. </p></dd><dt><span class="term">-L</span></dt><dd><p>This option allows you to look at what services + are available on a server. You use it as <code class="literal">smbclient -L + host</code> and a list should appear. The <em class="parameter"><code>-I + </code></em> option may be useful if your NetBIOS names don't + match your TCP/IP DNS host names or if you are trying to reach a + host on another network. </p></dd><dt><span class="term">-t terminal code</span></dt><dd><p>This option tells <code class="literal">smbclient</code> how to interpret + filenames coming from the remote server. Usually Asian language + multibyte UNIX implementations use different character sets than + SMB/CIFS servers (<span class="emphasis"><em>EUC</em></span> instead of <span class="emphasis"><em> + SJIS</em></span> for example). Setting this parameter will let + <code class="literal">smbclient</code> convert between the UNIX filenames and + the SMB filenames correctly. This option has not been seriously tested + and may have some problems. </p><p>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, + CWjunet, CWhex, CWcap. This is not a complete list, check the Samba + source code for the complete list. </p></dd><dt><span class="term">-b buffersize</span></dt><dd><p>This option changes the transmit/send buffer + size when getting or putting a file from/to the server. The default + is 65520 bytes. Setting this value smaller (to 1200 bytes) has been + observed to speed up file transfers to and from a Win9x server. + </p></dd><dt><span class="term">-e</span></dt><dd><p>This command line parameter requires the remote + server support the UNIX extensions. Request that the connection be + encrypted. This is new for Samba 3.2 and will only work with Samba + 3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses + the given credentials for the encryption negotiaion (either kerberos + or NTLMv1/v2 if given domain/username/password triple. Fails the + connection if encryption cannot be negotiated. + </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 1.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id308361"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.</p><p>If a password is specified on the command line and this +option is also defined the password on the command line will +be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k</span></dt><dd><p> +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +</p><pre class="programlisting"> +username = <value> +password = <value> +domain = <value> +</pre><p>Make certain that the permissions on the file restrict +access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The +client will first check the <code class="envar">USER</code> environment variable, then the +<code class="envar">LOGNAME</code> variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the <code class="literal">ps</code> command. To be safe always allow +<code class="literal">rpcclient</code> to prompt for a password and type +it in directly. </p></dd><dt><span class="term">-n <primary NetBIOS name></span></dt><dd><p>This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the <a class="indexterm" name="id308547"></a> parameter in the <code class="filename">smb.conf</code> file. +However, a command +line setting will take precedence over settings in +<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i <scope></span></dt><dd><p>This specifies a NetBIOS scope that +<code class="literal">nmblookup</code> will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +<span class="emphasis"><em>very</em></span> rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O socket options</span></dt><dd><p>TCP socket options to set on the client +socket. See the socket options parameter in +the <code class="filename">smb.conf</code> manual page for the list of valid +options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbclient may be used to create <code class="literal">tar(1) + </code> compatible backups of all the files on an SMB/CIFS + share. The secondary tar flags that can be given to this option + are : </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>c</code></em> - Create a tar file on UNIX. + Must be followed by the name of a tar file, tape device + or "-" for standard output. If using standard output you must + turn the log level to its lowest value -d0 to avoid corrupting + your tar file. This flag is mutually exclusive with the + <em class="parameter"><code>x</code></em> flag. </p></li><li><p><em class="parameter"><code>x</code></em> - Extract (restore) a local + tar file back to a share. Unless the -D option is given, the tar + files will be restored from the top level of the share. Must be + followed by the name of the tar file, device or "-" for standard + input. Mutually exclusive with the <em class="parameter"><code>c</code></em> flag. + Restored files have their creation times (mtime) set to the + date saved in the tar file. Directories currently do not get + their creation dates restored properly. </p></li><li><p><em class="parameter"><code>I</code></em> - Include files and directories. + Is the default behavior when filenames are specified above. Causes + files to be included in an extract or create (and therefore + everything else to be excluded). See example below. Filename globbing + works in one of two ways. See <em class="parameter"><code>r</code></em> below. </p></li><li><p><em class="parameter"><code>X</code></em> - Exclude files and directories. + Causes files to be excluded from an extract or create. See + example below. Filename globbing works in one of two ways now. + See <em class="parameter"><code>r</code></em> below. </p></li><li><p><em class="parameter"><code>F</code></em> - File containing a list of files and directories. + The <em class="parameter"><code>F</code></em> causes the name following the tarfile to + create to be read as a filename that contains a list of files and directories to + be included in an extract or create (and therefore everything else to be excluded). + See example below. Filename globbing works in one of two ways. + See <em class="parameter"><code>r</code></em> below. + </p></li><li><p><em class="parameter"><code>b</code></em> - Blocksize. Must be followed + by a valid (greater than zero) blocksize. Causes tar file to be + written out in blocksize*TBLOCK (usually 512 byte) blocks. + </p></li><li><p><em class="parameter"><code>g</code></em> - Incremental. Only back up + files that have the archive bit set. Useful only with the + <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>q</code></em> - Quiet. Keeps tar from printing + diagnostics as it works. This is the same as tarmode quiet. + </p></li><li><p><em class="parameter"><code>r</code></em> - Regular expression include + or exclude. Uses regular expression matching for + excluding or excluding files if compiled with HAVE_REGEX_H. + However this mode can be very slow. If not compiled with + HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. + </p></li><li><p><em class="parameter"><code>N</code></em> - Newer than. Must be followed + by the name of a file whose date is compared against files found + on the share during a create. Only files newer than the file + specified are backed up to the tar file. Useful only with the + <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>a</code></em> - Set archive bit. Causes the + archive bit to be reset when a file is backed up. Useful with the + <em class="parameter"><code>g</code></em> and <em class="parameter"><code>c</code></em> flags. + </p></li></ul></div><p><span class="emphasis"><em>Tar Long File Names</em></span></p><p><code class="literal">smbclient</code>'s tar option now supports long + file names both on backup and restore. However, the full path + name of the file must be less than 1024 bytes. Also, when + a tar archive is created, <code class="literal">smbclient</code>'s tar option places all + files in the archive with relative names, not absolute names. + </p><p><span class="emphasis"><em>Tar Filenames</em></span></p><p>All file names can be given as DOS path names (with '\\' + as the component separator) or as UNIX path names (with '/' as + the component separator). </p><p><span class="emphasis"><em>Examples</em></span></p><p>Restore from tar file <code class="filename">backup.tar</code> into myshare on mypc + (no password on share). </p><p><code class="literal">smbclient //mypc/yshare "" -N -Tx backup.tar + </code></p><p>Restore everything except <code class="filename">users/docs</code> + </p><p><code class="literal">smbclient //mypc/myshare "" -N -TXx backup.tar + users/docs</code></p><p>Create a tar file of the files beneath <code class="filename"> + users/docs</code>. </p><p><code class="literal">smbclient //mypc/myshare "" -N -Tc + backup.tar users/docs </code></p><p>Create the same tar file as above, but now use + a DOS path name. </p><p><code class="literal">smbclient //mypc/myshare "" -N -tc backup.tar + users\edocs </code></p><p>Create a tar file of the files listed in the file <code class="filename">tarlist</code>.</p><p><code class="literal">smbclient //mypc/myshare "" -N -TcF + backup.tar tarlist</code></p><p>Create a tar file of all the files and directories in + the share. </p><p><code class="literal">smbclient //mypc/myshare "" -N -Tc backup.tar * + </code></p></dd><dt><span class="term">-D initial directory</span></dt><dd><p>Change to initial directory before starting. Probably + only of any use with the tar -T option. </p></dd><dt><span class="term">-c command string</span></dt><dd><p>command string is a semicolon-separated list of + commands to be executed instead of prompting from stdin. <em class="parameter"><code> + -N</code></em> is implied by <em class="parameter"><code>-c</code></em>.</p><p>This is particularly useful in scripts and for printing stdin + to the server, e.g. <code class="literal">-c 'print -'</code>. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id309059"></a><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with + a prompt : </p><p><code class="prompt">smb:\> </code></p><p>The backslash ("\\") indicates the current working directory + on the server, and will change if the current working directory + is changed. </p><p>The prompt indicates that the client is ready and waiting to + carry out a user command. Each command is a single word, optionally + followed by parameters specific to that command. Command and parameters + are space-delimited unless these notes specifically + state otherwise. All commands are case-insensitive. Parameters to + commands may or may not be case sensitive, depending on the command. + </p><p>You can specify file names which have spaces in them by quoting + the name with double quotes, for example "a long file name". </p><p>Parameters shown in square brackets (e.g., "[parameter]") are + optional. If not given, the command will use suitable defaults. Parameters + shown in angle brackets (e.g., "<parameter>") are required. + </p><p>Note that all commands operating on the server are actually + performed by issuing a request to the server. Thus the behavior may + vary from server to server, depending on how the server was implemented. + </p><p>The commands available are given here in alphabetical order. </p><div class="variablelist"><dl><dt><span class="term">? [command]</span></dt><dd><p>If <em class="replaceable"><code>command</code></em> is specified, the ? command will display + a brief informative message about the specified command. If no + command is specified, a list of available commands will + be displayed. </p></dd><dt><span class="term">! [shell command]</span></dt><dd><p>If <em class="replaceable"><code>shell command</code></em> is specified, the ! + command will execute a shell locally and run the specified shell + command. If no command is specified, a local shell will be run. + </p></dd><dt><span class="term">allinfo file</span></dt><dd><p>The client will request that the server return + all known information about a file or directory (including streams). + </p></dd><dt><span class="term">altname file</span></dt><dd><p>The client will request that the server return + the "alternate" name (the 8.3 name) for a file or directory. + </p></dd><dt><span class="term">archive <number></span></dt><dd><p>Sets the archive level when operating on files. + 0 means ignore the archive bit, 1 means only operate on files with this bit set, + 2 means only operate on files with this bit set and reset it after operation, + 3 means operate on all files and reset it after operation. The default is 0. + </p></dd><dt><span class="term">blocksize <number></span></dt><dd><p>Sets the blocksize parameter for a tar operation. The default is 20. + Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units. + </p></dd><dt><span class="term">cancel jobid0 [jobid1] ... [jobidN]</span></dt><dd><p>The client will request that the server cancel + the printjobs identified by the given numeric print job ids. + </p></dd><dt><span class="term">case_sensitive</span></dt><dd><p>Toggles the setting of the flag in SMB packets that + tells the server to treat filenames as case sensitive. Set to OFF by + default (tells file server to treat filenames as case insensitive). Only + currently affects Samba 3.0.5 and above file servers with the case sensitive + parameter set to auto in the smb.conf. + </p></dd><dt><span class="term">cd <directory name></span></dt><dd><p>If "directory name" is specified, the current + working directory on the server will be changed to the directory + specified. This operation will fail if for any reason the specified + directory is inaccessible. </p><p>If no directory name is specified, the current working + directory on the server will be reported. </p></dd><dt><span class="term">chmod file mode in octal</span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX permissions to the given octal mode, in standard UNIX format. + </p></dd><dt><span class="term">chown file uid gid</span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX user and group ownership to the given decimal values. Note there is + currently no way to remotely look up the UNIX uid and gid values for a given name. + This may be addressed in future versions of the CIFS UNIX extensions. + </p></dd><dt><span class="term">close <fileid></span></dt><dd><p>Closes a file explicitly opened by the open command. Used for + internal Samba testing purposes. + </p></dd><dt><span class="term">del <mask></span></dt><dd><p>The client will request that the server attempt + to delete all files matching <em class="replaceable"><code>mask</code></em> from the current working + directory on the server. </p></dd><dt><span class="term">dir <mask></span></dt><dd><p>A list of the files matching <em class="replaceable"><code>mask</code></em> in the current + working directory on the server will be retrieved from the server + and displayed. </p></dd><dt><span class="term">du <filename></span></dt><dd><p>Does a directory listing and then prints out the current disk useage and free space on a share. + </p></dd><dt><span class="term">echo <number> <data></span></dt><dd><p>Does an SMBecho request to ping the server. Used for internal Samba testing purposes. + </p></dd><dt><span class="term">exit</span></dt><dd><p>Terminate the connection with the server and exit + from the program. </p></dd><dt><span class="term">get <remote file name> [local file name]</span></dt><dd><p>Copy the file called <code class="filename">remote file name</code> from + the server to the machine running the client. If specified, name + the local copy <code class="filename">local file name</code>. Note that all transfers in + <code class="literal">smbclient</code> are binary. See also the + lowercase command. </p></dd><dt><span class="term">getfacl <filename></span></dt><dd><p>Requires the server support the UNIX extensions. Requests and prints + the POSIX ACL on a file. + </p></dd><dt><span class="term">hardlink <src> <dest<</span></dt><dd><p>Creates a hardlink on the server using Windows CIFS semantics. + the POSIX ACL on a file. + </p></dd><dt><span class="term">help [command]</span></dt><dd><p>See the ? command above. </p></dd><dt><span class="term">history</span></dt><dd><p>Displays the command history.</p></dd><dt><span class="term">iosize <bytes></span></dt><dd><p>When sending or receiving files, smbclient uses an + internal memory buffer by default of size 64512 bytes. This command + allows this size to be set to any range between 16384 (0x4000) bytes + and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient + data transfer as smbclient will try and use the most efficient + read and write calls for the connected server. + </p></dd><dt><span class="term">lcd [directory name]</span></dt><dd><p>If <em class="replaceable"><code>directory name</code></em> is specified, the current + working directory on the local machine will be changed to + the directory specified. This operation will fail if for any + reason the specified directory is inaccessible. </p><p>If no directory name is specified, the name of the + current working directory on the local machine will be reported. + </p></dd><dt><span class="term">link target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a hard link between the linkname and target files. The linkname file + must not exist. + </p></dd><dt><span class="term">listconnect</span></dt><dd><p>Show the current connections held for DFS purposes. + </p></dd><dt><span class="term">lock <filenum> <r|w> <hex-start> <hex-len></span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Tries to set a POSIX + fcntl lock of the given type on the given range. Used for internal Samba testing purposes. + </p></dd><dt><span class="term">logon <username> <password></span></dt><dd><p>Establishes a new vuid for this session by logging on again. + Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes. + </p></dd><dt><span class="term">lowercase</span></dt><dd><p>Toggle lowercasing of filenames for the get and + mget commands. + </p><p>When lowercasing is toggled ON, local filenames are converted + to lowercase when using the get and mget commands. This is + often useful when copying (say) MSDOS files from a server, because + lowercase filenames are the norm on UNIX systems. </p></dd><dt><span class="term">ls <mask></span></dt><dd><p>See the dir command above. </p></dd><dt><span class="term">mask <mask></span></dt><dd><p>This command allows the user to set up a mask + which will be used during recursive operation of the mget and + mput commands. </p><p>The masks specified to the mget and mput commands act as + filters for directories rather than files when recursion is + toggled ON. </p><p>The mask specified with the mask command is necessary + to filter files within those directories. For example, if the + mask specified in an mget command is "source*" and the mask + specified with the mask command is "*.c" and recursion is + toggled ON, the mget command will retrieve all files matching + "*.c" in all directories below and including all directories + matching "source*" in the current working directory. </p><p>Note that the value for mask defaults to blank (equivalent + to "*") and remains so until the mask command is used to change it. + It retains the most recently specified value indefinitely. To + avoid unexpected results it would be wise to change the value of + mask back to "*" after using the mget or mput commands. </p></dd><dt><span class="term">md <directory name></span></dt><dd><p>See the mkdir command. </p></dd><dt><span class="term">mget <mask></span></dt><dd><p>Copy all files matching <em class="replaceable"><code>mask</code></em> from the server to + the machine running the client. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and + mask commands for more information. Note that all transfers in + <code class="literal">smbclient</code> are binary. See also the lowercase command. </p></dd><dt><span class="term">mkdir <directory name></span></dt><dd><p>Create a new directory on the server (user access + privileges permitting) with the specified name. </p></dd><dt><span class="term">more <file name></span></dt><dd><p>Fetch a remote file and view it with the contents + of your PAGER environment variable. + </p></dd><dt><span class="term">mput <mask></span></dt><dd><p>Copy all files matching <em class="replaceable"><code>mask</code></em> in the current working + directory on the local machine to the current working directory on + the server. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and mask + commands for more information. Note that all transfers in <code class="literal">smbclient</code> + are binary. </p></dd><dt><span class="term">posix</span></dt><dd><p>Query the remote server to see if it supports the CIFS UNIX + extensions and prints out the list of capabilities supported. If so, turn + on POSIX pathname processing and large file read/writes (if available),. + </p></dd><dt><span class="term">posix_encrypt <domain> <username> <password></span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Attempt to negotiate + SMB encryption on this connection. If smbclient connected with kerberos + credentials (-k) the arguments to this command are ignored and the kerberos + credentials are used to negotiate GSSAPI signing and sealing instead. See + also the -e option to smbclient to force encryption on initial connection. + This command is new with Samba 3.2. + </p></dd><dt><span class="term">posix_open <filename> <octal mode></span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Opens a remote file + using the CIFS UNIX extensions and prints a fileid. Used for internal Samba + testing purposes. + </p></dd><dt><span class="term">posix_mkdir <directoryname> <octal mode></span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Creates a remote directory + using the CIFS UNIX extensions with the given mode. + </p></dd><dt><span class="term">posix_rmdir <directoryname></span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Deletes a remote directory + using the CIFS UNIX extensions. + </p></dd><dt><span class="term">posix_unlink <filename></span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Deletes a remote file + using the CIFS UNIX extensions. + </p></dd><dt><span class="term">print <file name></span></dt><dd><p>Print the specified file from the local machine + through a printable service on the server. </p></dd><dt><span class="term">prompt</span></dt><dd><p>Toggle prompting for filenames during operation + of the mget and mput commands. </p><p>When toggled ON, the user will be prompted to confirm + the transfer of each file during these commands. When toggled + OFF, all specified files will be transferred without prompting. + </p></dd><dt><span class="term">put <local file name> [remote file name]</span></dt><dd><p>Copy the file called <code class="filename">local file name</code> from the + machine running the client to the server. If specified, + name the remote copy <code class="filename">remote file name</code>. Note that all transfers + in <code class="literal">smbclient</code> are binary. See also the lowercase command. + </p></dd><dt><span class="term">queue</span></dt><dd><p>Displays the print queue, showing the job id, + name, size and current status. </p></dd><dt><span class="term">quit</span></dt><dd><p>See the exit command. </p></dd><dt><span class="term">rd <directory name></span></dt><dd><p>See the rmdir command. </p></dd><dt><span class="term">recurse</span></dt><dd><p>Toggle directory recursion for the commands mget + and mput. </p><p>When toggled ON, these commands will process all directories + in the source directory (i.e., the directory they are copying + from ) and will recurse into any that match the mask specified + to the command. Only files that match the mask specified using + the mask command will be retrieved. See also the mask command. + </p><p>When recursion is toggled OFF, only files from the current + working directory on the source machine that match the mask specified + to the mget or mput commands will be copied, and any mask specified + using the mask command will be ignored. </p></dd><dt><span class="term">rm <mask></span></dt><dd><p>Remove all files matching <em class="replaceable"><code>mask</code></em> from the current + working directory on the server. </p></dd><dt><span class="term">rmdir <directory name></span></dt><dd><p>Remove the specified directory (user access + privileges permitting) from the server. </p></dd><dt><span class="term">setmode <filename> <perm=[+|\-]rsha></span></dt><dd><p>A version of the DOS attrib command to set + file permissions. For example: </p><p><code class="literal">setmode myfile +r </code></p><p>would make myfile read only. </p></dd><dt><span class="term">showconnect</span></dt><dd><p>Show the currently active connection held for DFS purposes. + </p></dd><dt><span class="term">stat file</span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests the + UNIX basic info level and prints out the same info that the Linux stat command + would about the file. This includes the size, blocks used on disk, file type, + permissions, inode number, number of links and finally the three timestamps + (access, modify and change). If the file is a special file (symlink, character or + block device, fifo or socket) then extra information may also be printed. + </p></dd><dt><span class="term">symlink target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a symbolic hard link between the target and linkname files. The linkname file + must not exist. Note that the server will not create a link to any path that lies + outside the currently connected share. This is enforced by the Samba server. + </p></dd><dt><span class="term">tar <c|x>[IXbgNa]</span></dt><dd><p>Performs a tar operation - see the <em class="parameter"><code>-T + </code></em> command line option above. Behavior may be affected + by the tarmode command (see below). Using g (incremental) and N + (newer) will affect tarmode settings. Note that using the "-" option + with tar x may not work - use the command line option instead. + </p></dd><dt><span class="term">blocksize <blocksize></span></dt><dd><p>Blocksize. Must be followed by a valid (greater + than zero) blocksize. Causes tar file to be written out in + <em class="replaceable"><code>blocksize</code></em>*TBLOCK (usually 512 byte) blocks. </p></dd><dt><span class="term">tarmode <full|inc|reset|noreset></span></dt><dd><p>Changes tar's behavior with regard to archive + bits. In full mode, tar will back up everything regardless of the + archive bit setting (this is the default mode). In incremental mode, + tar will only back up files with the archive bit set. In reset mode, + tar will reset the archive bit on all files it backs up (implies + read/write share). </p></dd><dt><span class="term">unlock <filenum> <hex-start> <hex-len></span></dt><dd><p>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Tries to unlock a POSIX + fcntl lock on the given range. Used for internal Samba testing purposes. + </p></dd><dt><span class="term">volume</span></dt><dd><p>Prints the current volume name of the share. + </p></dd><dt><span class="term">vuid <number></span></dt><dd><p>Changes the currently used vuid in the protocol to + the given arbitrary number. Without an argument prints out the current + vuid being used. Used for internal Samba testing purposes. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id310037"></a><h2>NOTES</h2><p>Some servers are fussy about the case of supplied usernames, + passwords, share names (AKA service names) and machine names. + If you fail to connect try giving all parameters in uppercase. + </p><p>It is often necessary to use the -n option when connecting + to some types of servers. For example OS/2 LanManager insists + on a valid NetBIOS name being used, so you need to supply a valid + name that would be known to the server.</p><p>smbclient supports long file names where the server + supports the LANMAN2 protocol or above. </p></div><div class="refsect1" lang="en"><a name="id310058"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the + username of the person using the client. This information is + used only if the protocol level is high enough to support + session-level passwords.</p><p>The variable <code class="envar">PASSWD</code> may contain + the password of the person using the client. This information is + used only if the protocol level is high enough to support + session-level passwords. </p><p>The variable <code class="envar">LIBSMB_PROG</code> may contain + the path, executed with system(), which the client should connect + to instead of connecting to a server. This functionality is primarily + intended as a development aid, and works best when using a LMHOSTS + file</p></div><div class="refsect1" lang="en"><a name="id310091"></a><h2>INSTALLATION</h2><p>The location of the client program is a matter for + individual system administrators. The following are thus + suggestions only. </p><p>It is recommended that the smbclient software be installed + in the <code class="filename">/usr/local/samba/bin/</code> or <code class="filename"> + /usr/samba/bin/</code> directory, this directory readable + by all, writeable only by root. The client program itself should + be executable by all. The client should <span class="emphasis"><em>NOT</em></span> be + setuid or setgid! </p><p>The client log files should be put in a directory readable + and writeable only by the user. </p><p>To test the client, you will need to know the name of a + running SMB/CIFS server. It is possible to run <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> as an ordinary user - running that server as a daemon + on a user-accessible port (typically any port number over 1024) + would provide a suitable test server. </p></div><div class="refsect1" lang="en"><a name="id310140"></a><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the client are logged in a + specified log file. The log file name is specified at compile time, + but may be overridden on the command line. </p><p>The number and nature of diagnostics available depends + on the debug level used by the client. If you have problems, + set the debug level to 3 and peruse the log files. </p></div><div class="refsect1" lang="en"><a name="id310156"></a><h2>VERSION</h2><p>This man page is correct for version 3.2 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id310167"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbcontrol.1.html b/docs/htmldocs/manpages/smbcontrol.1.html new file mode 100644 index 0000000000..0c092546d1 --- /dev/null +++ b/docs/htmldocs/manpages/smbcontrol.1.html @@ -0,0 +1,72 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcontrol</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcontrol.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbcontrol — send messages to smbd, nmbd or winbindd processes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbcontrol</code> [-i] [-s]</p></div><div class="cmdsynopsis"><p><code class="literal">smbcontrol</code> [destination] [message-type] [parameter]</p></div></div><div class="refsect1" lang="en"><a name="id299210"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbcontrol</code> is a very small program, which + sends messages to a <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, a <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, or a <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon running on the system.</p></div><div class="refsect1" lang="en"><a name="id299260"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-i</span></dt><dd><p>Run interactively. Individual commands + of the form destination message-type parameters can be entered + on STDIN. An empty command line or a "q" will quit the + program.</p></dd><dt><span class="term">destination</span></dt><dd><p>One of <em class="parameter"><code>nmbd</code></em>, <em class="parameter"><code>smbd</code></em> or a process ID.</p><p>The <em class="parameter"><code>smbd</code></em> destination causes the + message to "broadcast" to all smbd daemons.</p><p>The <em class="parameter"><code>nmbd</code></em> destination causes the + message to be sent to the nmbd daemon specified in the + <code class="filename">nmbd.pid</code> file.</p><p>If a single process ID is given, the message is sent + to only that process.</p></dd><dt><span class="term">message-type</span></dt><dd><p>Type of message to send. See + the section <code class="constant">MESSAGE-TYPES</code> for details. + </p></dd><dt><span class="term">parameters</span></dt><dd><p>any parameters required for the message-type</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266827"></a><h2>MESSAGE-TYPES</h2><p>Available message types are:</p><div class="variablelist"><dl><dt><span class="term">close-share</span></dt><dd><p>Order smbd to close the client + connections to the named share. Note that this doesn't affect client + connections to any other shares. This message-type takes an argument of the + share name for which client connections will be closed, or the + "*" character which will close all currently open shares. + This may be useful if you made changes to the access controls on the share. + This message can only be sent to <code class="constant">smbd</code>.</p></dd><dt><span class="term">debug</span></dt><dd><p>Set debug level to the value specified by the + parameter. This can be sent to any of the destinations.</p></dd><dt><span class="term">force-election</span></dt><dd><p>This message causes the <code class="literal">nmbd</code> daemon to + force a new browse master election. </p></dd><dt><span class="term">ping</span></dt><dd><p> + Send specified number of "ping" messages and + wait for the same number of reply "pong" messages. This can be sent to + any of the destinations.</p></dd><dt><span class="term">profile</span></dt><dd><p>Change profile settings of a daemon, based on the + parameter. The parameter can be "on" to turn on profile stats + collection, "off" to turn off profile stats collection, "count" + to enable only collection of count stats (time stats are + disabled), and "flush" to zero the current profile stats. This can + be sent to any smbd or nmbd destinations.</p></dd><dt><span class="term">debuglevel</span></dt><dd><p> + Request debuglevel of a certain daemon and write it to stdout. This + can be sent to any of the destinations.</p></dd><dt><span class="term">profilelevel</span></dt><dd><p> + Request profilelevel of a certain daemon and write it to stdout. + This can be sent to any smbd or nmbd destinations.</p></dd><dt><span class="term">printnotify</span></dt><dd><p> + Order smbd to send a printer notify message to any Windows NT clients + connected to a printer. This message-type takes the following arguments: + </p><div class="variablelist"><dl><dt><span class="term">queuepause printername</span></dt><dd><p>Send a queue pause change notify + message to the printer specified.</p></dd><dt><span class="term">queueresume printername</span></dt><dd><p>Send a queue resume change notify + message for the printer specified.</p></dd><dt><span class="term">jobpause printername unixjobid</span></dt><dd><p>Send a job pause change notify + message for the printer and unix jobid + specified.</p></dd><dt><span class="term">jobresume printername unixjobid</span></dt><dd><p>Send a job resume change notify + message for the printer and unix jobid + specified.</p></dd><dt><span class="term">jobdelete printername unixjobid</span></dt><dd><p>Send a job delete change notify + message for the printer and unix jobid + specified.</p></dd></dl></div><p> + Note that this message only sends notification that an + event has occured. It doesn't actually cause the + event to happen. + </p><p>This message can only be sent to <code class="constant">smbd</code>. </p></dd><dt><span class="term">samsync</span></dt><dd><p>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <code class="constant">smbd</code>. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Not working at the moment</p></div></dd><dt><span class="term">samrepl</span></dt><dd><p>Send sam replication message, with specified serial. Can only be sent to <code class="constant">smbd</code>. Should not be used manually.</p></dd><dt><span class="term">dmalloc-mark</span></dt><dd><p>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </p></dd><dt><span class="term">dmalloc-log-changed</span></dt><dd><p> + Dump the pointers that have changed since the mark set by dmalloc-mark. + Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </p></dd><dt><span class="term">shutdown</span></dt><dd><p>Shut down specified daemon. Can be sent to both smbd and nmbd.</p></dd><dt><span class="term">pool-usage</span></dt><dd><p>Print a human-readable description of all + talloc(pool) memory usage by the specified daemon/process. Available + for both smbd and nmbd.</p></dd><dt><span class="term">drvupgrade</span></dt><dd><p>Force clients of printers using specified driver + to update their local version of the driver. Can only be + sent to smbd.</p></dd><dt><span class="term">reload-config</span></dt><dd><p>Force daemon to reload smb.conf configuration file. Can be sent + to <code class="constant">smbd</code>, <code class="constant">nmbd</code>, or <code class="constant">winbindd</code>. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308032"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308042"></a><h2>SEE ALSO</h2><p><a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> and <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id308067"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbcquotas.1.html b/docs/htmldocs/manpages/smbcquotas.1.html new file mode 100644 index 0000000000..80dcf4b2a4 --- /dev/null +++ b/docs/htmldocs/manpages/smbcquotas.1.html @@ -0,0 +1,86 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcquotas</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcquotas.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbcquotas — Set or get QUOTAs of NTFS 5 shares</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbcquotas</code> {//server/share} [-u user] [-L] [-F] [-S QUOTA_SET_COMMAND] [-n] [-t] [-v] [-d debuglevel] [-s configfile] [-l logdir] [-V] [-U username] [-N] [-k] [-A]</p></div></div><div class="refsect1" lang="en"><a name="id266718"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">smbcquotas</code> program manipulates NT Quotas on SMB file shares. </p></div><div class="refsect1" lang="en"><a name="id266745"></a><h2>OPTIONS</h2><p>The following options are available to the <code class="literal">smbcquotas</code> program. </p><div class="variablelist"><dl><dt><span class="term">-u user</span></dt><dd><p> Specifies the user of whom the quotas are get or set. + By default the current user's username will be used.</p></dd><dt><span class="term">-L</span></dt><dd><p>Lists all quota records of the share.</p></dd><dt><span class="term">-F</span></dt><dd><p>Show the share quota status and default limits.</p></dd><dt><span class="term">-S QUOTA_SET_COMMAND</span></dt><dd><p>This command sets/modifies quotas for a user or on the share, + depending on the QUOTA_SET_COMMAND parameter which is described later.</p></dd><dt><span class="term">-n</span></dt><dd><p>This option displays all QUOTA information in numeric + format. The default is to convert SIDs to names and QUOTA limits + to a readable string format.</p></dd><dt><span class="term">-t</span></dt><dd><p> + Don't actually do anything, only validate the correctness of the arguments. + </p></dd><dt><span class="term">-v</span></dt><dd><p> + Be verbose. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266903"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.</p><p>If a password is specified on the command line and this +option is also defined the password on the command line will +be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k</span></dt><dd><p> +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +</p><pre class="programlisting"> +username = <value> +password = <value> +domain = <value> +</pre><p>Make certain that the permissions on the file restrict +access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The +client will first check the <code class="envar">USER</code> environment variable, then the +<code class="envar">LOGNAME</code> variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the <code class="literal">ps</code> command. To be safe always allow +<code class="literal">rpcclient</code> to prompt for a password and type +it in directly. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id307936"></a><h2>QUOTA_SET_COMAND</h2><p>The format of an the QUOTA_SET_COMMAND is an operation + name followed by a set of parameters specific to that operation. + </p><p>To set user quotas for the user specified by -u or for the + current username: </p><p><strong class="userinput"><code> + UQLIM:<username>:<softlimit>/<hardlimit> + </code></strong></p><p>To set the default quotas for a share: + </p><p><strong class="userinput"><code> + FSQLIM:<softlimit>/<hardlimit> + </code></strong></p><p> + To change the share quota settings: + </p><p><strong class="userinput"><code> + FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT + </code></strong></p><p>All limits are specified as a number of bytes.</p></div><div class="refsect1" lang="en"><a name="id307984"></a><h2>EXIT STATUS</h2><p>The <code class="literal">smbcquotas</code> program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values. </p><p>If the operation succeeded, smbcquotas returns an exit + status of 0. If <code class="literal">smbcquotas</code> couldn't connect to the specified server, + or when there was an error getting or setting the quota(s), an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned. </p></div><div class="refsect1" lang="en"><a name="id308013"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308024"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p><code class="literal">smbcquotas</code> was written by Stefan Metzmacher.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbd.8.html b/docs/htmldocs/manpages/smbd.8.html new file mode 100644 index 0000000000..d7aa0fcc6b --- /dev/null +++ b/docs/htmldocs/manpages/smbd.8.html @@ -0,0 +1,163 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbd — server to provide SMB/CIFS services to clients</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbd</code> [-D] [-F] [-S] [-i] [-h] [-V] [-b] [-d <debug level>] [-l <log directory>] [-p <port number(s)>] [-P <profiling level>] [-O <socket option>] [-s <configuration file>]</p></div></div><div class="refsect1" lang="en"><a name="id267087"></a><h2>DESCRIPTION</h2><p>This program is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbd</code> is the server daemon that + provides filesharing and printing services to Windows clients. + The server provides filespace and printer services to + clients using the SMB (or CIFS) protocol. This is compatible + with the LanManager protocol, and can service LanManager + clients. These include MSCLIENT 3.0 for DOS, Windows for + Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, + OS/2, DAVE for Macintosh, and smbfs for Linux.</p><p>An extensive description of the services that the + server can provide is given in the man page for the + configuration file controlling the attributes of those + services (see <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>. This man page will not describe the + services, but will concentrate on the administrative aspects + of running the server.</p><p>Please note that there are significant security + implications to running this server, and the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> manual page should be regarded as mandatory reading before + proceeding with installation.</p><p>A session is created whenever a client requests one. + Each client gets a copy of the server for each session. This + copy then services all connections made by the client during + that session. When all connections from its client are closed, + the copy of the server for that client terminates.</p><p>The configuration file, and any files that it includes, + are automatically reloaded every minute, if they change. You + can force a reload by sending a SIGHUP to the server. Reloading + the configuration file will not affect connections to any service + that is already established. Either the user will have to + disconnect from the service, or <code class="literal">smbd</code> killed and restarted.</p></div><div class="refsect1" lang="en"><a name="id299258"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-D</span></dt><dd><p>If specified, this parameter causes + the server to operate as a daemon. That is, it detaches + itself and runs in the background, fielding requests + on the appropriate port. Operating the server as a + daemon is the recommended way of running <code class="literal">smbd</code> for + servers that provide more than casual use file and + print services. This switch is assumed if <code class="literal">smbd + </code> is executed on the command line of a shell. + </p></dd><dt><span class="term">-F</span></dt><dd><p>If specified, this parameter causes + the main <code class="literal">smbd</code> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <code class="literal">smbd</code> under process supervisors such + as <code class="literal">supervise</code> and <code class="literal">svscan</code> + from Daniel J. Bernstein's <code class="literal">daemontools</code> + package, or the AIX process monitor. + </p></dd><dt><span class="term">-S</span></dt><dd><p>If specified, this parameter causes + <code class="literal">smbd</code> to log to standard output rather + than a file.</p></dd><dt><span class="term">-i</span></dt><dd><p>If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the + server is executed on the command line of a shell. Setting this + parameter negates the implicit deamon mode when run from the + command line. <code class="literal">smbd</code> also logs to standard + output, as if the <code class="literal">-S</code> parameter had been + given. + </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266843"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-b</span></dt><dd><p>Prints information about how + Samba was built.</p></dd><dt><span class="term">-p|--port<port number(s)></span></dt><dd><p><em class="replaceable"><code>port number(s)</code></em> is a + space or comma-separated list of TCP ports smbd should listen on. + The default value is taken from the <a class="indexterm" name="id307893"></a>ports parameter in <code class="filename">smb.conf</code></p><p>The default ports are 139 (used for SMB over NetBIOS over TCP) + and port 445 (used for plain SMB over TCP). + </p></dd><dt><span class="term">-P|--profiling-level<profiling level></span></dt><dd><p><em class="replaceable"><code>profiling level</code></em> is a + number specifying the level of profiling data to be collected. + 0 turns off profiling, 1 turns on counter profiling only, + 2 turns on complete profiling, and 3 resets all profiling data. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id307926"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/inetd.conf</code></span></dt><dd><p>If the server is to be run by the + <code class="literal">inetd</code> meta-daemon, this file + must contain suitable startup information for the + meta-daemon. + </p></dd><dt><span class="term"><code class="filename">/etc/rc</code></span></dt><dd><p>or whatever initialization script your + system uses).</p><p>If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server. </p></dd><dt><span class="term"><code class="filename">/etc/services</code></span></dt><dd><p>If running the server via the + meta-daemon <code class="literal">inetd</code>, this file + must contain a mapping of service name (e.g., netbios-ssn) + to service port (e.g., 139) and protocol type (e.g., tcp). + </p></dd><dt><span class="term"><code class="filename">/usr/local/samba/lib/smb.conf</code></span></dt><dd><p>This is the default location of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> server configuration file. Other common places that systems + install this file are <code class="filename">/usr/samba/lib/smb.conf</code> + and <code class="filename">/etc/samba/smb.conf</code>.</p><p>This file describes all the services the server + is to make available to clients. See <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> for more information.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308046"></a><h2>LIMITATIONS</h2><p>On some systems <code class="literal">smbd</code> cannot change uid back + to root after a setuid() call. Such systems are called + trapdoor uid systems. If you have such a system, + you will be unable to connect from a client (such as a PC) as + two different users at once. Attempts to connect the + second user will result in access denied or + similar.</p></div><div class="refsect1" lang="en"><a name="id308065"></a><h2>ENVIRONMENT VARIABLES</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">PRINTER</code></span></dt><dd><p>If no printer name is specified to + printable services, most systems will use the value of + this variable (or <code class="constant">lp</code> if this variable is + not defined) as the name of the printer to use. This + is not specific to the server, however.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308092"></a><h2>PAM INTERACTION</h2><p>Samba uses PAM for authentication (when presented with a plaintext + password), for account checking (is this account disabled?) and for + session management. The degree too which samba supports PAM is restricted + by the limitations of the SMB protocol and the <a class="indexterm" name="id308102"></a>obey pam restrictions <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> paramater. When this is set, the following restrictions apply: + </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>Account Validation</em></span>: All accesses to a + samba server are checked + against PAM to see if the account is vaild, not disabled and is permitted to + login at this time. This also applies to encrypted logins. + </p></li><li><p><span class="emphasis"><em>Session Management</em></span>: When not using share + level secuirty, users must pass PAM's session checks before access + is granted. Note however, that this is bypassed in share level secuirty. + Note also that some older pam configuration files may need a line + added for session support. + </p></li></ul></div></div><div class="refsect1" lang="en"><a name="id308141"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308151"></a><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the server are logged + in a specified log file. The log file name is specified + at compile time, but may be overridden on the command line.</p><p>The number and nature of diagnostics available depends + on the debug level used by the server. If you have problems, set + the debug level to 3 and peruse the log files.</p><p>Most messages are reasonably self-explanatory. Unfortunately, + at the time this man page was created, there are too many diagnostics + available in the source code to warrant describing each and every + diagnostic. At this stage your best bet is still to grep the + source code and inspect the conditions that gave rise to the + diagnostics you are seeing.</p></div><div class="refsect1" lang="en"><a name="id308174"></a><h2>TDB FILES</h2><p>Samba stores it's data in several TDB (Trivial Database) files, usually located in <code class="filename">/var/lib/samba</code>.</p><p> + (*) information persistent across restarts (but not + necessarily important to backup). + </p><div class="variablelist"><dl><dt><span class="term">account_policy.tdb*</span></dt><dd><p>NT account policy settings such as pw expiration, etc...</p></dd><dt><span class="term">brlock.tdb</span></dt><dd><p>byte range locks</p></dd><dt><span class="term">browse.dat</span></dt><dd><p>browse lists</p></dd><dt><span class="term">connections.tdb</span></dt><dd><p>share connections (used to enforce max connections, etc...)</p></dd><dt><span class="term">gencache.tdb</span></dt><dd><p>generic caching db</p></dd><dt><span class="term">group_mapping.tdb*</span></dt><dd><p>group mapping information</p></dd><dt><span class="term">locking.tdb</span></dt><dd><p>share modes & oplocks</p></dd><dt><span class="term">login_cache.tdb*</span></dt><dd><p>bad pw attempts</p></dd><dt><span class="term">messages.tdb</span></dt><dd><p>Samba messaging system</p></dd><dt><span class="term">netsamlogon_cache.tdb*</span></dt><dd><p>cache of user net_info_3 struct from net_samlogon() request (as a domain member)</p></dd><dt><span class="term">ntdrivers.tdb*</span></dt><dd><p>installed printer drivers</p></dd><dt><span class="term">ntforms.tdb*</span></dt><dd><p>installed printer forms</p></dd><dt><span class="term">ntprinters.tdb*</span></dt><dd><p>installed printer information</p></dd><dt><span class="term">printing/</span></dt><dd><p>directory containing tdb per print queue of cached lpq output</p></dd><dt><span class="term">registry.tdb</span></dt><dd><p>Windows registry skeleton (connect via regedit.exe)</p></dd><dt><span class="term">sessionid.tdb</span></dt><dd><p>session information (e.g. support for 'utmp = yes')</p></dd><dt><span class="term">share_info.tdb*</span></dt><dd><p>share acls</p></dd><dt><span class="term">winbindd_cache.tdb</span></dt><dd><p>winbindd's cache of user lists, etc...</p></dd><dt><span class="term">winbindd_idmap.tdb*</span></dt><dd><p>winbindd's local idmap db</p></dd><dt><span class="term">wins.dat*</span></dt><dd><p>wins database when 'wins support = yes'</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308406"></a><h2>SIGNALS</h2><p>Sending the <code class="literal">smbd</code> a SIGHUP will cause it to + reload its <code class="filename">smb.conf</code> configuration + file within a short period of time.</p><p>To shut down a user's <code class="literal">smbd</code> process it is recommended + that <code class="literal">SIGKILL (-9)</code> <span class="emphasis"><em>NOT</em></span> + be used, except as a last resort, as this may leave the shared + memory area in an inconsistent state. The safe way to terminate + an <code class="literal">smbd</code> is to send it a SIGTERM (-15) signal and wait for + it to die on its own.</p><p>The debug log level of <code class="literal">smbd</code> may be raised + or lowered using <a href="smbcontrol.1.html"><span class="citerefentry"><span class="refentrytitle">smbcontrol</span>(1)</span></a> program (SIGUSR[1|2] signals are no longer + used since Samba 2.2). This is to allow transient problems to be diagnosed, + whilst still running at a normally low log level.</p><p>Note that as the signal handlers send a debug write, + they are not re-entrant in <code class="literal">smbd</code>. This you should wait until + <code class="literal">smbd</code> is in a state of waiting for an incoming SMB before + issuing them. It is possible to make the signal handlers safe + by un-blocking the signals before the select call and re-blocking + them after, however this would affect performance.</p></div><div class="refsect1" lang="en"><a name="id308492"></a><h2>SEE ALSO</h2><p><a href="hosts_access.5.html"><span class="citerefentry"><span class="refentrytitle">hosts_access</span>(5)</span></a>, <a href="inetd.8.html"><span class="citerefentry"><span class="refentrytitle">inetd</span>(8)</span></a>, <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a>, <a href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a>, and the + Internet RFC's <code class="filename">rfc1001.txt</code>, <code class="filename">rfc1002.txt</code>. + In addition the CIFS (formerly SMB) specification is available + as a link from the Web page <a href="http://samba.org/cifs/" target="_top"> + http://samba.org/cifs/</a>.</p></div><div class="refsect1" lang="en"><a name="id308576"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbget.1.html b/docs/htmldocs/manpages/smbget.1.html new file mode 100644 index 0000000000..ebe9e9419e --- /dev/null +++ b/docs/htmldocs/manpages/smbget.1.html @@ -0,0 +1,26 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbget</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbget.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbget — wget-like utility for download files over SMB</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbget</code> [-a, --guest] [-r, --resume] [-R, --recursive] [-u, --username=STRING] [-p, --password=STRING] [-w, --workgroup=STRING] [-n, --nonprompt] [-d, --debuglevel=INT] [-D, --dots] [-P, --keep-permissions] [-o, --outputfile] [-f, --rcfile] [-q, --quiet] [-v, --verbose] [-b, --blocksize] [-?, --help] [--usage] {smb://host/share/path/to/file} [smb://url2/] [...]</p></div></div><div class="refsect1" lang="en"><a name="id266750"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>smbget is a simple utility with wget-like semantics, that can download files from SMB servers. You can specify the files you would like to download on the command-line. + </p><p> + The files should be in the smb-URL standard, e.g. use smb://host/share/file + for the UNC path <span class="emphasis"><em>\\\\HOST\\SHARE\\file</em></span>. + </p></div><div class="refsect1" lang="en"><a name="id266781"></a><h2>OPTIONS</h2><dt><span class="term">-a, --guest</span></dt><dd><p>Work as user guest</p></dd><dt><span class="term">-r, --resume</span></dt><dd><p>Automatically resume aborted files</p></dd><dt><span class="term">-R, --recursive</span></dt><dd><p>Recursively download files</p></dd><dt><span class="term">-u, --username=STRING</span></dt><dd><p>Username to use</p></dd><dt><span class="term">-p, --password=STRING</span></dt><dd><p>Password to use</p></dd><dt><span class="term">-w, --workgroup=STRING</span></dt><dd><p>Workgroup to use (optional)</p></dd><dt><span class="term">-n, --nonprompt</span></dt><dd><p>Don't ask anything (non-interactive)</p></dd><dt><span class="term">-d, --debuglevel=INT</span></dt><dd><p>Debuglevel to use</p></dd><dt><span class="term">-D, --dots</span></dt><dd><p>Show dots as progress indication</p></dd><dt><span class="term">-P, --keep-permissions</span></dt><dd><p>Set same permissions on local file as are set on remote file.</p></dd><dt><span class="term">-o, --outputfile</span></dt><dd><p>Write the file that is being download to the specified file. Can not be used together with -R.</p></dd><dt><span class="term">-f, --rcfile</span></dt><dd><p>Use specified rcfile. This will be loaded in the order it was specified - e.g. if you specify any options before this one, they might get overriden by the contents of the rcfile.</p></dd><dt><span class="term">-q, --quiet</span></dt><dd><p>Be quiet</p></dd><dt><span class="term">-v, --verbose</span></dt><dd><p>Be verbose</p></dd><dt><span class="term">-b, --blocksize</span></dt><dd><p>Number of bytes to download in a block. Defaults to 64000.</p></dd><dt><span class="term">-?, --help</span></dt><dd><p>Show help message</p></dd><dt><span class="term">--usage</span></dt><dd><p>Display brief usage message</p></dd></div><div class="refsect1" lang="en"><a name="id267003"></a><h2>SMB URLS</h2><p> SMB URL's should be specified in the following format:</p><pre class="programlisting"> +smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]] +</pre><pre class="programlisting"> +smb:// means all the workgroups +</pre><pre class="programlisting"> +smb://name/ means, if <em class="replaceable"><code>name</code></em> is a workgroup, all the servers in this workgroup, or if <em class="replaceable"><code>name</code></em> is a server, all the shares on this server. +</pre></div><div class="refsect1" lang="en"><a name="id307898"></a><h2>EXAMPLES</h2><pre class="programlisting"> +# Recursively download 'src' directory +smbget -R smb://rhonwyn/jelmer/src +# Download FreeBSD ISO and enable resuming +smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso +# Recursively download all ISOs +smbget -Rr smb://rhonwyn/isos +# Backup my data on rhonwyn +smbget -Rr smb://rhonwyn/ +</pre></div><div class="refsect1" lang="en"><a name="id307912"></a><h2>BUGS</h2><p>Permission denied is returned in some cases where the cause of the error is unknown +(such as an illegally formatted smb:// url or trying to get a directory without -R +turned on).</p></div><div class="refsect1" lang="en"><a name="id307923"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id307934"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The smbget manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbgetrc.5.html b/docs/htmldocs/manpages/smbgetrc.5.html new file mode 100644 index 0000000000..ecc95a8ec3 --- /dev/null +++ b/docs/htmldocs/manpages/smbgetrc.5.html @@ -0,0 +1,17 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbgetrc</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbgetrc.5"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbgetrc — configuration file for smbget</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename">smbgetrc</code></p></div><div class="refsect1" lang="en"><a name="id267669"></a><h2>DESCRIPTION</h2><p> + This manual page documents the format and options of the <span class="emphasis"><em>smbgetrc</em></span> + file. This is the configuration file used by the <a href="smbget.1.html"><span class="citerefentry"><span class="refentrytitle">smbget</span>(1)</span></a> + utility. The file contains of key-value pairs, one pair on each line. The key + and value should be separated by a space. + </p><p>By default, smbget reads its configuration from <span class="emphasis"><em>$HOME/.smbgetrc</em></span>, though + other locations can be specified using the command-line options.</p></div><div class="refsect1" lang="en"><a name="id267698"></a><h2>OPTIONS</h2><p> + The following keys can be set: +</p><div class="variablelist"><dl><dt><span class="term">resume on|off</span></dt><dd><p> + Whether aborted downloads should be automatically resumed. + </p></dd><dt><span class="term">recursive on|off</span></dt><dd><p>Whether directories should be downloaded recursively</p></dd><dt><span class="term">username <em class="replaceable"><code>name</code></em></span></dt><dd><p>Username to use when logging in to the remote server. Use an empty string for anonymous access. + </p></dd><dt><span class="term">password <em class="replaceable"><code>pass</code></em></span></dt><dd><p>Password to use when logging in.</p></dd><dt><span class="term">workgroup <em class="replaceable"><code>wg</code></em></span></dt><dd><p>Workgroup to use when logging in</p></dd><dt><span class="term">nonprompt on|off</span></dt><dd><p>Turns off asking for username and password. Useful for scripts.</p></dd><dt><span class="term">debuglevel <em class="replaceable"><code>int</code></em></span></dt><dd><p>(Samba) debuglevel to run at. Useful for tracking down protocol level problems.</p></dd><dt><span class="term">dots on|off</span></dt><dd><p>Whether a single dot should be printed for each block that has been downloaded, instead of the default progress indicator.</p></dd><dt><span class="term">blocksize <em class="replaceable"><code>int</code></em></span></dt><dd><p>Number of bytes to put in a block. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266742"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266752"></a><h2>SEE ALSO</h2><p><a href="smbget.1.html"><span class="citerefentry"><span class="refentrytitle">smbget</span>(1)</span></a> and <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a>. + </p></div><div class="refsect1" lang="en"><a name="id266777"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>This manual page was written by Jelmer Vernooij</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbmnt.8.html b/docs/htmldocs/manpages/smbmnt.8.html new file mode 100644 index 0000000000..2706d6f556 --- /dev/null +++ b/docs/htmldocs/manpages/smbmnt.8.html @@ -0,0 +1,24 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbmnt</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbmnt.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbmnt — helper utility for mounting SMB filesystems</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbmnt</code> {mount-point} [-s <share>] [-r] [-u <uid>] [-g <gid>] [-f <mask>] [-d <mask>] [-o <options>] [-h]</p></div></div><div class="refsect1" lang="en"><a name="id299231"></a><h2>DESCRIPTION</h2><p><code class="literal">smbmnt</code> is a helper application used + by the smbmount program to do the actual mounting of SMB shares. + <code class="literal">smbmnt</code> can be installed setuid root if you want + normal users to be able to mount their SMB shares.</p><p>A setuid smbmnt will only allow mounts on directories owned + by the user, and that the user has write permission on.</p><p>The <code class="literal">smbmnt</code> program is normally invoked + by <a href="smbmount.8.html"><span class="citerefentry"><span class="refentrytitle">smbmount</span>(8)</span></a>. It should not be invoked directly by users. </p><p>smbmount searches the normal PATH for smbmnt. You must ensure + that the smbmnt version in your path matches the smbmount used.</p></div><div class="refsect1" lang="en"><a name="id266713"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-r</span></dt><dd><p>mount the filesystem read-only + </p></dd><dt><span class="term">-u uid</span></dt><dd><p>specify the uid that the files will + be owned by </p></dd><dt><span class="term">-g gid</span></dt><dd><p>specify the gid that the files will be + owned by </p></dd><dt><span class="term">-f mask</span></dt><dd><p>specify the octal file mask applied + </p></dd><dt><span class="term">-d mask</span></dt><dd><p>specify the octal directory mask + applied </p></dd><dt><span class="term">-o options</span></dt><dd><p> + list of options that are passed as-is to smbfs, if this + command is run on a 2.4 or higher Linux kernel. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266803"></a><h2>AUTHOR</h2><p>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</p><p>The current maintainer of smbfs and the userspace + tools <code class="literal">smbmount</code>, <code class="literal">smbumount</code>, + and <code class="literal">smbmnt</code> is <a href="mailto:urban@teststation.com" target="_top">Urban Widmark</a>. + The <a href="mailto:samba@samba.org" target="_top">SAMBA Mailing list</a> + is the preferred place to ask questions regarding these programs. + </p><p>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbmount.8.html b/docs/htmldocs/manpages/smbmount.8.html new file mode 100644 index 0000000000..4ff97eaecf --- /dev/null +++ b/docs/htmldocs/manpages/smbmount.8.html @@ -0,0 +1,110 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbmount</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbmount.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbmount — mount an smbfs filesystem</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbmount</code> {service} {mount-point} [-o options]</p></div></div><div class="refsect1" lang="en"><a name="id267695"></a><h2>DESCRIPTION</h2><p><code class="literal">smbmount</code> mounts a Linux SMB filesystem. It + is usually invoked as <code class="literal">mount.smbfs</code> by + the <a href="mount.8.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> command when using the + "-t smbfs" option. This command only works in Linux, and the kernel must + support the smbfs filesystem.</p><p>WARNING: <code class="literal">smbmount</code> is deprecated and not + maintained any longer. <code class="literal">mount.cifs</code> (mount -t cifs) + should be used instead of <code class="literal">smbmount</code>.</p><p>Options to <code class="literal">smbmount</code> are specified as a comma-separated + list of key=value pairs. It is possible to send options other + than those listed here, assuming that smbfs supports them. If + you get mount failures, check your kernel log for errors on + unknown options.</p><p><code class="literal">smbmount</code> is a daemon. After mounting it keeps running until + the mounted smbfs is umounted. It will log things that happen + when in daemon mode using the "machine name" smbmount, so + typically this output will end up in <code class="filename">log.smbmount</code>. The <code class="literal"> + smbmount</code> process may also be called mount.smbfs.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> <code class="literal">smbmount</code> + calls <a href="smbmnt.8.html"><span class="citerefentry"><span class="refentrytitle">smbmnt</span>(8)</span></a> to do the actual mount. You + must make sure that <code class="literal">smbmnt</code> is in the path so + that it can be found. </p></div></div><div class="refsect1" lang="en"><a name="id266728"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">username=<arg></span></dt><dd><p> + specifies the username to connect as. If this is not given, then the environment variable <code class="envar"> USER</code> + is used. This option can also take the form "user%password" or "user/workgroup" or "user/workgroup%password" + to allow the password and workgroup to be specified as part of the username. + </p></dd><dt><span class="term">password=<arg></span></dt><dd><p> + specifies the SMB password. If this option is not given then the environment + variable <code class="literal">PASSWD</code> is used. If it can find no password + <code class="literal">smbmount</code> will prompt for a password, unless the guest option is given. + </p><p> + Note that passwords which contain the argument delimiter character (i.e. a comma ',') will failed to be parsed + correctly on the command line. However, the same password defined in the PASSWD environment variable or a + credentials file (see below) will be read correctly. + </p></dd><dt><span class="term">credentials=<filename></span></dt><dd><p>specifies a file that contains a username and/or password. +The format of the file is: +</p><pre class="programlisting"> +username=value +password=value +</pre><p>This is preferred over having passwords in plaintext in a + shared file, such as <code class="filename">/etc/fstab</code>. Be sure to protect any + credentials file properly. + </p></dd><dt><span class="term">krb</span></dt><dd><p>Use kerberos (Active Directory). </p></dd><dt><span class="term">netbiosname=<arg></span></dt><dd><p>sets the source NetBIOS name. It defaults + to the local hostname. </p></dd><dt><span class="term">uid=<arg></span></dt><dd><p>sets the uid that will own all files on + the mounted filesystem. + It may be specified as either a username or a numeric uid. + </p></dd><dt><span class="term">gid=<arg></span></dt><dd><p>sets the gid that will own all files on + the mounted filesystem. + It may be specified as either a groupname or a numeric + gid. </p></dd><dt><span class="term">port=<arg></span></dt><dd><p>sets the remote SMB port number. The default + is 445, fallback is 139. </p></dd><dt><span class="term">fmask=<arg></span></dt><dd><p>sets the file mask. This determines the + permissions that remote files have in the local filesystem. + This is not a umask, but the actual permissions for the files. + The default is based on the current umask. </p></dd><dt><span class="term">dmask=<arg></span></dt><dd><p>Sets the directory mask. This determines the + permissions that remote directories have in the local filesystem. + This is not a umask, but the actual permissions for the directories. + The default is based on the current umask. </p></dd><dt><span class="term">debug=<arg></span></dt><dd><p>Sets the debug level. This is useful for + tracking down SMB connection problems. A suggested value to + start with is 4. If set too high there will be a lot of + output, possibly hiding the useful output.</p></dd><dt><span class="term">ip=<arg></span></dt><dd><p>Sets the destination host or IP address. + </p></dd><dt><span class="term">workgroup=<arg></span></dt><dd><p>Sets the workgroup on the destination </p></dd><dt><span class="term">sockopt=<arg></span></dt><dd><p>Sets the TCP socket options. See the <a href="smb.conf.5.html#SOCKETOPTIONS" target="_top"><a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></a> <em class="parameter"><code>socket options</code></em> option. + </p></dd><dt><span class="term">scope=<arg></span></dt><dd><p>Sets the NetBIOS scope </p></dd><dt><span class="term">guest</span></dt><dd><p>Don't prompt for a password </p></dd><dt><span class="term">ro</span></dt><dd><p>mount read-only </p></dd><dt><span class="term">rw</span></dt><dd><p>mount read-write </p></dd><dt><span class="term">iocharset=<arg></span></dt><dd><p> + sets the charset used by the Linux side for codepage + to charset translations (NLS). Argument should be the + name of a charset, like iso8859-1. (Note: only kernel + 2.4.0 or later) + </p></dd><dt><span class="term">codepage=<arg></span></dt><dd><p> + sets the codepage the server uses. See the iocharset + option. Example value cp850. (Note: only kernel 2.4.0 + or later) + </p></dd><dt><span class="term">ttl=<arg></span></dt><dd><p> + sets how long a directory listing is cached in milliseconds + (also affects visibility of file size and date + changes). A higher value means that changes on the + server take longer to be noticed but it can give + better performance on large directories, especially + over long distances. Default is 1000ms but something + like 10000ms (10 seconds) is probably more reasonable + in many cases. + (Note: only kernel 2.4.2 or later) + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id307924"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the username of the + person using the client. This information is used only if the + protocol level is high enough to support session-level + passwords. The variable can be used to set both username and + password by using the format username%password.</p><p>The variable <code class="envar">PASSWD</code> may contain the password of the + person using the client. This information is used only if the + protocol level is high enough to support session-level + passwords.</p><p>The variable <code class="envar">PASSWD_FILE</code> may contain the pathname + of a file to read the password from. A single line of input is + read and used as the password.</p></div><div class="refsect1" lang="en"><a name="id307955"></a><h2>OTHER COMMANDS</h2><p> + File systems that have been mounted using the <code class="literal">smbmount</code> + can be unmounted using the <code class="literal">smbumount</code> or the UNIX system + <code class="literal">umount</code> command. + </p></div><div class="refsect1" lang="en"><a name="id307984"></a><h2>BUGS</h2><p>Passwords and other options containing , can not be handled. + For passwords an alternative way of passing them is in a credentials + file or in the PASSWD environment.</p><p>The credentials file does not handle usernames or passwords with + leading space.</p><p>One smbfs bug is important enough to mention here, even if it + is a bit misplaced:</p><div class="itemizedlist"><ul type="disc"><li><p>Mounts sometimes stop working. This is usually + caused by smbmount terminating. Since smbfs needs smbmount to + reconnect when the server disconnects, the mount will eventually go + dead. An umount/mount normally fixes this. At least 2 ways to + trigger this bug are known.</p></li></ul></div><p>Note that the typical response to a bug report is suggestion + to try the latest version first. So please try doing that first, + and always include which versions you use of relevant software + when reporting bugs (minimum: samba, kernel, distribution)</p></div><div class="refsect1" lang="en"><a name="id308018"></a><h2>SEE ALSO</h2><p>Documentation/filesystems/smbfs.txt in the linux kernel + source tree may contain additional options and information.</p><p>FreeBSD also has a smbfs, but it is not related to smbmount</p><p>For Solaris, HP-UX and others you may want to look at <a href="smbsh.1.html"><span class="citerefentry"><span class="refentrytitle">smbsh</span>(1)</span></a> or at other solutions, such as + Sharity or perhaps replacing the SMB server with a NFS server.</p></div><div class="refsect1" lang="en"><a name="id308046"></a><h2>AUTHOR</h2><p>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</p><p>The current maintainer of smbfs and the userspace + tools <code class="literal">smbmount</code>, <code class="literal">smbumount</code>, + and <code class="literal">smbmnt</code> is <a href="mailto:urban@teststation.com" target="_top">Urban Widmark</a>. + The <a href="mailto:samba@samba.org" target="_top">SAMBA Mailing list</a> + is the preferred place to ask questions regarding these programs. + </p><p>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbpasswd.5.html b/docs/htmldocs/manpages/smbpasswd.5.html new file mode 100644 index 0000000000..53073de8ff --- /dev/null +++ b/docs/htmldocs/manpages/smbpasswd.5.html @@ -0,0 +1,91 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbpasswd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbpasswd.5"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbpasswd — The Samba encrypted password file</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename">smbpasswd</code></p></div><div class="refsect1" lang="en"><a name="id267669"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>smbpasswd is the Samba encrypted password file. It contains + the username, Unix user id and the SMB hashed passwords of the + user, as well as account flag information and the time the + password was last changed. This file format has been evolving with + Samba and has had several different formats in the past. </p></div><div class="refsect1" lang="en"><a name="id267694"></a><h2>FILE FORMAT</h2><p>The format of the smbpasswd file used by Samba 2.2 + is very similar to the familiar Unix <code class="filename">passwd(5)</code> + file. It is an ASCII file containing one line for each user. Each field + ithin each line is separated from the next by a colon. Any entry + beginning with '#' is ignored. The smbpasswd file contains the + following information for each user: </p><div class="variablelist"><dl><dt><span class="term">name</span></dt><dd><p> This is the user name. It must be a name that + already exists in the standard UNIX passwd file. </p></dd><dt><span class="term">uid</span></dt><dd><p>This is the UNIX uid. It must match the uid + field for the same user entry in the standard UNIX passwd file. + If this does not match then Samba will refuse to recognize + this smbpasswd file entry as being valid for a user. + </p></dd><dt><span class="term">Lanman Password Hash</span></dt><dd><p>This is the LANMAN hash of the user's password, + encoded as 32 hex digits. The LANMAN hash is created by DES + encrypting a well known string with the user's password as the + DES key. This is the same password used by Windows 95/98 machines. + Note that this password hash is regarded as weak as it is + vulnerable to dictionary attacks and if two users choose the + same password this entry will be identical (i.e. the password + is not "salted" as the UNIX password is). If the user has a + null password this field will contain the characters "NO PASSWORD" + as the start of the hex string. If the hex string is equal to + 32 'X' characters then the user's account is marked as + <code class="constant">disabled</code> and the user will not be able to + log onto the Samba server. </p><p><span class="emphasis"><em>WARNING !!</em></span> Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as <span class="emphasis"><em>plain text + equivalents</em></span> and must <span class="emphasis"><em>NOT</em></span> be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access. </p></dd><dt><span class="term">NT Password Hash</span></dt><dd><p>This is the Windows NT hash of the user's + password, encoded as 32 hex digits. The Windows NT hash is + created by taking the user's password as represented in + 16-bit, little-endian UNICODE and then applying the MD4 + (internet rfc1321) hashing algorithm to it. </p><p>This password hash is considered more secure than + the LANMAN Password Hash as it preserves the case of the + password and uses a much higher quality hashing algorithm. + However, it is still the case that if two users choose the same + password this entry will be identical (i.e. the password is + not "salted" as the UNIX password is). </p><p><span class="emphasis"><em>WARNING !!</em></span>. Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as <span class="emphasis"><em>plain text + equivalents</em></span> and must <span class="emphasis"><em>NOT</em></span> be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access. </p></dd><dt><span class="term">Account Flags</span></dt><dd><p>This section contains flags that describe + the attributes of the users account. This field is bracketed by + '[' and ']' characters and is always 13 characters in length + (including the '[' and ']' characters). + The contents of this field may be any of the following characters: + </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>U</em></span> - This means + this is a "User" account, i.e. an ordinary user.</p></li><li><p><span class="emphasis"><em>N</em></span> - This means the + account has no password (the passwords in the fields LANMAN + Password Hash and NT Password Hash are ignored). Note that this + will only allow users to log on with no password if the <em class="parameter"><code> + null passwords</code></em> parameter is set in the + <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> config file. </p></li><li><p><span class="emphasis"><em>D</em></span> - This means the account + is disabled and no SMB/CIFS logins will be allowed for this user. </p></li><li><p><span class="emphasis"><em>X</em></span> - This means the password + does not expire. </p></li><li><p><span class="emphasis"><em>W</em></span> - This means this account + is a "Workstation Trust" account. This kind of account is used + in the Samba PDC code stream to allow Windows NT Workstations + and Servers to join a Domain hosted by a Samba PDC. </p></li></ul></div><p>Other flags may be added as the code is extended in future. + The rest of this field space is filled in with spaces. For further + information regarding the flags that are supported please refer to the + man page for the <code class="literal">pdbedit</code> command.</p></dd><dt><span class="term">Last Change Time</span></dt><dd><p>This field consists of the time the account was + last modified. It consists of the characters 'LCT-' (standing for + "Last Change Time") followed by a numeric encoding of the UNIX time + in seconds since the epoch (1970) that the last change was made. + </p></dd></dl></div><p>All other colon separated fields are ignored at this time.</p></div><div class="refsect1" lang="en"><a name="id266838"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266848"></a><h2>SEE ALSO</h2><p><a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>, <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a>, and + the Internet RFC1321 for details on the MD4 algorithm. + </p></div><div class="refsect1" lang="en"><a name="id266895"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbpasswd.8.html b/docs/htmldocs/manpages/smbpasswd.8.html new file mode 100644 index 0000000000..6c200b6e9e --- /dev/null +++ b/docs/htmldocs/manpages/smbpasswd.8.html @@ -0,0 +1,171 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbpasswd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbpasswd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbpasswd — change a user's SMB password</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbpasswd</code> [-a] [-c <config file>] [-x] [-d] [-e] [-D debuglevel] [-n] [-r <remote machine>] [-R <name resolve order>] [-m] [-U username[%password]] [-h] [-s] [-w pass] [-W] [-i] [-L] [username]</p></div></div><div class="refsect1" lang="en"><a name="id266733"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The smbpasswd program has several different + functions, depending on whether it is run by the <span class="emphasis"><em>root</em></span> user + or not. When run as a normal user it allows the user to change + the password used for their SMB sessions on any machines that store + SMB passwords. </p><p>By default (when run with no arguments) it will attempt to + change the current user's SMB password on the local machine. This is + similar to the way the <code class="literal">passwd(1)</code> program works. <code class="literal"> + smbpasswd</code> differs from how the passwd program works + however in that it is not <span class="emphasis"><em>setuid root</em></span> but works in + a client-server mode and communicates with a + locally running <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>. As a consequence in order for this to + succeed the smbd daemon must be running on the local machine. On a + UNIX machine the encrypted SMB passwords are usually stored in + the <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> file. </p><p>When run by an ordinary user with no options, smbpasswd + will prompt them for their old SMB password and then ask them + for their new password twice, to ensure that the new password + was typed correctly. No passwords will be echoed on the screen + whilst being typed. If you have a blank SMB password (specified by + the string "NO PASSWORD" in the smbpasswd file) then just press + the <Enter> key when asked for your old password. </p><p>smbpasswd can also be used by a normal user to change their + SMB password on remote machines, such as Windows NT Primary Domain + Controllers. See the (<em class="parameter"><code>-r</code></em>) and <em class="parameter"><code>-U</code></em> options + below. </p><p>When run by root, smbpasswd allows new users to be added + and deleted in the smbpasswd file, as well as allows changes to + the attributes of the user in this file to be made. When run by root, <code class="literal"> + smbpasswd</code> accesses the local smbpasswd file + directly, thus enabling changes to be made even if smbd is not + running. </p></div><div class="refsect1" lang="en"><a name="id266836"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-a</span></dt><dd><p> + This option specifies that the username following should be added to the local smbpasswd file, with the new + password typed (type <Enter> for the old password). This option is ignored if the username following + already exists in the smbpasswd file and it is treated like a regular change password command. Note that the + default passdb backends require the user to already exist in the system password file (usually + <code class="filename">/etc/passwd</code>), else the request to add the user will fail. + </p><p>This option is only available when running smbpasswd + as root. </p></dd><dt><span class="term">-c</span></dt><dd><p> + This option can be used to specify the path and file name of the <code class="filename">smb.conf</code> configuration file when it + is important to use other than the default file and / or location. + </p></dd><dt><span class="term">-x</span></dt><dd><p> + This option specifies that the username following should be deleted from the local smbpasswd file. + </p><p> + This option is only available when running smbpasswd as root. + </p></dd><dt><span class="term">-d</span></dt><dd><p>This option specifies that the username following + should be <code class="constant">disabled</code> in the local smbpasswd + file. This is done by writing a <code class="constant">'D'</code> flag + into the account control space in the smbpasswd file. Once this + is done all attempts to authenticate via SMB using this username + will fail. </p><p>If the smbpasswd file is in the 'old' format (pre-Samba 2.0 + format) there is no space in the user's password entry to write + this information and the command will FAIL. See <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> for details on the 'old' and new password file formats. + </p><p>This option is only available when running smbpasswd as + root.</p></dd><dt><span class="term">-e</span></dt><dd><p>This option specifies that the username following + should be <code class="constant">enabled</code> in the local smbpasswd file, + if the account was previously disabled. If the account was not + disabled this option has no effect. Once the account is enabled then + the user will be able to authenticate via SMB once again. </p><p>If the smbpasswd file is in the 'old' format, then <code class="literal"> + smbpasswd</code> will FAIL to enable the account. + See <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> for + details on the 'old' and new password file formats. </p><p>This option is only available when running smbpasswd as root. + </p></dd><dt><span class="term">-D debuglevel</span></dt><dd><p><em class="replaceable"><code>debuglevel</code></em> is an integer + from 0 to 10. The default value if this parameter is not specified + is zero. </p><p>The higher this value, the more detail will be logged to the + log files about the activities of smbpasswd. At level 0, only + critical errors and serious warnings will be logged. </p><p>Levels above 1 will generate considerable amounts of log + data, and should only be used when investigating a problem. Levels + above 3 are designed for use only by developers and generate + HUGE amounts of log data, most of which is extremely cryptic. + </p></dd><dt><span class="term">-n</span></dt><dd><p>This option specifies that the username following + should have their password set to null (i.e. a blank password) in + the local smbpasswd file. This is done by writing the string "NO + PASSWORD" as the first part of the first password stored in the + smbpasswd file. </p><p>Note that to allow users to logon to a Samba server once + the password has been set to "NO PASSWORD" in the smbpasswd + file the administrator must set the following parameter in the [global] + section of the <code class="filename">smb.conf</code> file : </p><p><code class="literal">null passwords = yes</code></p><p>This option is only available when running smbpasswd as + root.</p></dd><dt><span class="term">-r remote machine name</span></dt><dd><p>This option allows a user to specify what machine + they wish to change their password on. Without this parameter + smbpasswd defaults to the local host. The <em class="replaceable"><code>remote + machine name</code></em> is the NetBIOS name of the SMB/CIFS + server to contact to attempt the password change. This name is + resolved into an IP address using the standard name resolution + mechanism in all programs of the Samba suite. See the <em class="parameter"><code>-R + name resolve order</code></em> parameter for details on changing + this resolving mechanism. </p><p>The username whose password is changed is that of the + current UNIX logged on user. See the <em class="parameter"><code>-U username</code></em> + parameter for details on changing the password for a different + username. </p><p>Note that if changing a Windows NT Domain password the + remote machine specified must be the Primary Domain Controller for + the domain (Backup Domain Controllers only have a read-only + copy of the user account database and will not allow the password + change).</p><p><span class="emphasis"><em>Note</em></span> that Windows 95/98 do not have + a real password database so it is not possible to change passwords + specifying a Win95/98 machine as remote machine target. </p></dd><dt><span class="term">-R name resolve order</span></dt><dd><p>This option allows the user of smbpasswd to determine + what name resolution services to use when looking up the NetBIOS + name of the host being connected to. </p><p>The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows: </p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">lmhosts</code>: Lookup an IP + address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see the <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> for details) then + any name type matches for lookup.</p></li><li><p><code class="constant">host</code>: Do a standard host + name to IP address resolution, using the system <code class="filename">/etc/hosts + </code>, NIS, or DNS lookups. This method of name resolution + is operating system depended for instance on IRIX or Solaris this + may be controlled by the <code class="filename">/etc/nsswitch.conf</code> + file). Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</p></li><li><p><code class="constant">wins</code>: Query a name with + the IP address listed in the <em class="parameter"><code>wins server</code></em> + parameter. If no WINS server has been specified this method + will be ignored.</p></li><li><p><code class="constant">bcast</code>: Do a broadcast on + each of the known local interfaces listed in the + <em class="parameter"><code>interfaces</code></em> parameter. This is the least + reliable of the name resolution methods as it depends on the + target host being on a locally connected subnet.</p></li></ul></div><p>The default order is <code class="literal">lmhosts, host, wins, bcast</code> + and without this parameter or any entry in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file the name resolution methods will + be attempted in this order. </p></dd><dt><span class="term">-m</span></dt><dd><p>This option tells smbpasswd that the account + being changed is a MACHINE account. Currently this is used + when Samba is being used as an NT Primary Domain Controller.</p><p>This option is only available when running smbpasswd as root. + </p></dd><dt><span class="term">-U username</span></dt><dd><p>This option may only be used in conjunction + with the <em class="parameter"><code>-r</code></em> option. When changing + a password on a remote machine it allows the user to specify + the user name on that machine whose password will be changed. It + is present to allow users who have different user names on + different systems to change these passwords. </p></dd><dt><span class="term">-h</span></dt><dd><p>This option prints the help string for <code class="literal"> + smbpasswd</code>, selecting the correct one for running as root + or as an ordinary user. </p></dd><dt><span class="term">-s</span></dt><dd><p>This option causes smbpasswd to be silent (i.e. + not issue prompts) and to read its old and new passwords from + standard input, rather than from <code class="filename">/dev/tty</code> + (like the <code class="literal">passwd(1)</code> program does). This option + is to aid people writing scripts to drive smbpasswd</p></dd><dt><span class="term">-w password</span></dt><dd><p>This parameter is only available if Samba + has been compiled with LDAP support. The <em class="parameter"><code>-w</code></em> + switch is used to specify the password to be used with the + <a class="indexterm" name="id308169"></a>ldap admin dn. Note that the password is stored in + the <code class="filename">secrets.tdb</code> and is keyed off + of the admin's DN. This means that if the value of <em class="parameter"><code>ldap + admin dn</code></em> ever changes, the password will need to be + manually updated as well. + </p></dd><dt><span class="term">-W</span></dt><dd><p><code class="literal">NOTE: </code> This option is same as "-w" + except that the password should be entered using stdin. + </p><p>This parameter is only available if Samba + has been compiled with LDAP support. The <em class="parameter"><code>-W</code></em> + switch is used to specify the password to be used with the + <a class="indexterm" name="id308217"></a>ldap admin dn. Note that the password is stored in + the <code class="filename">secrets.tdb</code> and is keyed off + of the admin's DN. This means that if the value of <em class="parameter"><code>ldap + admin dn</code></em> ever changes, the password will need to be + manually updated as well. + </p></dd><dt><span class="term">-i</span></dt><dd><p>This option tells smbpasswd that the account + being changed is an interdomain trust account. Currently this is used + when Samba is being used as an NT Primary Domain Controller. + The account contains the info about another trusted domain.</p><p>This option is only available when running smbpasswd as root. + </p></dd><dt><span class="term">-L</span></dt><dd><p>Run in local mode.</p></dd><dt><span class="term">username</span></dt><dd><p>This specifies the username for all of the + <span class="emphasis"><em>root only</em></span> options to operate on. Only root + can specify this parameter as only root has the permission needed + to modify attributes directly in the local smbpasswd file. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308287"></a><h2>NOTES</h2><p>Since <code class="literal">smbpasswd</code> works in client-server + mode communicating with a local smbd for a non-root user then + the smbd daemon must be running for this to work. A common problem + is to add a restriction to the hosts that may access the <code class="literal"> + smbd</code> running on the local machine by specifying either <em class="parameter"><code>allow + hosts</code></em> or <em class="parameter"><code>deny hosts</code></em> entry in + the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file and neglecting to + allow "localhost" access to the smbd. </p><p>In addition, the smbpasswd command is only useful if Samba + has been set up to use encrypted passwords. </p></div><div class="refsect1" lang="en"><a name="id308336"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308346"></a><h2>SEE ALSO</h2><p><a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>, <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id308371"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbsh.1.html b/docs/htmldocs/manpages/smbsh.1.html new file mode 100644 index 0000000000..461a87d909 --- /dev/null +++ b/docs/htmldocs/manpages/smbsh.1.html @@ -0,0 +1,108 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbsh</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbsh.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbsh — Allows access to remote SMB shares + using UNIX commands</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbsh</code> [-W workgroup] [-U username] [-P prefix] [-R <name resolve order>] [-d <debug level>] [-l logdir] [-L libdir]</p></div></div><div class="refsect1" lang="en"><a name="id267042"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbsh</code> allows you to access an NT filesystem + using UNIX commands such as <code class="literal">ls</code>, <code class="literal"> + egrep</code>, and <code class="literal">rcp</code>. You must use a + shell that is dynamically linked in order for <code class="literal">smbsh</code> + to work correctly.</p></div><div class="refsect1" lang="en"><a name="id267092"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-W WORKGROUP</span></dt><dd><p>Override the default workgroup specified in the + workgroup parameter of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file + for this session. This may be needed to connect to some + servers. </p></dd><dt><span class="term">-U username[%pass]</span></dt><dd><p>Sets the SMB username or username and password. + If this option is not specified, the user will be prompted for + both the username and the password. If %pass is not specified, + the user will be prompted for the password. + </p></dd><dt><span class="term">-P prefix</span></dt><dd><p>This option allows + the user to set the directory prefix for SMB access. The + default value if this option is not specified is + <span class="emphasis"><em>smb</em></span>. + </p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266730"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-R <name resolve order></span></dt><dd><p>This option is used to determine what naming +services and in what order to resolve +host names to IP addresses. The option takes a space-separated +string of different name resolution options.</p><p>The options are: "lmhosts", "host", "wins" and "bcast". +They cause names to be resolved as follows :</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">lmhosts</code>: +Lookup an IP address in the Samba lmhosts file. If the +line in lmhosts has no name type attached to the +NetBIOS name +(see the <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> for details) +then any name type matches for lookup. +</p></li><li><p><code class="constant">host</code>: +Do a standard host name to IP address resolution, using +the system <code class="filename">/etc/hosts</code>, NIS, or DNS +lookups. This method of name resolution is operating +system dependent, for instance on IRIX or Solaris this +may be controlled by the <code class="filename">/etc/nsswitch.conf +</code> file). Note that this method is only used +if the NetBIOS name type being queried is the 0x20 +(server) name type, otherwise it is ignored. +</p></li><li><p><code class="constant">wins</code>: +Query a name with the IP address listed in the +<em class="parameter"><code>wins server</code></em> parameter. If no +WINS server has been specified this method will be +ignored. +</p></li><li><p><code class="constant">bcast</code>: +Do a broadcast on each of the known local interfaces +listed in the <em class="parameter"><code>interfaces</code></em> +parameter. This is the least reliable of the name +resolution methods as it depends on the target host +being on a locally connected subnet. +</p></li></ul></div><p>If this parameter is not set then the name resolve order +defined in the <code class="filename">smb.conf</code> file parameter +(<a class="indexterm" name="id266838"></a>) will be used. +</p><p>The default order is lmhosts, host, wins, bcast. Without +this parameter or any entry in the <a class="indexterm" name="id266848"></a> parameter of the <code class="filename">smb.conf</code> file, the name +resolution methods will be attempted in this order. </p></dd><dt><span class="term">-L libdir</span></dt><dd><p>This parameter specifies the location of the + shared libraries used by <code class="literal">smbsh</code>. The default + value is specified at compile time. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266882"></a><h2>EXAMPLES</h2><p>To use the <code class="literal">smbsh</code> command, execute <code class="literal"> + smbsh</code> from the prompt and enter the username and password + that authenticates you to the machine running the Windows NT + operating system. +</p><pre class="programlisting"> +<code class="prompt">system% </code><strong class="userinput"><code>smbsh</code></strong> +<code class="prompt">Username: </code><strong class="userinput"><code>user</code></strong> +<code class="prompt">Password: </code><strong class="userinput"><code>XXXXXXX</code></strong> +</pre><p>Any dynamically linked command you execute from + this shell will access the <code class="filename">/smb</code> directory + using the smb protocol. For example, the command <code class="literal">ls /smb + </code> will show a list of workgroups. The command + <code class="literal">ls /smb/MYGROUP </code> will show all the machines in + the workgroup MYGROUP. The command + <code class="literal">ls /smb/MYGROUP/<machine-name></code> will show the share + names for that machine. You could then, for example, use the <code class="literal"> + cd</code> command to change directories, <code class="literal">vi</code> to + edit files, and <code class="literal">rcp</code> to copy files.</p></div><div class="refsect1" lang="en"><a name="id307941"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id307951"></a><h2>BUGS</h2><p><code class="literal">smbsh</code> works by intercepting the standard + libc calls with the dynamically loaded versions in <code class="filename"> + smbwrapper.o</code>. Not all calls have been "wrapped", so + some programs may not function correctly under <code class="literal">smbsh + </code>.</p><p>Programs which are not dynamically linked cannot make + use of <code class="literal">smbsh</code>'s functionality. Most versions + of UNIX have a <code class="literal">file</code> command that will + describe how a program was linked.</p></div><div class="refsect1" lang="en"><a name="id307996"></a><h2>SEE ALSO</h2><p><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><a name="id308019"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbspool.8.html b/docs/htmldocs/manpages/smbspool.8.html new file mode 100644 index 0000000000..f3cd58c85f --- /dev/null +++ b/docs/htmldocs/manpages/smbspool.8.html @@ -0,0 +1,36 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbspool</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbspool.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbspool — send a print file to an SMB printer</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbspool</code> {job} {user} {title} {copies} {options} [filename]</p></div></div><div class="refsect1" lang="en"><a name="id299208"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>smbspool is a very small print spooling program that + sends a print file to an SMB printer. The command-line arguments + are position-dependent for compatibility with the Common UNIX + Printing System, but you can use smbspool with any printing system + or from a program or script.</p><p><span class="emphasis"><em>DEVICE URI</em></span></p><p>smbspool specifies the destination using a Uniform Resource + Identifier ("URI") with a method of "smb". This string can take + a number of forms:</p><div class="itemizedlist"><ul type="disc"><li><p>smb://server[:port]/printer</p></li><li><p>smb://workgroup/server[:port]/printer</p></li><li><p>smb://username:password@server[:port]/printer</p></li><li><p>smb://username:password@workgroup/server[:port]/printer</p></li></ul></div><p>smbspool tries to get the URI from the environment variable + <code class="envar">DEVICE_URI</code>. If <code class="envar">DEVICE_URI</code> is not present, + smbspool will use argv[0] if that starts with “<span class="quote">smb://</span>” + or argv[1] if that is not the case.</p><p>Programs using the <code class="literal">exec(2)</code> functions can + pass the URI in argv[0], while shell scripts must set the + <code class="envar">DEVICE_URI</code> environment variable prior to + running smbspool.</p></div><div class="refsect1" lang="en"><a name="id266725"></a><h2>OPTIONS</h2><div class="itemizedlist"><ul type="disc"><li><p>The job argument (argv[1]) contains the + job ID number and is presently not used by smbspool. + </p></li><li><p>The user argument (argv[2]) contains the + print user's name and is presently not used by smbspool. + </p></li><li><p>The title argument (argv[3]) contains the + job title string and is passed as the remote file name + when sending the print job.</p></li><li><p>The copies argument (argv[4]) contains + the number of copies to be printed of the named file. If + no filename is provided then this argument is not used by + smbspool.</p></li><li><p>The options argument (argv[5]) contains + the print options in a single string and is currently + not used by smbspool.</p></li><li><p>The filename argument (argv[6]) contains the + name of the file to print. If this argument is not specified + then the print file is read from the standard input.</p></li></ul></div></div><div class="refsect1" lang="en"><a name="id266769"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266779"></a><h2>SEE ALSO</h2><p><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id266804"></a><h2>AUTHOR</h2><p><code class="literal">smbspool</code> was written by Michael Sweet + at Easy Software Products.</p><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbstatus.1.html b/docs/htmldocs/manpages/smbstatus.1.html new file mode 100644 index 0000000000..abef01c4f9 --- /dev/null +++ b/docs/htmldocs/manpages/smbstatus.1.html @@ -0,0 +1,41 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbstatus</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbstatus.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbstatus — report on current Samba connections</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbstatus</code> [-P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration file>] [-u <username>]</p></div></div><div class="refsect1" lang="en"><a name="id299237"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbstatus</code> is a very simple program to + list the current Samba connections.</p></div><div class="refsect1" lang="en"><a name="id299264"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-P|--profile</span></dt><dd><p>If samba has been compiled with the + profiling option, print only the contents of the profiling + shared memory area.</p></dd><dt><span class="term">-b|--brief</span></dt><dd><p>gives brief output.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266758"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-v|--verbose</span></dt><dd><p>gives verbose output.</p></dd><dt><span class="term">-L|--locks</span></dt><dd><p>causes smbstatus to only list locks.</p></dd><dt><span class="term">-B|--byterange</span></dt><dd><p>causes smbstatus to include byte range locks. + </p></dd><dt><span class="term">-p|--processes</span></dt><dd><p>print a list of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> processes and exit. + Useful for scripting.</p></dd><dt><span class="term">-S|--shares</span></dt><dd><p>causes smbstatus to only list shares.</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-u|--user=<username></span></dt><dd><p>selects information relevant to <em class="parameter"><code>username</code></em> only.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266940"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266951"></a><h2>SEE ALSO</h2><p><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id266976"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbtar.1.html b/docs/htmldocs/manpages/smbtar.1.html new file mode 100644 index 0000000000..1049c82908 --- /dev/null +++ b/docs/htmldocs/manpages/smbtar.1.html @@ -0,0 +1,39 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbtar</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbtar.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbtar — shell script for backing up SMB/CIFS shares + directly to UNIX tape drives</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbtar</code> [-r] [-i] [-a] [-v] {-s server} [-p password] [-x services] [-X] [-N filename] [-b blocksize] [-d directory] [-l loglevel] [-u user] [-t tape] {filenames}</p></div></div><div class="refsect1" lang="en"><a name="id299276"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbtar</code> is a very small shell script on top + of <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a> which dumps SMB shares directly to tape.</p></div><div class="refsect1" lang="en"><a name="id266744"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s server</span></dt><dd><p>The SMB/CIFS server that the share resides + upon.</p></dd><dt><span class="term">-x service</span></dt><dd><p>The share name on the server to connect to. + The default is "backup".</p></dd><dt><span class="term">-X</span></dt><dd><p>Exclude mode. Exclude filenames... from tar + create or restore. </p></dd><dt><span class="term">-d directory</span></dt><dd><p>Change to initial <em class="parameter"><code>directory + </code></em> before restoring / backing up files. </p></dd><dt><span class="term">-v</span></dt><dd><p>Verbose mode.</p></dd><dt><span class="term">-p password</span></dt><dd><p>The password to use to access a share. + Default: none </p></dd><dt><span class="term">-u user</span></dt><dd><p>The user id to connect as. Default: + UNIX login name. </p></dd><dt><span class="term">-a</span></dt><dd><p>Reset DOS archive bit mode to + indicate file has been archived. </p></dd><dt><span class="term">-t tape</span></dt><dd><p>Tape device. May be regular file or tape + device. Default: <em class="parameter"><code>$TAPE</code></em> environmental + variable; if not set, a file called <code class="filename">tar.out + </code>. </p></dd><dt><span class="term">-b blocksize</span></dt><dd><p>Blocking factor. Defaults to 20. See + <code class="literal">tar(1)</code> for a fuller explanation. </p></dd><dt><span class="term">-N filename</span></dt><dd><p>Backup only files newer than filename. Could + be used (for example) on a log file to implement incremental + backups. </p></dd><dt><span class="term">-i</span></dt><dd><p>Incremental mode; tar files are only backed + up if they have the archive bit set. The archive bit is reset + after each file is read. </p></dd><dt><span class="term">-r</span></dt><dd><p>Restore. Files are restored to the share + from the tar file. </p></dd><dt><span class="term">-l log level</span></dt><dd><p>Log (debug) level. Corresponds to the + <em class="parameter"><code>-d</code></em> flag of <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266975"></a><h2>ENVIRONMENT VARIABLES</h2><p>The <em class="parameter"><code>$TAPE</code></em> variable specifies the + default tape device to write to. May be overridden + with the -t option. </p></div><div class="refsect1" lang="en"><a name="id266992"></a><h2>BUGS</h2><p>The <code class="literal">smbtar</code> script has different + options from ordinary tar and from smbclient's tar command. </p></div><div class="refsect1" lang="en"><a name="id267008"></a><h2>CAVEATS</h2><p>Sites that are more careful about security may not like + the way the script handles PC passwords. Backup and restore work + on entire shares; should work on file lists. smbtar works best + with GNU tar and may not work well with other versions. </p></div><div class="refsect1" lang="en"><a name="id267020"></a><h2>DIAGNOSTICS</h2><p>See the <span class="emphasis"><em>DIAGNOSTICS</em></span> section for the <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a> command.</p></div><div class="refsect1" lang="en"><a name="id307900"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id307910"></a><h2>SEE ALSO</h2><p><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id307943"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p><a href="mailto:poultenr@logica.co.uk" target="_top">Ricky Poulten</a> + wrote the tar extension and this man page. The <code class="literal">smbtar</code> + script was heavily rewritten and improved by <a href="mailto:Martin.Kraemer@mch.sni.de" target="_top">Martin Kraemer</a>. Many + thanks to everyone who suggested extensions, improvements, bug + fixes, etc. The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbtree.1.html b/docs/htmldocs/manpages/smbtree.1.html new file mode 100644 index 0000000000..c221a1b77b --- /dev/null +++ b/docs/htmldocs/manpages/smbtree.1.html @@ -0,0 +1,74 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbtree</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbtree.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbtree — A text based smb network browser + </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbtree</code> [-b] [-D] [-S]</p></div></div><div class="refsect1" lang="en"><a name="id267694"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbtree</code> is a smb browser program + in text mode. It is similar to the "Network Neighborhood" found + on Windows computers. It prints a tree with all + the known domains, the servers in those domains and + the shares on the servers. + </p></div><div class="refsect1" lang="en"><a name="id299211"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-b</span></dt><dd><p>Query network nodes by sending requests + as broadcasts instead of querying the local master browser. + </p></dd><dt><span class="term">-D</span></dt><dd><p>Only print a list of all + the domains known on broadcast or by the + master browser</p></dd><dt><span class="term">-S</span></dt><dd><p>Only print a list of + all the domains and servers responding on broadcast or + known by the master browser. + </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266718"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.</p><p>If a password is specified on the command line and this +option is also defined the password on the command line will +be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k</span></dt><dd><p> +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +</p><pre class="programlisting"> +username = <value> +password = <value> +domain = <value> +</pre><p>Make certain that the permissions on the file restrict +access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The +client will first check the <code class="envar">USER</code> environment variable, then the +<code class="envar">LOGNAME</code> variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the <code class="literal">ps</code> command. To be safe always allow +<code class="literal">rpcclient</code> to prompt for a password and type +it in directly. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266925"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><a name="id266935"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The smbtree man page was written by Jelmer Vernooij. </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/smbumount.8.html b/docs/htmldocs/manpages/smbumount.8.html new file mode 100644 index 0000000000..85b58cf5c2 --- /dev/null +++ b/docs/htmldocs/manpages/smbumount.8.html @@ -0,0 +1,17 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbumount</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbumount.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbumount — smbfs umount for normal users</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbumount</code> {mount-point}</p></div></div><div class="refsect1" lang="en"><a name="id267679"></a><h2>DESCRIPTION</h2><p>With this program, normal users can unmount smb-filesystems, + provided that it is suid root. <code class="literal">smbumount</code> has + been written to give normal Linux users more control over their + resources. It is safe to install this program suid root, because only + the user who has mounted a filesystem is allowed to unmount it again. + For root it is not necessary to use smbumount. The normal umount + program works perfectly well.</p><p>WARNING: <code class="literal">smbumount</code> is deprecated and not + maintained any longer. <code class="literal">umount.cifs</code> + should be used instead of <code class="literal">smbumount</code>.</p></div><div class="refsect1" lang="en"><a name="id299210"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">mount-point</span></dt><dd><p>The directory to unmount.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299231"></a><h2>SEE ALSO</h2><p><a href="smbmount.8.html"><span class="citerefentry"><span class="refentrytitle">smbmount</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id299246"></a><h2>AUTHOR</h2><p>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</p><p>The current maintainer of smbfs and the userspace + tools <code class="literal">smbmount</code>, <code class="literal">smbumount</code>, + and <code class="literal">smbmnt</code> is <a href="mailto:urban@teststation.com" target="_top">Urban Widmark</a>. + The <a href="mailto:samba@samba.org" target="_top">SAMBA Mailing list</a> + is the preferred place to ask questions regarding these programs. + </p><p>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/swat.8.html b/docs/htmldocs/manpages/swat.8.html new file mode 100644 index 0000000000..267e25db78 --- /dev/null +++ b/docs/htmldocs/manpages/swat.8.html @@ -0,0 +1,88 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>swat</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="swat.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>swat — Samba Web Administration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">swat</code> [-s <smb config file>] [-a] [-P]</p></div></div><div class="refsect1" lang="en"><a name="id267689"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">swat</code> allows a Samba administrator to + configure the complex <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file via a Web browser. In addition, + a <code class="literal">swat</code> configuration page has help links + to all the configurable options in the <code class="filename">smb.conf</code> file allowing an + administrator to easily look up the effects of any change. </p><p><code class="literal">swat</code> is run from <code class="literal">inetd</code> </p></div><div class="refsect1" lang="en"><a name="id267070"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s smb configuration file</span></dt><dd><p>The default configuration file path is + determined at compile time. The file specified contains + the configuration details required by the <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> server. This is the file + that <code class="literal">swat</code> will modify. + The information in this file includes server-specific + information such as what printcap file to use, as well as + descriptions of all the services that the server is to provide. + See <code class="filename">smb.conf</code> for more information. + </p></dd><dt><span class="term">-a</span></dt><dd><p>This option disables authentication and + places <code class="literal">swat</code> in demo mode. In that mode anyone will be able to modify + the <code class="filename">smb.conf</code> file. </p><p><span class="emphasis"><em>WARNING: Do NOT enable this option on a production + server. </em></span></p></dd><dt><span class="term">-P</span></dt><dd><p>This option restricts read-only users to the password + management page. <code class="literal">swat</code> can then be used to change + user passwords without users seeing the "View" and "Status" menu + buttons.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266720"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266795"></a><h2>INSTALLATION</h2><p>Swat is included as binary package with most distributions. The + package manager in this case takes care of the installation and + configuration. This section is only for those who have compiled + swat from scratch. + </p><p>After you compile SWAT you need to run <code class="literal">make install + </code> to install the <code class="literal">swat</code> binary + and the various help files and images. A default install would put + these in: </p><div class="itemizedlist"><ul type="disc"><li><p>/usr/local/samba/sbin/swat</p></li><li><p>/usr/local/samba/swat/images/*</p></li><li><p>/usr/local/samba/swat/help/*</p></li></ul></div><div class="refsect2" lang="en"><a name="id266840"></a><h3>Inetd Installation</h3><p>You need to edit your <code class="filename">/etc/inetd.conf + </code> and <code class="filename">/etc/services</code> + to enable SWAT to be launched via <code class="literal">inetd</code>.</p><p>In <code class="filename">/etc/services</code> you need to + add a line like this: </p><p><code class="literal">swat 901/tcp</code></p><p>Note for NIS/YP and LDAP users - you may need to rebuild the + NIS service maps rather than alter your local <code class="filename"> + /etc/services</code> file. </p><p>the choice of port number isn't really important + except that it should be less than 1024 and not currently + used (using a number above 1024 presents an obscure security + hole depending on the implementation details of your + <code class="literal">inetd</code> daemon). </p><p>In <code class="filename">/etc/inetd.conf</code> you should + add a line like this: </p><p><code class="literal">swat stream tcp nowait.400 root + /usr/local/samba/sbin/swat swat</code></p><p>Once you have edited <code class="filename">/etc/services</code> + and <code class="filename">/etc/inetd.conf</code> you need to send a + HUP signal to inetd. To do this use <code class="literal">kill -1 PID + </code> where PID is the process ID of the inetd daemon. </p></div></div><div class="refsect1" lang="en"><a name="id307898"></a><h2>LAUNCHING</h2><p>To launch SWAT just run your favorite web browser and + point it at "http://localhost:901/".</p><p>Note that you can attach to SWAT from any IP connected + machine but connecting from a remote machine leaves your + connection open to password sniffing as passwords will be sent + in the clear over the wire. </p></div><div class="refsect1" lang="en"><a name="id307914"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/inetd.conf</code></span></dt><dd><p>This file must contain suitable startup + information for the meta-daemon.</p></dd><dt><span class="term"><code class="filename">/etc/services</code></span></dt><dd><p>This file must contain a mapping of service name + (e.g., swat) to service port (e.g., 901) and protocol type + (e.g., tcp). </p></dd><dt><span class="term"><code class="filename">/usr/local/samba/lib/smb.conf</code></span></dt><dd><p>This is the default location of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> server configuration file that swat edits. Other + common places that systems install this file are <code class="filename"> + /usr/samba/lib/smb.conf</code> and <code class="filename">/etc/smb.conf + </code>. This file describes all the services the server + is to make available to clients. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id307992"></a><h2>WARNINGS</h2><p><code class="literal">swat</code> will rewrite your <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. It will rearrange the entries and delete all + comments, <em class="parameter"><code>include=</code></em> and <em class="parameter"><code>copy= + </code></em> options. If you have a carefully crafted <code class="filename"> + smb.conf</code> then back it up or don't use swat! </p></div><div class="refsect1" lang="en"><a name="id308034"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308045"></a><h2>SEE ALSO</h2><p><code class="literal">inetd(5)</code>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><a name="id308075"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/tdbbackup.8.html b/docs/htmldocs/manpages/tdbbackup.8.html new file mode 100644 index 0000000000..6364bdf997 --- /dev/null +++ b/docs/htmldocs/manpages/tdbbackup.8.html @@ -0,0 +1,36 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tdbbackup</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tdbbackup.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tdbbackup — tool for backing up and for validating the integrity of samba .tdb files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">tdbbackup</code> [-s suffix] [-v] [-h]</p></div></div><div class="refsect1" lang="en"><a name="id267694"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.1.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(1)</span></a> suite.</p><p><code class="literal">tdbbackup</code> is a tool that may be used to backup samba .tdb + files. This tool may also be used to verify the integrity of the .tdb files prior + to samba startup or during normal operation. If it finds file damage and it finds + a prior backup the backup file will be restored. + </p></div><div class="refsect1" lang="en"><a name="id299213"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h</span></dt><dd><p> + Get help information. + </p></dd><dt><span class="term">-s suffix</span></dt><dd><p> + The <code class="literal">-s</code> option allows the adminisistrator to specify a file + backup extension. This way it is possible to keep a history of tdb backup + files by using a new suffix for each backup. + </p></dd><dt><span class="term">-v</span></dt><dd><p> + The <code class="literal">-v</code> will check the database for damages (currupt data) + which if detected causes the backup to be restored. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299270"></a><h2>COMMANDS</h2><p><span class="emphasis"><em>GENERAL INFORMATION</em></span></p><p> + The <code class="literal">tdbbackup</code> utility can safely be run at any time. It was designed so + that it can be used at any time to validate the integrity of tdb files, even during Samba + operation. Typical usage for the command will be: + </p><p>tdbbackup [-s suffix] *.tdb</p><p> + Before restarting samba the following command may be run to validate .tdb files: + </p><p>tdbbackup -v [-s suffix] *.tdb</p><p> + Samba .tdb files are stored in various locations, be sure to run backup all + .tdb file on the system. Important files includes: + </p><div class="itemizedlist"><ul type="disc"><li><p> + <code class="literal">secrets.tdb</code> - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + </p></li><li><p> + <code class="literal">passdb.tdb</code> - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + </p></li><li><p> + <code class="literal">*.tdb</code> located in the /usr/local/samba/var directory or on some + systems in the /var/cache or /var/lib/samba directories. + </p></li></ul></div></div><div class="refsect1" lang="en"><a name="id266779"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id266788"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities were created by Andrew Tridgell. + Samba is now developed by the Samba Team as an Open Source project similar to the way + the Linux kernel is developed. + </p><p>The tdbbackup man page was written by John H Terpstra.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/tdbdump.8.html b/docs/htmldocs/manpages/tdbdump.8.html new file mode 100644 index 0000000000..9fd92dd9a1 --- /dev/null +++ b/docs/htmldocs/manpages/tdbdump.8.html @@ -0,0 +1,10 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tdbdump</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tdbdump.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tdbdump — tool for printing the contents of a TDB file</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">tdbdump</code> {filename}</p></div></div><div class="refsect1" lang="en"><a name="id267679"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.1.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(1)</span></a> suite.</p><p><code class="literal">tdbdump</code> is a very simple utility that 'dumps' the + contents of a TDB (Trivial DataBase) file to standard output in a + human-readable format. + </p><p>This tool can be used when debugging problems with TDB files. It is + intended for those who are somewhat familiar with Samba internals. + </p></div><div class="refsect1" lang="en"><a name="id299201"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id299212"></a><h2>AUTHOR</h2><p> + The original Samba software and related utilities were created by Andrew Tridgell. + Samba is now developed by the Samba Team as an Open Source project similar to the way + the Linux kernel is developed. + </p><p>The tdbdump man page was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/tdbtool.8.html b/docs/htmldocs/manpages/tdbtool.8.html new file mode 100644 index 0000000000..69f38adf91 --- /dev/null +++ b/docs/htmldocs/manpages/tdbtool.8.html @@ -0,0 +1,65 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tdbtool</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tdbtool.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tdbtool — manipulate the contents TDB files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">tdbtool</code></p></div><div class="cmdsynopsis"><p><code class="literal">tdbtool</code> + <em class="replaceable"><code>TDBFILE</code></em> + [ + <em class="replaceable"><code>COMMANDS</code></em> + ...]</p></div></div><div class="refsect1" lang="en"><a name="id267705"></a><h2>DESCRIPTION</h2><p>This tool is part of the + <a href="samba.1.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(1)</span></a> suite.</p><p><code class="literal">tdbtool</code> a tool for displaying and + altering the contents of Samba TDB (Trivial DataBase) files. Each + of the commands listed below can be entered interactively or + provided on the command line.</p></div><div class="refsect1" lang="en"><a name="id299222"></a><h2>COMMANDS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">create</code> + <em class="replaceable"><code>TDBFILE</code></em></span></dt><dd><p>Create a new database named + <em class="replaceable"><code>TDBFILE</code></em>. + </p></dd><dt><span class="term"><code class="option">open</code> + <em class="replaceable"><code>TDBFILE</code></em></span></dt><dd><p>Open an existing database named + <em class="replaceable"><code>TDBFILE</code></em>. + </p></dd><dt><span class="term"><code class="option">erase</code></span></dt><dd><p>Erase the current database. + </p></dd><dt><span class="term"><code class="option">dump</code></span></dt><dd><p>Dump the current database as strings. + </p></dd><dt><span class="term"><code class="option">cdump</code></span></dt><dd><p>Dump the current database as connection records. + </p></dd><dt><span class="term"><code class="option">keys</code></span></dt><dd><p>Dump the current database keys as strings. + </p></dd><dt><span class="term"><code class="option">hexkeys</code></span></dt><dd><p>Dump the current database keys as hex values. + </p></dd><dt><span class="term"><code class="option">info</code></span></dt><dd><p>Print summary information about the + current database. + </p></dd><dt><span class="term"><code class="option">insert</code> + <em class="replaceable"><code>KEY</code></em> + <em class="replaceable"><code>DATA</code></em> + </span></dt><dd><p>Insert a record into the + current database. + </p></dd><dt><span class="term"><code class="option">move</code> + <em class="replaceable"><code>KEY</code></em> + <em class="replaceable"><code>TDBFILE</code></em> + </span></dt><dd><p>Move a record from the + current database into <em class="replaceable"><code>TDBFILE</code></em>. + </p></dd><dt><span class="term"><code class="option">store</code> + <em class="replaceable"><code>KEY</code></em> + <em class="replaceable"><code>DATA</code></em> + </span></dt><dd><p>Store (replace) a record in the + current database. + </p></dd><dt><span class="term"><code class="option">show</code> + <em class="replaceable"><code>KEY</code></em> + </span></dt><dd><p>Show a record by key. + </p></dd><dt><span class="term"><code class="option">delete</code> + <em class="replaceable"><code>KEY</code></em> + </span></dt><dd><p>Delete a record by key. + </p></dd><dt><span class="term"><code class="option">list</code> + </span></dt><dd><p>Print the current database hash table and free list. + </p></dd><dt><span class="term"><code class="option">free</code> + </span></dt><dd><p>Print the current database and free list. + </p></dd><dt><span class="term"><code class="option">!</code> + <em class="replaceable"><code>COMMAND</code></em> + </span></dt><dd><p>Execute the given system command. + </p></dd><dt><span class="term"> + <code class="option">first</code> + </span></dt><dd><p>Print the first record in the current database. + </p></dd><dt><span class="term"> + <code class="option">next</code> + </span></dt><dd><p>Print the next record in the current database. + </p></dd><dt><span class="term"> + <code class="option">quit</code> + </span></dt><dd><p>Exit <code class="literal">tdbtool</code>. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266994"></a><h2>CAVEATS</h2><p>The contents of the Samba TDB files are private + to the implementation and should not be altered with + <code class="literal">tdbtool</code>. + </p></div><div class="refsect1" lang="en"><a name="id267010"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id267021"></a><h2>AUTHOR</h2><p> The original Samba software and related utilities were + created by Andrew Tridgell. Samba is now developed by the + Samba Team as an Open Source project similar to the way the + Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/testparm.1.html b/docs/htmldocs/manpages/testparm.1.html new file mode 100644 index 0000000000..ff42f34ffe --- /dev/null +++ b/docs/htmldocs/manpages/testparm.1.html @@ -0,0 +1,60 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>testparm</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="testparm.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>testparm — check an smb.conf configuration file for + internal correctness</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">testparm</code> [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]</p></div></div><div class="refsect1" lang="en"><a name="id299215"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">testparm</code> is a very simple test program + to check an <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> configuration file for + internal correctness. If this program reports no problems, you + can use the configuration file with confidence that <code class="literal">smbd + </code> will successfully load the configuration file.</p><p>Note that this is <span class="emphasis"><em>NOT</em></span> a guarantee that + the services specified in the configuration file will be + available or will operate as expected. </p><p>If the optional host name and host IP address are + specified on the command line, this test program will run through + the service entries reporting whether the specified host + has access to each service. </p><p>If <code class="literal">testparm</code> finds an error in the <code class="filename"> + smb.conf</code> file it returns an exit code of 1 to the calling + program, else it returns an exit code of 0. This allows shell scripts + to test the output from <code class="literal">testparm</code>.</p></div><div class="refsect1" lang="en"><a name="id266726"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s</span></dt><dd><p>Without this option, <code class="literal">testparm</code> + will prompt for a carriage return after printing the service + names and before dumping the service definitions.</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-L servername</span></dt><dd><p>Sets the value of the %L macro to <em class="replaceable"><code>servername</code></em>. + This is useful for testing include files specified with the + %L macro. </p></dd><dt><span class="term">-v</span></dt><dd><p>If this option is specified, testparm + will also output all options that were not used in <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> and are thus set to their defaults.</p></dd><dt><span class="term">-t encoding</span></dt><dd><p> + Output data in specified encoding. + </p></dd><dt><span class="term">--parameter-name parametername</span></dt><dd><p> + Dumps the named parameter. If no section-name is set the view + is limited by default to the global section. + + It is also possible to dump a parametrical option. Therfore + the option has to be separated by a colon from the + parametername. + </p></dd><dt><span class="term">--section-name sectionname</span></dt><dd><p> + Dumps the named section. + </p></dd><dt><span class="term">configfilename</span></dt><dd><p>This is the name of the configuration file + to check. If this parameter is not present then the + default <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file will be checked. + </p></dd><dt><span class="term">hostname</span></dt><dd><p>If this parameter and the following are + specified, then <code class="literal">testparm</code> will examine the <em class="parameter"><code>hosts + allow</code></em> and <em class="parameter"><code>hosts deny</code></em> + parameters in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file to + determine if the hostname with this IP address would be + allowed access to the <code class="literal">smbd</code> server. If + this parameter is supplied, the hostIP parameter must also + be supplied.</p></dd><dt><span class="term">hostIP</span></dt><dd><p>This is the IP address of the host specified + in the previous parameter. This address must be supplied + if the hostname parameter is supplied. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266947"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></span></dt><dd><p>This is usually the name of the configuration + file used by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266982"></a><h2>DIAGNOSTICS</h2><p>The program will issue a message saying whether the + configuration file loaded OK or not. This message may be preceded by + errors and warnings if the file did not load. If the file was + loaded OK, the program then dumps all known service details + to stdout. </p></div><div class="refsect1" lang="en"><a name="id266994"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id267005"></a><h2>SEE ALSO</h2><p><a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id307889"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> + ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/umount.cifs.8.html b/docs/htmldocs/manpages/umount.cifs.8.html new file mode 100644 index 0000000000..fc61900300 --- /dev/null +++ b/docs/htmldocs/manpages/umount.cifs.8.html @@ -0,0 +1,35 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>umount.cifs</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="umount.cifs.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>umount.cifs — for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">umount.cifs</code> {mount-point} [-nVvhfle]</p></div></div><div class="refsect1" lang="en"><a name="id267688"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>umount.cifs unmounts a Linux CIFS filesystem. It can be invoked +indirectly by the +<a href="umount.8.html"><span class="citerefentry"><span class="refentrytitle">umount</span>(8)</span></a> command +when umount.cifs is in /sbin directory, unless you specify the "-i" option to umount. Specifying -i to umount avoids execution of umount helpers such as umount.cifs. The umount.cifs command only works in Linux, and the kernel must +support the cifs filesystem. The CIFS protocol is the successor to the +SMB protocol and is supported by most Windows servers and many other +commercial servers and Network Attached Storage appliances as well as +by the popular Open Source server Samba. + </p><p> + The umount.cifs utility detaches the local directory <span class="emphasis"><em>mount-point</em></span> from the corresponding UNC name (exported network resource) and frees the associated kernel resources. +It is possible to set the mode for umount.cifs to +setuid root (or equivalently update the /etc/permissions file) to allow non-root users to umount shares to directories for which they have write permission. The umount.cifs utility is typically +not needed if unmounts need only be performed by root users, or if user mounts and unmounts +can rely on specifying explicit entries in /etc/fstab See</p><p><a href="fstab.5.html"><span class="citerefentry"><span class="refentrytitle">fstab</span>(5)</span></a></p></div><div class="refsect1" lang="en"><a name="id299229"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">--verbose</span></dt><dd><p>print additional debugging information</p></dd><dt><span class="term">--no-mtab</span></dt><dd><p>Do not update the mtab even if unmount completes successfully (/proc/mounts will still display the correct information)</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299262"></a><h2>NOTES</h2><p>This command is normally intended to be installed setuid (since root users can already run unmount). An alternative to using umount.cifs is to add specfic entries for the user mounts that you wish a particular user or users to mount and unmount to /etc/fstab</p></div><div class="refsect1" lang="en"><a name="id299275"></a><h2>CONFIGURATION</h2><p> +The primary mechanism for making configuration changes and for reading +debug information for the cifs vfs is via the Linux /proc filesystem. +In the directory <code class="filename">/proc/fs/cifs</code> are various +configuration files and pseudo files which can display debug information. +For more information see the kernel file <code class="filename">fs/cifs/README</code>. +</p></div><div class="refsect1" lang="en"><a name="id266734"></a><h2>BUGS</h2><p>At this time umount.cifs does not lock the mount table using the same lock as the umount utility does, so do not attempt to do multiple unmounts from different processes (and in particular unmounts of a cifs mount and another type of filesystem mount at the same time). + </p><p>If the same mount point is mounted multiple times by cifs, umount.cifs will remove all of the matching entries from the mount table (although umount.cifs will actually only unmount the last one), rather than only removing the last matching entry in /etc/mtab. The pseudofile /proc/mounts will display correct information though, and the lack of an entry in /etc/mtab does not prevent subsequent unmounts.</p><p> +Note that the typical response to a bug report is a suggestion +to try the latest version first. So please try doing that first, +and always include which versions you use of relevant software +when reporting bugs (minimum: umount.cifs (try umount.cifs -V), kernel (see /proc/version) and +server type you are trying to contact. +</p></div><div class="refsect1" lang="en"><a name="id266759"></a><h2>VERSION</h2><p>This man page is correct for version 1.34 of + the cifs vfs filesystem (roughly Linux kernel 2.6.12).</p></div><div class="refsect1" lang="en"><a name="id266770"></a><h2>SEE ALSO</h2><p> + Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel + source tree may contain additional options and information. +</p><p><a href="mount.cifs.8.html"><span class="citerefentry"><span class="refentrytitle">mount.cifs</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id266790"></a><h2>AUTHOR</h2><p>Steve French</p><p>The syntax was loosely based on the umount utility and the manpage was loosely based on that of mount.cifs.8. The man page was created by Steve French</p><p>The maintainer of the Linux cifs vfs and the userspace + tool <span class="emphasis"><em>umount.cifs</em></span> is <a href="mailto:sfrench@samba.org" target="_top">Steve French</a>. + The <a href="mailto:linux-cifs-client@lists.samba.org" target="_top">Linux CIFS Mailing list</a> + is the preferred place to ask questions regarding these programs. + </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_audit.8.html b/docs/htmldocs/manpages/vfs_audit.8.html new file mode 100644 index 0000000000..3a7922853e --- /dev/null +++ b/docs/htmldocs/manpages/vfs_audit.8.html @@ -0,0 +1,19 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_audit</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_audit.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_audit — record selected Samba VFS operations in the system log</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = audit</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_audit</code> VFS module records selected + client operations to the system log using + <a href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a>.</p><p>The following Samba VFS operations are recorded:</p><table class="simplelist" border="0" summary="Simple list"><tr><td>connect</td></tr><tr><td>disconnect</td></tr><tr><td>opendir</td></tr><tr><td>mkdir</td></tr><tr><td>rmdir</td></tr><tr><td>open</td></tr><tr><td>close</td></tr><tr><td>rename</td></tr><tr><td>unlink</td></tr><tr><td>chmod</td></tr><tr><td>fchmod</td></tr><tr><td>chmod_acl</td></tr><tr><td>fchmod_acl</td></tr></table><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299254"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">audit:facility = FACILITY</span></dt><dd><p>Log messages to the named + <a href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a> facility. + + </p></dd><dt><span class="term">audit:priority = PRIORITY</span></dt><dd><p>Log messages with the named + <a href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a> priority. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266742"></a><h2>EXAMPLES</h2><p>Log operations on all shares using the LOCAL1 facility + and NOTICE priority:</p><pre class="programlisting"> + <em class="parameter"><code>[global]</code></em> + <a class="indexterm" name="id266761"></a>vfs objects = audit + <a class="indexterm" name="id266768"></a>audit:facility = LOCAL1 + <a class="indexterm" name="id266776"></a>audit:priority = NOTICE +</pre></div><div class="refsect1" lang="en"><a name="id266785"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266796"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_cacheprime.8.html b/docs/htmldocs/manpages/vfs_cacheprime.8.html new file mode 100644 index 0000000000..73b4fb2f7a --- /dev/null +++ b/docs/htmldocs/manpages/vfs_cacheprime.8.html @@ -0,0 +1,26 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_cacheprime</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_cacheprime.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_cacheprime — prime the kernel file data cache</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = cacheprime</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_cacheprime</code> VFS module reads chunks + of file data near the range requested by clients in order to + make sure the data is present in the kernel file data cache at + the time when it is actually requested by clients. </p><p>The size of the disk read operations performed + by <code class="literal">vfs_cacheprime</code> is determined by the + cacheprime:rsize option. All disk read operations are aligned + on boundaries that are a multiple of this size. Each range of + the file data is primed at most once during the time the client + has the file open. </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299206"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">cacheprime:rsize = BYTES</span></dt><dd><p>The number of bytes with which to prime + the kernel data cache.</p><p>The following suffixes may be applied to BYTES:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">K</code> - BYTES is a number of kilobytes</p></li><li><p><code class="literal">M</code> - BYTES is a number of megabytes</p></li><li><p><code class="literal">G</code> - BYTES is a number of gigabytes</p></li></ul></div></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299262"></a><h2>EXAMPLES</h2><p>For a hypothetical disk array, it is necessary to ensure + that all read operations are of size 1 megabyte (1048576 bytes), + and aligned on 1 megabyte boundaries: + </p><pre class="programlisting"> + <em class="parameter"><code>[hypothetical]</code></em> + <a class="indexterm" name="id266718"></a>vfs objects = cacheprime + <a class="indexterm" name="id266725"></a>cacheprime:rsize = 1M +</pre></div><div class="refsect1" lang="en"><a name="id266734"></a><h2>CAVEATS</h2><p><code class="literal">cacheprime</code> is not a a substitute for + a general-purpose readahead mechanism. It is intended for use + only in very specific environments where disk operations must + be aligned and sized to known values (as much as that is possible). + </p></div><div class="refsect1" lang="en"><a name="id266751"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266761"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_cap.8.html b/docs/htmldocs/manpages/vfs_cap.8.html new file mode 100644 index 0000000000..4c6cf7c6c8 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_cap.8.html @@ -0,0 +1,17 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_cap</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_cap.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_cap — CAP encode filenames</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = cap</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>CAP (Columbia Appletalk Protocol) encoding is a + technique for representing non-ASCII filenames in ASCII. The + <code class="literal">vfs_cap</code> VFS module translates filenames to and + from CAP format, allowing users to name files in their native + encoding. </p><p>CAP encoding is most commonly + used in Japanese language environments. </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299198"></a><h2>EXAMPLES</h2><p>On a system using GNU libiconv, use CAP encoding to support + users in the Shift_JIS locale:</p><pre class="programlisting"> + <em class="parameter"><code>[global]</code></em> + <a class="indexterm" name="id299217"></a>dos charset = CP932 + <a class="indexterm" name="id299224"></a>dos charset = CP932 + <a class="indexterm" name="id299232"></a>vfs objects = cap +</pre></div><div class="refsect1" lang="en"><a name="id299241"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id299251"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_catia.8.html b/docs/htmldocs/manpages/vfs_catia.8.html new file mode 100644 index 0000000000..eb83c79511 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_catia.8.html @@ -0,0 +1,14 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_catia</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_catia.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_catia — translate illegal characters in Catia filenames</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = catia</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The Catia CAD package commonly creates filenames that + use characters that are illegal in CIFS filenames. The + <code class="literal">vfs_catia</code> VFS module implements a fixed character + mapping so that these files can be shared with CIFS clients. + </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id267704"></a><h2>EXAMPLES</h2><p>Map Catia filenames on the [CAD] share:</p><pre class="programlisting"> + <em class="parameter"><code>[CAD]</code></em> + <a class="indexterm" name="id299213"></a>path = /data/cad + <a class="indexterm" name="id299220"></a>vfs objects = catia +</pre></div><div class="refsect1" lang="en"><a name="id299229"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id299240"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_commit.8.html b/docs/htmldocs/manpages/vfs_commit.8.html new file mode 100644 index 0000000000..203f420122 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_commit.8.html @@ -0,0 +1,24 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_commit</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_commit.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_commit — flush dirty data at specified intervals</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = commit</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_commit</code> VFS module keeps track of + the amount of data written to a file and synchronizes it to + disk when a specified amount accumulates. + </p><p><code class="literal">vfs_commit</code> is useful in two + circumstances. First, if you have very precious data, the + impact of unexpected power loss can be minimized by a small + commit:dthresh value. Secondly, write performance can be + improved on some systems by flushing file data early and at + regular intervals.</p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299204"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">commit:dthresh = BYTES</span></dt><dd><p>Synchronize file data each time the specified + number of bytes has been written. + </p><p>The following suffixes may be applied to BYTES:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">K</code> - BYTES is a number of kilobytes</p></li><li><p><code class="literal">M</code> - BYTES is a number of megabytes</p></li><li><p><code class="literal">G</code> - BYTES is a number of gigabytes</p></li></ul></div></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299260"></a><h2>EXAMPLES</h2><p>Synchronize the file data on the [precious] share after + every 512 kilobytes (524288 bytes) of data is written:</p><pre class="programlisting"> + <em class="parameter"><code>[precious]</code></em> + <a class="indexterm" name="id266714"></a>path = /data/precious + <a class="indexterm" name="id266722"></a>vfs objects = commit + <a class="indexterm" name="id266729"></a>commit:dthresh = 512K +</pre></div><div class="refsect1" lang="en"><a name="id266738"></a><h2>CAVEATS</h2><p>On some systems, the data synchronization performed by + <code class="literal">commit</code> may reduce performance. + </p></div><div class="refsect1" lang="en"><a name="id266754"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266765"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_default_quota.8.html b/docs/htmldocs/manpages/vfs_default_quota.8.html new file mode 100644 index 0000000000..d0560dbf37 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_default_quota.8.html @@ -0,0 +1,35 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_default_quota</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_default_quota.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_default_quota — store default quota records for Windows clients</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = default_quota</code></p></div></div><div class="refsect1" lang="en"><a name="id267671"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> + suite.</p><p>Many common quota implementations only store + quotas for users and groups, but do not store a default quota. The + <code class="literal">vfs_default_quota</code> module allows Samba to store + default quota values which can be examined using the Windows + Explorer interface. + </p><p>By default, Samba returns NO_LIMIT the default quota and + refuses to update them. <code class="literal">vfs_default_quota</code> maps + the default quota to the quota record of a user. By default the + root user is taken because quota limits for root are typically + not enforced.</p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299204"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">default_quota:uid = UID</span></dt><dd><p>UID specifies the user ID of the quota record where the + default user quota values are stored. + </p></dd><dt><span class="term">default_quota:gid = GID</span></dt><dd><p>GID specifies the group ID of the quota record where the + default group quota values are stored. + </p></dd><dt><span class="term">default_quota:uid nolimit = BOOL</span></dt><dd><p>If this parameter is True, then the user whose + quota record is storing the default user quota will + be reported as having a quota of NO_LIMIT. Otherwise, + the stored values will be reported. + </p></dd><dt><span class="term">default_quota:gid nolimit = BOOL</span></dt><dd><p>If this parameter is True, then the group whose + quota record is storing the default group quota will + be reported as having a quota of NO_LIMIT. Otherwise, + the stored values will be reported. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299271"></a><h2>EXAMPLES</h2><p>Store the default quota record in the quota record for + the user with ID 65535 and report that user as having no quota + limits:</p><pre class="programlisting"> + <em class="parameter"><code>[global]</code></em> + <a class="indexterm" name="id266726"></a>vfs objects = default_quota + <a class="indexterm" name="id266733"></a>default_quota:uid = 65535 + <a class="indexterm" name="id266740"></a>default_quota:uid nolimit = yes +</pre></div><div class="refsect1" lang="en"><a name="id266750"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266760"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_extd_audit.8.html b/docs/htmldocs/manpages/vfs_extd_audit.8.html new file mode 100644 index 0000000000..9cd78a2e32 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_extd_audit.8.html @@ -0,0 +1,14 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_extd_audit</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_extd_audit.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_extd_audit — record selected Samba VFS operations</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = extd_audit</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">extd_audit</code> VFS module records selected + client operations to both the + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> log and + system log (using + <a href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a>).</p><p>Other than logging to the + <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> log, + <code class="literal">vfs_extd_audit</code> is identical to + <a href="vfs_audit.8.html"><span class="citerefentry"><span class="refentrytitle">vfs_audit</span>(8)</span></a>. + </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299233"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id299243"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_fake_perms.8.html b/docs/htmldocs/manpages/vfs_fake_perms.8.html new file mode 100644 index 0000000000..86d1c74129 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_fake_perms.8.html @@ -0,0 +1,17 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_fake_perms</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_fake_perms.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_fake_perms — enable read only Roaming Profiles</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = fake_perms</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_fake_perms</code> VFS module was created + to allow Roaming Profile files and directories to be set (on + the Samba server under UNIX) as read only. This module will, + if installed on the Profiles share, report to the client that + the Profile files and directories are writeable. This satisfies + the client even though the files will never be overwritten as + the client logs out or shuts down. + </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id267706"></a><h2>EXAMPLES</h2><pre class="programlisting"> + <em class="parameter"><code>[Profiles]</code></em> + <a class="indexterm" name="id299211"></a>path = /profiles + <a class="indexterm" name="id299218"></a>vfs objects = fake_perms +</pre></div><div class="refsect1" lang="en"><a name="id299228"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id299238"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_full_audit.8.html b/docs/htmldocs/manpages/vfs_full_audit.8.html new file mode 100644 index 0000000000..e49baf70ac --- /dev/null +++ b/docs/htmldocs/manpages/vfs_full_audit.8.html @@ -0,0 +1,42 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_full_audit</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_full_audit.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_full_audit — record Samba VFS operations in the system log</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = full_audit</code></p></div></div><div class="refsect1" lang="en"><a name="id267671"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_full_audit</code> VFS module records selected + client operations to the system log using + <a href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a>.</p><p><code class="literal">vfs_full_audit</code> is able to record the + complete set of Samba VFS operations:</p><table class="simplelist" border="0" summary="Simple list"><tr><td>aio_cancel</td></tr><tr><td>aio_error</td></tr><tr><td>aio_fsync</td></tr><tr><td>aio_read</td></tr><tr><td>aio_return</td></tr><tr><td>aio_suspend</td></tr><tr><td>aio_write</td></tr><tr><td>chdir</td></tr><tr><td>chflags</td></tr><tr><td>chmod</td></tr><tr><td>chmod_acl</td></tr><tr><td>chown</td></tr><tr><td>close</td></tr><tr><td>closedir</td></tr><tr><td>connect</td></tr><tr><td>disconnect</td></tr><tr><td>disk_free</td></tr><tr><td>fchmod</td></tr><tr><td>fchmod_acl</td></tr><tr><td>fchown</td></tr><tr><td>fget_nt_acl</td></tr><tr><td>fgetxattr</td></tr><tr><td>flistxattr</td></tr><tr><td>fremovexattr</td></tr><tr><td>fset_nt_acl</td></tr><tr><td>fsetxattr</td></tr><tr><td>fstat</td></tr><tr><td>fsync</td></tr><tr><td>ftruncate</td></tr><tr><td>get_nt_acl</td></tr><tr><td>get_quota</td></tr><tr><td>get_shadow_copy_data</td></tr><tr><td>getlock</td></tr><tr><td>getwd</td></tr><tr><td>getxattr</td></tr><tr><td>kernel_flock</td></tr><tr><td>lgetxattr</td></tr><tr><td>link</td></tr><tr><td>linux_setlease</td></tr><tr><td>listxattr</td></tr><tr><td>llistxattr</td></tr><tr><td>lock</td></tr><tr><td>lremovexattr</td></tr><tr><td>lseek</td></tr><tr><td>lsetxattr</td></tr><tr><td>lstat</td></tr><tr><td>mkdir</td></tr><tr><td>mknod</td></tr><tr><td>open</td></tr><tr><td>opendir</td></tr><tr><td>pread</td></tr><tr><td>pwrite</td></tr><tr><td>read</td></tr><tr><td>readdir</td></tr><tr><td>readlink</td></tr><tr><td>realpath</td></tr><tr><td>removexattr</td></tr><tr><td>rename</td></tr><tr><td>rewinddir</td></tr><tr><td>rmdir</td></tr><tr><td>seekdir</td></tr><tr><td>sendfile</td></tr><tr><td>set_nt_acl</td></tr><tr><td>set_quota</td></tr><tr><td>setxattr</td></tr><tr><td>stat</td></tr><tr><td>statvfs</td></tr><tr><td>symlink</td></tr><tr><td>sys_acl_add_perm</td></tr><tr><td>sys_acl_clear_perms</td></tr><tr><td>sys_acl_create_entry</td></tr><tr><td>sys_acl_delete_def_file</td></tr><tr><td>sys_acl_free_acl</td></tr><tr><td>sys_acl_free_qualifier</td></tr><tr><td>sys_acl_free_text</td></tr><tr><td>sys_acl_get_entry</td></tr><tr><td>sys_acl_get_fd</td></tr><tr><td>sys_acl_get_file</td></tr><tr><td>sys_acl_get_perm</td></tr><tr><td>sys_acl_get_permset</td></tr><tr><td>sys_acl_get_qualifier</td></tr><tr><td>sys_acl_get_tag_type</td></tr><tr><td>sys_acl_init</td></tr><tr><td>sys_acl_set_fd</td></tr><tr><td>sys_acl_set_file</td></tr><tr><td>sys_acl_set_permset</td></tr><tr><td>sys_acl_set_qualifier</td></tr><tr><td>sys_acl_set_tag_type</td></tr><tr><td>sys_acl_to_text</td></tr><tr><td>sys_acl_valid</td></tr><tr><td>telldir</td></tr><tr><td>unlink</td></tr><tr><td>utime</td></tr><tr><td>write</td></tr></table><p>In addition to these operations, + <code class="literal">vfs_full_audit</code> recognizes the special operation + names "all" and "none ", which refer to all + the VFS operations and none of the VFS operations respectively. + </p><p><code class="literal">vfs_full_audit</code> records operations in fixed + format consisting of fields separated by '|' characters. The + format is: </p><pre class="programlisting"> + smbd_audit: PREFIX|OPERATION|RESULT|FILE + </pre><p>The record fields are:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">PREFIX</code> - the result of the full_audit:prefix string after variable substitutions</p></li><li><p><code class="literal">OPERATION</code> - the name of the VFS operation</p></li><li><p><code class="literal">RESULT</code> - whether the operation succeeded or failed</p></li><li><p><code class="literal">FILE</code> - the name of the file or directory the operation was performed on</p></li></ul></div><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id307921"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">vfs_full_audit:prefix = STRING</span></dt><dd><p>Prepend audit messages with STRING. STRING is + processed for standard substitution variables listed in + <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>. The default + prefix is "%u|%I". </p></dd><dt><span class="term">vfs_full_audit:success = LIST</span></dt><dd><p>LIST is a list of VFS operations that should be + recorded if they succeed. Operations are specified using + the names listed above. + </p></dd><dt><span class="term">vfs_full_audit:failure = LIST</span></dt><dd><p>LIST is a list of VFS operations that should be + recorded if they failed. Operations are specified using + the names listed above. + </p></dd><dt><span class="term">full_audit:facility = FACILITY</span></dt><dd><p>Log messages to the named + <a href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a> facility. + + </p></dd><dt><span class="term">full_audit:priority = PRIORITY</span></dt><dd><p>Log messages with the named + <a href="syslog.3.html"><span class="citerefentry"><span class="refentrytitle">syslog</span>(3)</span></a> priority. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308026"></a><h2>EXAMPLES</h2><p>Log file and directory open operations on the [records] + share using the LOCAL7 facility and ALERT priority, including + the username and IP address:</p><pre class="programlisting"> + <em class="parameter"><code>[records]</code></em> + <a class="indexterm" name="id308046"></a>path = /data/records + <a class="indexterm" name="id308053"></a>vfs objects = full_audit + <a class="indexterm" name="id308060"></a>full_audit:prefix = %u|%I + <a class="indexterm" name="id308068"></a>full_audit:success = open opendir + <a class="indexterm" name="id308075"></a>full_audit:failure = all + <a class="indexterm" name="id308082"></a>full_audit:facility = LOCAL7 + <a class="indexterm" name="id308089"></a>full_audit:priority = ALERT +</pre></div><div class="refsect1" lang="en"><a name="id308098"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id308109"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_gpfs.8.html b/docs/htmldocs/manpages/vfs_gpfs.8.html new file mode 100644 index 0000000000..27aba67d74 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_gpfs.8.html @@ -0,0 +1,37 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_gpfs</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_gpfs.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_gpfs — gpfs specific samba extensions like acls and prealloc</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = gpfs</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">gpfs</code> VFS module is the home + for all gpfs extensions that Samba requires for proper integration + with GPFS. It uses the GPL library interfaces provided by GPFS. + </p><p>Currently the gpfs vfs module provides extensions in following areas : + </p><div class="itemizedlist"><ul type="disc"><li><p>NFSv4 ACL Interfaces with configurable options for GPFS</p></li><li><p>Kernel oplock support on GPFS</p></li><li><p>Lease support on GPFS</p></li></ul></div><p> + </p><p><code class="literal">NOTE:</code>This module follows the posix-acl behaviour + and hence allows permission stealing via chown. Samba might allow at a later + point in time, to restrict the chown via this module as such restrictions + are the responsibility of the underlying filesystem than of Samba. + </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299224"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">nfs4:mode = [ simple | special ]</span></dt><dd><p> + Enable/Disable substitution of special IDs on GPFS. This parameter + should not affect the windows users in anyway. It only ensures that Samba + sets the special IDs - OWNER@ and GROUP@ ( mappings to simple uids ) + that are relevant to GPFS. + </p><p>The following MODEs are understood by the module:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">simple(default)</code> - do not use special IDs in GPFS ACEs</p></li><li><p><code class="literal">special</code> - use special IDs in GPFS ACEs. </p></li></ul></div></dd><dt><span class="term">nfs4:acedup = [dontcare|reject|ignore|merge]</span></dt><dd><p> + This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs. + GPFS allows/creates duplicate ACE for different bits for same ID. + </p><p>Following is the behaviour of Samba for different values :</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">dontcare (default)</code> - copy the ACEs as they come</p></li><li><p><code class="literal">reject</code> - stop operation and exit with error on ACL set op</p></li><li><p><code class="literal">ignore</code> - don't include the second matching ACE</p></li><li><p><code class="literal">merge</code> - bitwise OR the 2 ace.flag fields and 2 ace.mask fields of the 2 duplicate ACEs into 1 ACE</p></li></ul></div></dd><dt><span class="term">nfs4:chown = [yes|no]</span></dt><dd><p>This parameter allows enabling or disabling the chown supported + by the underlying filesystem. This parameter should be enabled with + care as it might leave your system insecure.</p><p>Some filesystems allow chown as a) giving b) stealing. It is the latter + that is considered a risk.</p><p>Following is the behaviour of Samba for different values : </p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">yes</code> - Enable chown if as supported by the under filesystem</p></li><li><p><code class="literal">no (default)</code> - Disable chown</p></li></ul></div></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266814"></a><h2>EXAMPLES</h2><p>A GPFS mount can be exported via Samba as follows :</p><pre class="programlisting"> + <em class="parameter"><code>[samba_gpfs_share]</code></em> + <a class="indexterm" name="id266834"></a>vfs objects = gpfs + <a class="indexterm" name="id266841"></a>path = /test/gpfs_mount + <a class="indexterm" name="id266848"></a>nfs4: mode = special + <a class="indexterm" name="id266877"></a>nfs4: acedup = merge +</pre></div><div class="refsect1" lang="en"><a name="id266886"></a><h2>CAVEATS</h2><p>The gpfs gpl libraries are required by <code class="literal">gpfs</code> VFS + module during both compilation and runtime. + Also this VFS module is tested to work on SLES 9/10 and RHEL 4.4 + </p></div><div class="refsect1" lang="en"><a name="id266903"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266914"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The GPFS VFS module was created with contributions from + Volker Lendecke and the developers at IBM. + </p><p> This manpage was created by the IBM FSCC team </p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_netatalk.8.html b/docs/htmldocs/manpages/vfs_netatalk.8.html new file mode 100644 index 0000000000..99bfec138c --- /dev/null +++ b/docs/htmldocs/manpages/vfs_netatalk.8.html @@ -0,0 +1,15 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_netatalk</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_netatalk.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_netatalk — hide .AppleDouble files from CIFS clients</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = netatalk</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_netatalk</code> VFS module dynamically + hides .AppleDouble files, preventing spurious errors on some + CIFS clients. .AppleDouble files may be created by historic + implementations of AFP (Apple Filing Protocol) on servers. </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id267704"></a><h2>EXAMPLES</h2><p>Hide .AppleDouble files on the [data] share:</p><pre class="programlisting"> + <em class="parameter"><code>[data]</code></em> + <a class="indexterm" name="id299213"></a>vfs objects = netatalk +</pre></div><div class="refsect1" lang="en"><a name="id299222"></a><h2>CAVEATS</h2><p>This module is largely historic and unlikely to be of use + in modern networks since current Apple systems are able to mount CIFS + shares natively. + </p></div><div class="refsect1" lang="en"><a name="id299233"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id299244"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_notify_fam.8.html b/docs/htmldocs/manpages/vfs_notify_fam.8.html new file mode 100644 index 0000000000..67ee47ea70 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_notify_fam.8.html @@ -0,0 +1,12 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_notify_fam</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_notify_fam.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_notify_fam — FAM support for file change notifications</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = notify_fam</code></p></div></div><div class="refsect1" lang="en"><a name="id267671"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_notify_fam</code> module makes use of + the system FAM (File Alteration Monitor) daemon to implement + file change notifications for Windows clients. FAM is generally + present only on IRIX and some BSD systems.</p><p>This module is not stackable.</p></div><div class="refsect1" lang="en"><a name="id267703"></a><h2>EXAMPLES</h2><p>Support FAM notifications globally:</p><pre class="programlisting"> + <em class="parameter"><code>[global]</code></em> + <a class="indexterm" name="id299212"></a>vfs objects = notify_fam +</pre></div><div class="refsect1" lang="en"><a name="id299222"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id299232"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_prealloc.8.html b/docs/htmldocs/manpages/vfs_prealloc.8.html new file mode 100644 index 0000000000..fde6653a66 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_prealloc.8.html @@ -0,0 +1,22 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_prealloc</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_prealloc.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_prealloc — preallocate matching files to a predetermined size</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = prealloc</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_prealloc</code> VFS module preallocates + files to a specified size each time a new file is created. This + is useful in environments where files are of a predetermined + size will be written to a disk subsystem where extending file + allocations is expensive. </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id267704"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">prealloc:EXT = BYTES</span></dt><dd><p>Preallocate all files with the extension EXT to + the size specified by BYTES. + </p><p>The following suffixes may be applied to BYTES:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">K</code> - BYTES is a number of kilobytes</p></li><li><p><code class="literal">M</code> - BYTES is a number of megabytes</p></li><li><p><code class="literal">G</code> - BYTES is a number of gigabytes</p></li></ul></div></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299251"></a><h2>EXAMPLES</h2><p>A process writes TIFF files to a Samba share, and the + is known these files will almost always be around 4 megabytes + (4194304 bytes): </p><pre class="programlisting"> + <em class="parameter"><code>[frames]</code></em> + <a class="indexterm" name="id299271"></a>path = /data/frames + <a class="indexterm" name="id266713"></a>vfs objects = prealloc + <a class="indexterm" name="id266721"></a>prealloc:tiff = 4M +</pre></div><div class="refsect1" lang="en"><a name="id266730"></a><h2>CAVEATS</h2><p><code class="literal">vfs_prealloc</code> is not supported on all + platforms and filesystems. Currently only XFS filesystems on + Linux and IRIX are supported. + </p></div><div class="refsect1" lang="en"><a name="id266745"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266755"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_readahead.8.html b/docs/htmldocs/manpages/vfs_readahead.8.html new file mode 100644 index 0000000000..bb61e8ad07 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_readahead.8.html @@ -0,0 +1,25 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_readahead</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_readahead.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_readahead — pre-load the kernel buffer cache</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = readahead</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>This <code class="literal">vfs_readahead</code> VFS module detects + read requests at multiples of a given offset (hex 0x80000 by + default) and then tells the kernel via either the readahead + system call (on Linux) or the posix_fadvise system call to + pre-fetch this data into the buffer cache.</p><p>This module is useful for Windows Vista clients reading + data using the Windows Explorer program, which asynchronously + does multiple file read requests at offset boundaries of 0x80000 + bytes.</p><p>The offset multiple used is given by the readahead:offset + option, which defaults to 0x80000.</p><p>The size of the disk read operations performed + by <code class="literal">vfs_readahead</code> is determined by the + readahead:length option. By default this is set to the + same value as the readahead:offset option and if not + set explicitly will use the current value of + readahead:offset.</p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299214"></a><h2>OPTIONS</h2><div class="variablelist"><p>The following suffixes may be applied to BYTES:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">K</code> - BYTES is a number of kilobytes</p></li><li><p><code class="literal">M</code> - BYTES is a number of megabytes</p></li><li><p><code class="literal">G</code> - BYTES is a number of gigabytes</p></li></ul></div><dl><dt><span class="term">readahead:offset = BYTES</span></dt><dd><p>The offset multiple that causes readahead to be + requested of the kernel buffer cache.</p></dd><dt><span class="term">readahead:length = BYTES</span></dt><dd><p>The number of bytes requested to be + read into the kernel buffer cache on each + readahead call.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266720"></a><h2>EXAMPLES</h2><pre class="programlisting"> + <em class="parameter"><code>[hypothetical]</code></em> + <a class="indexterm" name="id266736"></a>vfs objects = readahead +</pre></div><div class="refsect1" lang="en"><a name="id266745"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266755"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_readonly.8.html b/docs/htmldocs/manpages/vfs_readonly.8.html new file mode 100644 index 0000000000..7f8ed6b3db --- /dev/null +++ b/docs/htmldocs/manpages/vfs_readonly.8.html @@ -0,0 +1,24 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_readonly</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_readonly.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_readonly — make a Samba share read only for a specified time period</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = readonly</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_readonly</code> VFS module marks a share + as read only for all clients connecting within the configured + time period. Clients connecting during this time will be denied + write access to all files in the share, irrespective of ther + actual access privileges.</p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id267704"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">readonly:period = BEGIN, END</span></dt><dd><p>Only mark the share as read only if the client + connection was made between the times marked by the + BEGIN and END date specifiers. + The syntax of these date specifiers is the + same as that accepted by the -d option of GNU + <a href="date.1.html"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a>. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id299226"></a><h2>EXAMPLES</h2><p>Mark all shares read only:</p><pre class="programlisting"> + <em class="parameter"><code>[global]</code></em> + <a class="indexterm" name="id299245"></a>vfs objects = readonly +</pre><p>Mark the [backup] share as read only during business hours:</p><pre class="programlisting"> + <em class="parameter"><code>[backup]</code></em> + <a class="indexterm" name="id299268"></a>path = /readonly + <a class="indexterm" name="id299275"></a>vfs objects = readonly + <a class="indexterm" name="id266717"></a>readonly:period = readonly:period = "today 9:00","today 17:00" +</pre></div><div class="refsect1" lang="en"><a name="id266726"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266736"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_recycle.8.html b/docs/htmldocs/manpages/vfs_recycle.8.html new file mode 100644 index 0000000000..4d3901b43a --- /dev/null +++ b/docs/htmldocs/manpages/vfs_recycle.8.html @@ -0,0 +1,60 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_recycle</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_recycle.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_recycle — Samba VFS recycle bin</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = recycle</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_recycle</code> intercepts file deletion + requests and moves the affected files to a temporary repository + rather than deleting them immediately. This gives the same effect + as the Recycle Bin on Windows computers. </p><p>The Recycle Bin will not appear in Windows Explorer + views of the network file system (share) nor on any mapped + drive. Instead, a directory called .recycle will be automatically + created when the first file is deleted and recycle:repository is + not configured. If recycle:repository is configured, the name + of the created directory depends on recycle:repository. Users + can recover files from the recycle bin. If the recycle:keeptree + option has been specified, deleted files will be found in a path + identical with that from which the file was deleted. </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id299202"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">recycle:repository = PATH</span></dt><dd><p>Path of the directory where deleted files should be moved. + </p><p>If this option is not set, the default path .recycle + is used. </p></dd><dt><span class="term">recycle:directory_mode = MODE</span></dt><dd><p>Set MODE to the octal mode the recycle repository + should be created with. The recycle repository will be + created when first file is deleted. If recycle:subdir_mode + is not set, MODE also applies to subdirectories. + </p><p>If this option is not set, the default mode + 0700 is used. </p></dd><dt><span class="term">recycle:subdir_mode = MODE</span></dt><dd><p>Set MODE to the octal mode with which + sub directories of the recycle repository should be created. + </p><p>If this option is not set, subdirectories + will be created with the mode from recycle:directory_mode. + </p></dd><dt><span class="term">recycle:keeptree = BOOL</span></dt><dd><p>Specifies whether the directory structure should + be preserved or whether the files in a directory that is being + deleted should be kept separately in the repository. + </p></dd><dt><span class="term">recycle:versions = BOOL</span></dt><dd><p>If this option is True, two files with the same + name that are deleted will both be kept in the repository. + Newer deleted versions of a file will be called + "Copy #x of filename". + </p></dd><dt><span class="term">recycle:touch = BOOL</span></dt><dd><p>Specifies whether a file's access date should be + updated when the file is moved to the repository. + </p></dd><dt><span class="term">recycle:touch_mtime = BOOL</span></dt><dd><p>Specifies whether a file's last modified date should be + updated when the file is moved to the repository. + </p></dd><dt><span class="term">recycle:minsize = BYTES</span></dt><dd><p>Files that are smaller than the number of bytes + specified by this parameter will not be put into the + repository. + </p></dd><dt><span class="term">recycle:maxsize = BYTES</span></dt><dd><p>Files that are larger than the number of bytes + specified by this parameter will not be put into the + repository. + </p></dd><dt><span class="term">recycle:exclude = LIST</span></dt><dd><p>List of files that should not be put into the + repository when deleted, but deleted in the normal way. + Wildcards such as * and ? are supported. + </p></dd><dt><span class="term">recycle:exclude_dir = LIST</span></dt><dd><p>List of directories whose files should not be put + into the repository when deleted, but deleted in the + normal way. Wildcards such as * and ? are supported. + </p></dd><dt><span class="term">recycle:noversions = LIST</span></dt><dd><p>Specifies a list of paths (wildcards such as * + and ? are supported) for which no versioning should + be used. Only useful when recycle:versions is enabled. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266831"></a><h2>EXAMPLES</h2><p>Log operations on all shares using the LOCAL1 facility + and NOTICE priority:</p><pre class="programlisting"> + <em class="parameter"><code>[global]</code></em> + <a class="indexterm" name="id266850"></a>vfs objects = recycle + <a class="indexterm" name="id266880"></a>recycle:facility = LOCAL1 + <a class="indexterm" name="id266887"></a>recycle:priority = NOTICE +</pre></div><div class="refsect1" lang="en"><a name="id266896"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266907"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfs_shadow_copy.8.html b/docs/htmldocs/manpages/vfs_shadow_copy.8.html new file mode 100644 index 0000000000..463787db98 --- /dev/null +++ b/docs/htmldocs/manpages/vfs_shadow_copy.8.html @@ -0,0 +1,32 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_shadow_copy</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfs_shadow_copy.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_shadow_copy — Make a Samba share read only for a specified time period</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = shadow_copy</code></p></div></div><div class="refsect1" lang="en"><a name="id267672"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the + <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_shadow_copy</code> VFS module functionality + that is similar to Microsoft Shadow Copy services. When setup properly, + this module allows Microsoft Shadow Copy clients to browse + "shadow copies" on Samba shares. + </p><p>This module is stackable.</p></div><div class="refsect1" lang="en"><a name="id267704"></a><h2>CONFIGURATION</h2><p><code class="literal">vfs_shadow_copy</code> relies on a filesystem + snapshot implementation. Many common filesystems have native + support for this. + </p><p>Filesystem snapshots must be mounted on + specially named directories in order to be recognized by + <code class="literal">vfs_shadow_copy</code>. The snapshot mount points must + be immediate children of a the directory being shared.</p><p>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, + where: + </p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">YYYY</code> is the 4 digit year</p></li><li><p><code class="literal">MM</code> is the 2 digit month</p></li><li><p><code class="literal">DD</code> is the 2 digit day</p></li><li><p><code class="literal">hh</code> is the 2 digit hour</p></li><li><p><code class="literal">mm</code> is the 2 digit minute</p></li><li><p><code class="literal">ss</code> is the 2 digit second.</p></li></ul></div><p> + </p><p>The <code class="literal">vfs_shadow_copy</code> snapshot naming convention can be produced with the following + <a href="date.1.html"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> command: + </p><pre class="programlisting"> + TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S + </pre></div><div class="refsect1" lang="en"><a name="id266738"></a><h2>EXAMPLES</h2><p>Add shadow copy support to user home directories:</p><pre class="programlisting"> + <em class="parameter"><code>[homes]</code></em> + <a class="indexterm" name="id266757"></a>vfs objects = shadow_copy +</pre></div><div class="refsect1" lang="en"><a name="id266766"></a><h2>CAVEATS</h2><p>This is not a backup, archival, or version control solution. + </p><p>With Samba or Windows servers, + <code class="literal">vfs_shadow_copy</code> is designed to be an end-user + tool only. It does not replace or enhance your backup and + archival solutions and should in no way be considered as + such. Additionally, if you need version control, implement a + version control system.</p></div><div class="refsect1" lang="en"><a name="id266788"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite. + </p></div><div class="refsect1" lang="en"><a name="id266799"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/vfstest.1.html b/docs/htmldocs/manpages/vfstest.1.html new file mode 100644 index 0000000000..bcd1b802e8 --- /dev/null +++ b/docs/htmldocs/manpages/vfstest.1.html @@ -0,0 +1,41 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfstest</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfstest.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfstest — tool for testing samba VFS modules </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfstest</code> [-d debuglevel] [-c command] [-l logdir] [-h]</p></div></div><div class="refsect1" lang="en"><a name="id267702"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">vfstest</code> is a small command line + utility that has the ability to test dso samba VFS modules. It gives the + user the ability to call the various VFS functions manually and + supports cascaded VFS modules. + </p></div><div class="refsect1" lang="en"><a name="id299220"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-c|--command=command</span></dt><dd><p>Execute the specified (colon-separated) commands. + See below for the commands that are available. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension + <code class="constant">'.client'</code> will be appended. The log file is never removed + by the client. + </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id266729"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id266793"></a><h2>COMMANDS</h2><p><span class="emphasis"><em>VFS COMMANDS</em></span></p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">load <module.so></code> - Load specified VFS module </p></li><li><p><code class="literal">populate <char> <size></code> - Populate a data buffer with the specified data + </p></li><li><p><code class="literal">showdata [<offset> <len>]</code> - Show data currently in data buffer + </p></li><li><p><code class="literal">connect</code> - VFS connect()</p></li><li><p><code class="literal">disconnect</code> - VFS disconnect()</p></li><li><p><code class="literal">disk_free</code> - VFS disk_free()</p></li><li><p><code class="literal">opendir</code> - VFS opendir()</p></li><li><p><code class="literal">readdir</code> - VFS readdir()</p></li><li><p><code class="literal">mkdir</code> - VFS mkdir()</p></li><li><p><code class="literal">rmdir</code> - VFS rmdir()</p></li><li><p><code class="literal">closedir</code> - VFS closedir()</p></li><li><p><code class="literal">open</code> - VFS open()</p></li><li><p><code class="literal">close</code> - VFS close()</p></li><li><p><code class="literal">read</code> - VFS read()</p></li><li><p><code class="literal">write</code> - VFS write()</p></li><li><p><code class="literal">lseek</code> - VFS lseek()</p></li><li><p><code class="literal">rename</code> - VFS rename()</p></li><li><p><code class="literal">fsync</code> - VFS fsync()</p></li><li><p><code class="literal">stat</code> - VFS stat()</p></li><li><p><code class="literal">fstat</code> - VFS fstat()</p></li><li><p><code class="literal">lstat</code> - VFS lstat()</p></li><li><p><code class="literal">unlink</code> - VFS unlink()</p></li><li><p><code class="literal">chmod</code> - VFS chmod()</p></li><li><p><code class="literal">fchmod</code> - VFS fchmod()</p></li><li><p><code class="literal">chown</code> - VFS chown()</p></li><li><p><code class="literal">fchown</code> - VFS fchown()</p></li><li><p><code class="literal">chdir</code> - VFS chdir()</p></li><li><p><code class="literal">getwd</code> - VFS getwd()</p></li><li><p><code class="literal">utime</code> - VFS utime()</p></li><li><p><code class="literal">ftruncate</code> - VFS ftruncate()</p></li><li><p><code class="literal">lock</code> - VFS lock()</p></li><li><p><code class="literal">symlink</code> - VFS symlink()</p></li><li><p><code class="literal">readlink</code> - VFS readlink()</p></li><li><p><code class="literal">link</code> - VFS link()</p></li><li><p><code class="literal">mknod</code> - VFS mknod()</p></li><li><p><code class="literal">realpath</code> - VFS realpath()</p></li></ul></div><p><span class="emphasis"><em>GENERAL COMMANDS</em></span></p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">conf <smb.conf></code> - Load a different configuration file</p></li><li><p><code class="literal">help [<command>]</code> - Get list of commands or info about specified command</p></li><li><p><code class="literal">debuglevel <level></code> - Set debug level</p></li><li><p><code class="literal">freemem</code> - Free memory currently in use</p></li><li><p><code class="literal">exit</code> - Exit vfstest</p></li></ul></div></div><div class="refsect1" lang="en"><a name="id308072"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><a name="id308083"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The vfstest man page was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/wbinfo.1.html b/docs/htmldocs/manpages/wbinfo.1.html new file mode 100644 index 0000000000..41fba35576 --- /dev/null +++ b/docs/htmldocs/manpages/wbinfo.1.html @@ -0,0 +1,91 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>wbinfo</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="wbinfo.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>wbinfo — Query information from winbind daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">wbinfo</code> [-a user%password] [--all-domains] [--allocate-gid] [--allocate-uid] [-D domain] [--domain domain] [-g] [--getdcname domain] [--get-auth-user] [-G gid] [-h] [-i user] [-I ip] [-K user%password] [-m] [-n name] [-N netbios-name] [--own-domain] [-p] [-r user] [-s sid] [--separator] [--sequence] [--set-auth-user user%password] [-S sid] [-t] [-u] [--uid-info uid] [--user-domgroups sid] [--user-sids sid] [-U uid] [-V] [-Y sid]</p></div></div><div class="refsect1" lang="en"><a name="id266849"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">wbinfo</code> program queries and returns information + created and used by the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon. </p><p>The <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon must be configured + and running for the <code class="literal">wbinfo</code> program to be able + to return information.</p></div><div class="refsect1" lang="en"><a name="id266924"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-a|--authenticate username%password</span></dt><dd><p>Attempt to authenticate a user via winbindd. + This checks both authenticaion methods and reports its results. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Do not be tempted to use this + functionality for authentication in third-party + applications. Instead use <a href="ntlm_auth.1.html"><span class="citerefentry"><span class="refentrytitle">ntlm_auth</span>(1)</span></a>.</p></div></dd><dt><span class="term">--allocate-gid</span></dt><dd><p>Get a new GID out of idmap + </p></dd><dt><span class="term">--allocate-uid</span></dt><dd><p>Get a new UID out of idmap + </p></dd><dt><span class="term">--all-domains</span></dt><dd><p>List all domains (trusted and + own domain). + </p></dd><dt><span class="term">--domain name</span></dt><dd><p>This parameter sets the domain on which any specified + operations will performed. If special domain name '.' is used to represent + the current domain to which winbindd belongs. Currently only the + <code class="option">--sequence</code>, + <code class="option">-u</code>, and <code class="option">-g</code> options honor this parameter. + </p></dd><dt><span class="term">-D|--domain-info domain</span></dt><dd><p>Show most of the info we have about the domain. + </p></dd><dt><span class="term">-g|--domain-groups</span></dt><dd><p>This option will list all groups available + in the Windows NT domain for which the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> daemon is operating in. Groups in all trusted domains + will also be listed. Note that this operation does not assign + group ids to any groups that have not already been + seen by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a>. </p></dd><dt><span class="term">--get-auth-user</span></dt><dd><p>Print username and password used by winbindd + during session setup to a domain controller. Username + and password can be set using <code class="option">--set-auth-user</code>. + Only available for root.</p></dd><dt><span class="term">--getdcname domain</span></dt><dd><p>Get the DC name for the specified domain. + </p></dd><dt><span class="term">-G|--gid-to-sid gid</span></dt><dd><p>Try to convert a UNIX group id to a Windows + NT SID. If the gid specified does not refer to one within + the idmap gid range then the operation will fail. </p></dd><dt><span class="term">-i|--user-info user</span></dt><dd><p>Get user info. + </p></dd><dt><span class="term">-I|--WINS-by-ip ip</span></dt><dd><p>The <em class="parameter"><code>-I</code></em> option + queries <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> to send a node status + request to get the NetBIOS name associated with the IP address + specified by the <em class="parameter"><code>ip</code></em> parameter. + </p></dd><dt><span class="term">-K|--krb5auth username%password</span></dt><dd><p>Attempt to authenticate a user via Kerberos. + </p></dd><dt><span class="term">-m|--trusted-domains</span></dt><dd><p>Produce a list of domains trusted by the + Windows NT server <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> contacts + when resolving names. This list does not include the Windows + NT domain the server is a Primary Domain Controller for. + </p></dd><dt><span class="term">-n|--name-to-sid name</span></dt><dd><p>The <em class="parameter"><code>-n</code></em> option + queries <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> for the SID + associated with the name specified. Domain names can be specified + before the user name by using the winbind separator character. + For example CWDOM1/Administrator refers to the Administrator + user in the domain CWDOM1. If no domain is specified then the + domain used is the one specified in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> <em class="parameter"><code>workgroup + </code></em> parameter. </p></dd><dt><span class="term">-N|--WINS-by-name name</span></dt><dd><p>The <em class="parameter"><code>-N</code></em> option + queries <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> to query the WINS + server for the IP address associated with the NetBIOS name + specified by the <em class="parameter"><code>name</code></em> parameter. + </p></dd><dt><span class="term">--own-domain</span></dt><dd><p>List own domain. + </p></dd><dt><span class="term">-p|--ping</span></dt><dd><p>Check whether winbindd is still alive. + Prints out either 'succeeded' or 'failed'. + </p></dd><dt><span class="term">-r|--user-groups username</span></dt><dd><p>Try to obtain the list of UNIX group ids + to which the user belongs. This only works for users + defined on a Domain Controller. + </p></dd><dt><span class="term">-s|--sid-to-name sid</span></dt><dd><p>Use <em class="parameter"><code>-s</code></em> to resolve + a SID to a name. This is the inverse of the <em class="parameter"><code>-n + </code></em> option above. SIDs must be specified as ASCII strings + in the traditional Microsoft format. For example, + S-1-5-21-1455342024-3071081365-2475485837-500. </p></dd><dt><span class="term">--separator</span></dt><dd><p>Get the active winbind separator. + </p></dd><dt><span class="term">--sequence</span></dt><dd><p>Show sequence numbers of + all known domains</p></dd><dt><span class="term">--set-auth-user username%password</span></dt><dd><p>Store username and password used by winbindd + during session setup to a domain controller. This enables + winbindd to operate in a Windows 2000 domain with Restrict + Anonymous turned on (a.k.a. Permissions compatible with + Windows 2000 servers only). + </p></dd><dt><span class="term">-S|--sid-to-uid sid</span></dt><dd><p>Convert a SID to a UNIX user id. If the SID + does not correspond to a UNIX user mapped by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> then the operation will fail. </p></dd><dt><span class="term">-t|--check-secret</span></dt><dd><p>Verify that the workstation trust account + created when the Samba server is added to the Windows NT + domain is working. </p></dd><dt><span class="term">-u|--domain-users</span></dt><dd><p>This option will list all users available + in the Windows NT domain for which the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon is operating in. Users in all trusted domains + will also be listed. Note that this operation does not assign + user ids to any users that have not already been seen by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> + .</p></dd><dt><span class="term">--uid-info UID</span></dt><dd><p>Get user info for the user conencted to + user id UID.</p></dd><dt><span class="term">--user-domgroups SID</span></dt><dd><p>Get user domain groups. + </p></dd><dt><span class="term">--user-sids SID</span></dt><dd><p>Get user group SIDs for user. + </p></dd><dt><span class="term">-U|--uid-to-sid uid</span></dt><dd><p>Try to convert a UNIX user id to a Windows NT + SID. If the uid specified does not refer to one within + the idmap uid range then the operation will fail. </p></dd><dt><span class="term">-Y|--sid-to-gid sid</span></dt><dd><p>Convert a SID to a UNIX group id. If the SID + does not correspond to a UNIX group mapped by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> then + the operation will fail. </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308346"></a><h2>EXIT STATUS</h2><p>The wbinfo program returns 0 if the operation + succeeded, or 1 if the operation failed. If the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon is not working <code class="literal">wbinfo</code> will always return + failure. </p></div><div class="refsect1" lang="en"><a name="id308372"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308383"></a><h2>SEE ALSO</h2><p><a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> and <a href="ntlm_auth.1.html"><span class="citerefentry"><span class="refentrytitle">ntlm_auth</span>(1)</span></a></p></div><div class="refsect1" lang="en"><a name="id308406"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p><code class="literal">wbinfo</code> and <code class="literal">winbindd</code> + were written by Tim Potter.</p><p>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba + 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> diff --git a/docs/htmldocs/manpages/winbindd.8.html b/docs/htmldocs/manpages/winbindd.8.html new file mode 100644 index 0000000000..b1143c93b5 --- /dev/null +++ b/docs/htmldocs/manpages/winbindd.8.html @@ -0,0 +1,241 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>winbindd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="winbindd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>winbindd — Name Service Switch daemon for resolving names + from NT servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">winbindd</code> [-D] [-F] [-S] [-i] [-Y] [-d <debug level>] [-s <smb config file>] [-n]</p></div></div><div class="refsect1" lang="en"><a name="id299222"></a><h2>DESCRIPTION</h2><p>This program is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">winbindd</code> is a daemon that provides + a number of services to the Name Service Switch capability found + in most modern C libraries, to arbitrary applications via PAM + and <code class="literal">ntlm_auth</code> and to Samba itself.</p><p>Even if winbind is not used for nsswitch, it still provides a + service to <code class="literal">smbd</code>, <code class="literal">ntlm_auth</code> + and the <code class="literal">pam_winbind.so</code> PAM module, by managing connections to + domain controllers. In this configuraiton the + <a class="indexterm" name="id299275"></a>idmap uid and + <a class="indexterm" name="id266717"></a>idmap gid + parameters are not required. (This is known as `netlogon proxy only mode'.)</p><p> The Name Service Switch allows user + and system information to be obtained from different databases + services such as NIS or DNS. The exact behaviour can be configured + throught the <code class="filename">/etc/nsswitch.conf</code> file. + Users and groups are allocated as they are resolved to a range + of user and group ids specified by the administrator of the + Samba system.</p><p>The service provided by <code class="literal">winbindd</code> is called `winbind' and + can be used to resolve user and group information from a + Windows NT server. The service can also provide authentication + services via an associated PAM module. </p><p> + The <code class="filename">pam_winbind</code> module supports the + <em class="parameter"><code>auth</code></em>, <em class="parameter"><code>account</code></em> + and <em class="parameter"><code>password</code></em> + module-types. It should be noted that the + <em class="parameter"><code>account</code></em> module simply performs a getpwnam() to verify that + the system can obtain a uid for the user, as the domain + controller has already performed access control. If the + <code class="filename">libnss_winbind</code> library has been correctly + installed, or an alternate source of names configured, this should always succeed. + </p><p>The following nsswitch databases are implemented by + the winbindd service: </p><div class="variablelist"><dl><dt><span class="term">-D</span></dt><dd><p>If specified, this parameter causes + the server to operate as a daemon. That is, it detaches + itself and runs in the background on the appropriate port. + This switch is assumed if <code class="literal">winbindd</code> is + executed on the command line of a shell. + </p></dd><dt><span class="term">hosts</span></dt><dd><p>This feature is only available on IRIX. + User information traditionally stored in + the <code class="filename">hosts(5)</code> file and used by + <code class="literal">gethostbyname(3)</code> functions. Names are + resolved through the WINS server or by broadcast. + </p></dd><dt><span class="term">passwd</span></dt><dd><p>User information traditionally stored in + the <code class="filename">passwd(5)</code> file and used by + <code class="literal">getpwent(3)</code> functions. </p></dd><dt><span class="term">group</span></dt><dd><p>Group information traditionally stored in + the <code class="filename">group(5)</code> file and used by + <code class="literal">getgrent(3)</code> functions. </p></dd></dl></div><p>For example, the following simple configuration in the + <code class="filename">/etc/nsswitch.conf</code> file can be used to initially + resolve user and group information from <code class="filename">/etc/passwd + </code> and <code class="filename">/etc/group</code> and then from the + Windows NT server. +</p><pre class="programlisting"> +passwd: files winbind +group: files winbind +## only available on IRIX; Linux users should us libnss_wins.so +hosts: files dns winbind +</pre><p>The following simple configuration in the + <code class="filename">/etc/nsswitch.conf</code> file can be used to initially + resolve hostnames from <code class="filename">/etc/hosts</code> and then from the + WINS server.</p><pre class="programlisting"> +hosts: files wins +</pre></div><div class="refsect1" lang="en"><a name="id266957"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-F</span></dt><dd><p>If specified, this parameter causes + the main <code class="literal">winbindd</code> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <code class="literal">winbindd</code> under process supervisors such + as <code class="literal">supervise</code> and <code class="literal">svscan</code> + from Daniel J. Bernstein's <code class="literal">daemontools</code> + package, or the AIX process monitor. + </p></dd><dt><span class="term">-S</span></dt><dd><p>If specified, this parameter causes + <code class="literal">winbindd</code> to log to standard output rather + than a file.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer +from 0 to 10. The default value if this parameter is +not specified is 0.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a class="indexterm" name="id307913"></a> parameter +in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. +</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <code class="filename">smb.conf</code> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension +<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, +log.smbd, etc...). The log file is never removed by the client. +</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-i</span></dt><dd><p>Tells <code class="literal">winbindd</code> to not + become a daemon and detach from the current terminal. This + option is used by developers when interactive debugging + of <code class="literal">winbindd</code> is required. + <code class="literal">winbindd</code> also logs to standard output, + as if the <code class="literal">-S</code> parameter had been given. + </p></dd><dt><span class="term">-n</span></dt><dd><p>Disable caching. This means winbindd will + always have to wait for a response from the domain controller + before it can respond to a client and this thus makes things + slower. The results will however be more accurate, since + results from the cache might not be up-to-date. This + might also temporarily hang winbindd if the DC doesn't respond. + </p></dd><dt><span class="term">-Y</span></dt><dd><p>Single daemon mode. This means winbindd will run + as a single process (the mode of operation in Samba 2.2). Winbindd's + default behavior is to launch a child process that is responsible for + updating expired cache entries. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308052"></a><h2>NAME AND ID RESOLUTION</h2><p>Users and groups on a Windows NT server are assigned + a security id (SID) which is globally unique when the + user or group is created. To convert the Windows NT user or group + into a unix user or group, a mapping between SIDs and unix user + and group ids is required. This is one of the jobs that <code class="literal"> + winbindd</code> performs. </p><p>As winbindd users and groups are resolved from a server, user + and group ids are allocated from a specified range. This + is done on a first come, first served basis, although all existing + users and groups will be mapped as soon as a client performs a user + or group enumeration command. The allocated unix ids are stored + in a database and will be remembered. </p><p>WARNING: The SID to unix id database is the only location + where the user and group mappings are stored by winbindd. If this + store is deleted or corrupted, there is no way for winbindd to + determine which user and group ids correspond to Windows NT user + and group rids. </p><p>See the <a class="indexterm" name="id308084"></a> or the old <a class="indexterm" name="id308089"></a> parameters in + <code class="filename">smb.conf</code> for options for sharing this + database, such as via LDAP.</p></div><div class="refsect1" lang="en"><a name="id308104"></a><h2>CONFIGURATION</h2><p>Configuration of the <code class="literal">winbindd</code> daemon + is done through configuration parameters in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. All parameters should be specified in the + [global] section of smb.conf. </p><div class="itemizedlist"><ul type="disc"><li><p> + <a class="indexterm" name="id308134"></a>winbind separator</p></li><li><p> + <a class="indexterm" name="id308145"></a>idmap uid</p></li><li><p> + <a class="indexterm" name="id308157"></a>idmap gid</p></li><li><p> + <a class="indexterm" name="id308168"></a>idmap backend</p></li><li><p> + <a class="indexterm" name="id308179"></a>winbind cache time</p></li><li><p> + <a class="indexterm" name="id308191"></a>winbind enum users</p></li><li><p> + <a class="indexterm" name="id308202"></a>winbind enum groups</p></li><li><p> + <a class="indexterm" name="id308213"></a>template homedir</p></li><li><p> + <a class="indexterm" name="id308225"></a>template shell</p></li><li><p> + <a class="indexterm" name="id308236"></a>winbind use default domain</p></li><li><p> + <a class="indexterm" name="id308248"></a>winbind: rpc only + Setting this parameter forces winbindd to use RPC + instead of LDAP to retrieve information from Domain + Controllers. + </p></li></ul></div></div><div class="refsect1" lang="en"><a name="id308259"></a><h2>EXAMPLE SETUP</h2><p> + To setup winbindd for user and group lookups plus + authentication from a domain controller use something like the + following setup. This was tested on an early Red Hat Linux box. + </p><p>In <code class="filename">/etc/nsswitch.conf</code> put the + following: +</p><pre class="programlisting"> +passwd: files winbind +group: files winbind +</pre><p> + </p><p>In <code class="filename">/etc/pam.d/*</code> replace the <em class="parameter"><code> + auth</code></em> lines with something like this: +</p><pre class="programlisting"> +auth required /lib/security/pam_securetty.so +auth required /lib/security/pam_nologin.so +auth sufficient /lib/security/pam_winbind.so +auth required /lib/security/pam_unix.so \ + use_first_pass shadow nullok +</pre><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + The PAM module pam_unix has recently replaced the module pam_pwdb. + Some Linux systems use the module pam_unix2 in place of pam_unix. + </p></div><p>Note in particular the use of the <em class="parameter"><code>sufficient + </code></em> keyword and the <em class="parameter"><code>use_first_pass</code></em> keyword. </p><p>Now replace the account lines with this: </p><p><code class="literal">account required /lib/security/pam_winbind.so + </code></p><p>The next step is to join the domain. To do that use the + <code class="literal">net</code> program like this: </p><p><code class="literal">net join -S PDC -U Administrator</code></p><p>The username after the <em class="parameter"><code>-U</code></em> can be any + Domain user that has administrator privileges on the machine. + Substitute the name or IP of your PDC for "PDC".</p><p>Next copy <code class="filename">libnss_winbind.so</code> to + <code class="filename">/lib</code> and <code class="filename">pam_winbind.so + </code> to <code class="filename">/lib/security</code>. A symbolic link needs to be + made from <code class="filename">/lib/libnss_winbind.so</code> to + <code class="filename">/lib/libnss_winbind.so.2</code>. If you are using an + older version of glibc then the target of the link should be + <code class="filename">/lib/libnss_winbind.so.1</code>.</p><p>Finally, setup a <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> containing directives like the + following: +</p><pre class="programlisting"> +[global] + winbind separator = + + winbind cache time = 10 + template shell = /bin/bash + template homedir = /home/%D/%U + idmap uid = 10000-20000 + idmap gid = 10000-20000 + workgroup = DOMAIN + security = domain + password server = * +</pre><p>Now start winbindd and you should find that your user and + group database is expanded to include your NT users and groups, + and that you can login to your unix box as a domain user, using + the DOMAIN+user syntax for the username. You may wish to use the + commands <code class="literal">getent passwd</code> and <code class="literal">getent group + </code> to confirm the correct operation of winbindd.</p></div><div class="refsect1" lang="en"><a name="id308450"></a><h2>NOTES</h2><p>The following notes are useful when configuring and + running <code class="literal">winbindd</code>: </p><p><a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> must be running on the local machine + for <code class="literal">winbindd</code> to work. </p><p>PAM is really easy to misconfigure. Make sure you know what + you are doing when modifying PAM configuration files. It is possible + to set up PAM such that you can no longer log into your system. </p><p>If more than one UNIX machine is running <code class="literal">winbindd</code>, + then in general the user and groups ids allocated by winbindd will not + be the same. The user and group ids will only be valid for the local + machine, unless a shared <a class="indexterm" name="id308497"></a> is configured.</p><p>If the the Windows NT SID to UNIX user and group id mapping + file is damaged or destroyed then the mappings will be lost. </p></div><div class="refsect1" lang="en"><a name="id308509"></a><h2>SIGNALS</h2><p>The following signals can be used to manipulate the + <code class="literal">winbindd</code> daemon. </p><div class="variablelist"><dl><dt><span class="term">SIGHUP</span></dt><dd><p>Reload the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file and + apply any parameter changes to the running + version of winbindd. This signal also clears any cached + user and group information. The list of other domains trusted + by winbindd is also reloaded. </p></dd><dt><span class="term">SIGUSR2</span></dt><dd><p>The SIGUSR2 signal will cause <code class="literal"> + winbindd</code> to write status information to the winbind + log file.</p><p>Log files are stored in the filename specified by the + log file parameter.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308571"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/nsswitch.conf(5)</code></span></dt><dd><p>Name service switch configuration file.</p></dd><dt><span class="term">/tmp/.winbindd/pipe</span></dt><dd><p>The UNIX pipe over which clients communicate with + the <code class="literal">winbindd</code> program. For security reasons, the + winbind client will only attempt to connect to the winbindd daemon + if both the <code class="filename">/tmp/.winbindd</code> directory + and <code class="filename">/tmp/.winbindd/pipe</code> file are owned by + root. </p></dd><dt><span class="term">$LOCKDIR/winbindd_privileged/pipe</span></dt><dd><p>The UNIX pipe over which 'privileged' clients + communicate with the <code class="literal">winbindd</code> program. For security + reasons, access to some winbindd functions - like those needed by + the <code class="literal">ntlm_auth</code> utility - is restricted. By default, + only users in the 'root' group will get this access, however the administrator + may change the group permissions on $LOCKDIR/winbindd_privileged to allow + programs like 'squid' to use ntlm_auth. + Note that the winbind client will only attempt to connect to the winbindd daemon + if both the <code class="filename">$LOCKDIR/winbindd_privileged</code> directory + and <code class="filename">$LOCKDIR/winbindd_privileged/pipe</code> file are owned by + root. </p></dd><dt><span class="term">/lib/libnss_winbind.so.X</span></dt><dd><p>Implementation of name service switch library. + </p></dd><dt><span class="term">$LOCKDIR/winbindd_idmap.tdb</span></dt><dd><p>Storage for the Windows NT rid to UNIX user/group + id mapping. The lock directory is specified when Samba is initially + compiled using the <em class="parameter"><code>--with-lockdir</code></em> option. + This directory is by default <code class="filename">/usr/local/samba/var/locks + </code>. </p></dd><dt><span class="term">$LOCKDIR/winbindd_cache.tdb</span></dt><dd><p>Storage for cached user and group information. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308716"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of + the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id308726"></a><h2>SEE ALSO</h2><p><code class="filename">nsswitch.conf(5)</code>, <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>, <a href="wbinfo.1.html"><span class="citerefentry"><span class="refentrytitle">wbinfo</span>(1)</span></a>, <a href="ntlm_auth.8.html"><span class="citerefentry"><span class="refentrytitle">ntlm_auth</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a href="pam_winbind.8.html"><span class="citerefentry"><span class="refentrytitle">pam_winbind</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id308784"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p><code class="literal">wbinfo</code> and <code class="literal">winbindd</code> were + written by Tim Potter.</p><p>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> |