diff options
Diffstat (limited to 'docs/docbook/manpages')
| -rw-r--r-- | docs/docbook/manpages/nmbd.8.sgml | 9 | ||||
| -rw-r--r-- | docs/docbook/manpages/rpcclient.1.sgml | 2 | ||||
| -rw-r--r-- | docs/docbook/manpages/smb.conf.5.sgml | 116 | ||||
| -rw-r--r-- | docs/docbook/manpages/smbcontrol.1.sgml | 21 | ||||
| -rw-r--r-- | docs/docbook/manpages/smbd.8.sgml | 4 | ||||
| -rw-r--r-- | docs/docbook/manpages/smbpasswd.8.sgml | 371 |
6 files changed, 287 insertions, 236 deletions
diff --git a/docs/docbook/manpages/nmbd.8.sgml b/docs/docbook/manpages/nmbd.8.sgml index 92149d503a2..d5c89064e74 100644 --- a/docs/docbook/manpages/nmbd.8.sgml +++ b/docs/docbook/manpages/nmbd.8.sgml @@ -177,13 +177,14 @@ <listitem><para>The -l parameter specifies a directory into which the "log.nmbd" log file will be created for operational data from the running - <command>nmbd</command> server.</para> - - <para>The default log directory is compiled into Samba + <command>nmbd</command> server. The default log directory is compiled into Samba as part of the build process. Common defaults are <filename> /usr/local/samba/var/log.nmb</filename>, <filename> /usr/samba/var/log.nmb</filename> or - <filename>/var/log/log.nmb</filename>.</para></listitem> + <filename>/var/log/log.nmb</filename>. <emphasis>Beware:</emphasis> + If the directory specified does not exist, <command>nmbd</command> + will log to the default debug log location defined at compile time. + </para></listitem> </varlistentry> diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml index f32e2f9ece6..773455fb2bf 100644 --- a/docs/docbook/manpages/rpcclient.1.sgml +++ b/docs/docbook/manpages/rpcclient.1.sgml @@ -16,7 +16,6 @@ <refsynopsisdiv> <cmdsynopsis> <command>rpcclient</command> - <arg choice="req">server</arg> <arg choice="opt">-A authfile</arg> <arg choice="opt">-c <command string></arg> <arg choice="opt">-d debuglevel</arg> @@ -27,6 +26,7 @@ <arg choice="opt">-U username[%password]</arg> <arg choice="opt">-W workgroup</arg> <arg choice="opt">-N</arg> + <arg choice="req">server</arg> </cmdsynopsis> </refsynopsisdiv> diff --git a/docs/docbook/manpages/smb.conf.5.sgml b/docs/docbook/manpages/smb.conf.5.sgml index ddb8a7ec9b4..85874b7198d 100644 --- a/docs/docbook/manpages/smb.conf.5.sgml +++ b/docs/docbook/manpages/smb.conf.5.sgml @@ -41,7 +41,7 @@ <para>Section and parameter names are not case sensitive.</para> <para>Only the first equals sign in a parameter is significant. - Whitespace before or after the first equals sign is discarded. + 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 @@ -84,7 +84,7 @@ printable services (used by the client to access print services on the host running the server).</para> - <para>Sections may be designated <emphasis>guest</emphasis> services, + <para>Sections may be designated <emphasis>guest</emphasis> services, in which case no password is required to access them. A specified UNIX <emphasis>guest account</emphasis> is used to define access privileges in this case.</para> @@ -213,7 +213,7 @@ the [homes] section will hide the [homes] share but make any auto home directories visible.</para> </refsect2> - + <refsect2> <title id="PRINTERSSECT">The [printers] section</title> @@ -428,7 +428,7 @@ <varlistentry> <term>%d</term> - <listitem><para>The process id of the current server + <listitem><para>The process id of the current server process.</para></listitem> </varlistentry> @@ -514,7 +514,7 @@ <varlistentry> <term>short preserve case = yes/no</term> - <listitem><para>controls if new files which conform to 8.3 syntax, + <listitem><para>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 "default" case. This option can be use with "preserve case = yes" @@ -650,6 +650,7 @@ <listitem><para><link linkend="LOCALMASTER"><parameter>local master</parameter></link></para></listitem> <listitem><para><link linkend="LOCKDIR"><parameter>lock dir</parameter></link></para></listitem> <listitem><para><link linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link></para></listitem> + <listitem><para><link linkend="PIDDIRECTORY"><parameter>pid directory</parameter></link></para></listitem> <listitem><para><link linkend="LOGFILE"><parameter>log file</parameter></link></para></listitem> <listitem><para><link linkend="LOGLEVEL"><parameter>log level</parameter></link></para></listitem> <listitem><para><link linkend="LOGONDRIVE"><parameter>logon drive</parameter></link></para></listitem> @@ -681,6 +682,7 @@ <listitem><para><link linkend="NISHOMEDIR"><parameter>nis homedir</parameter></link></para></listitem> <listitem><para><link linkend="NTPIPESUPPORT"><parameter>nt pipe support</parameter></link></para></listitem> <listitem><para><link linkend="NTSMBSUPPORT"><parameter>nt smb support</parameter></link></para></listitem> + <listitem><para><link linkend="NTSTATUSSUPPORT"><parameter>nt status support</parameter></link></para></listitem> <listitem><para><link linkend="NULLPASSWORDS"><parameter>null passwords</parameter></link></para></listitem> <listitem><para><link linkend="OBEYPAMRESTRICTIONS"><parameter>obey pam restrictions</parameter></link></para></listitem> <listitem><para><link linkend="OPLOCKBREAKWAITTIME"><parameter>oplock break wait time</parameter></link></para></listitem> @@ -792,6 +794,8 @@ <listitem><para><link linkend="COPY"><parameter>copy</parameter></link></para></listitem> <listitem><para><link linkend="CREATEMASK"><parameter>create mask</parameter></link></para></listitem> <listitem><para><link linkend="CREATEMODE"><parameter>create mode</parameter></link></para></listitem> + <listitem><para><link linkend="CSCPOLICY"><parameter>csc policy</parameter></link></para></listitem> + <listitem><para><link linkend="DEFAULTCASE"><parameter>default case</parameter></link></para></listitem> <listitem><para><link linkend="DEFAULTDEVMODE"><parameter>default devmode</parameter></link></para></listitem> <listitem><para><link linkend="DELETEREADONLY"><parameter>delete readonly</parameter></link></para></listitem> @@ -1071,8 +1075,8 @@ <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para> <para>In order to use this option, <ulink url="smbd.8.html">smbd</ulink> - must be set to <parameter>security = server</parameter> or <parameter> - security = domain</parameter> and <parameter>add user script</parameter> + must <emphasis>NOT</emphasis> be set to <parameter>security = share</parameter> + and <parameter>add user script</parameter> must be set to a full pathname for a script that will create a UNIX user given one argument of <parameter>%u</parameter>, which expands into the UNIX user name to create.</para> @@ -1734,6 +1738,24 @@ </varlistentry> + <varlistentry> + <term><anchor id="CSCPOLICY">csc policy (S)</term> + <listitem><para>This stands for <emphasis>client-side caching + policy</emphasis>, and specifies how clients capable of offline + caching will cache the files in the share. The valid values + are: manual, documents, programs, disable.</para> + + <para>These values correspond to those used on Windows + servers.</para> + + <para>For example, shares containing roaming profiles can have + offline caching disabled using <command>csc policy = disable + </command>.</para> + + <para>Default: <command>csc policy = manual</command></para> + <para>Example: <command>csc policy = programs</command></para> + </listitem> + </varlistentry> <varlistentry> <term><anchor id="DEADTIME">deadtime (G)</term> @@ -2049,19 +2071,11 @@ Windows NT user no longer exists.</para> <para>In order to use this option, <command>smbd</command> must be - set to <parameter>security = domain</parameter> and <parameter>delete - user script</parameter> must be set to a full pathname for a script - that will delete a UNIX user given one argument of <parameter>%u - </parameter>, which expands into the UNIX user name to delete. - <emphasis>NOTE</emphasis> that this is different to the <link - linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link> - which will work with the <parameter>security = server</parameter> option - as well as <parameter>security = domain</parameter>. The reason for this - is only when Samba is a domain member does it get the information - on an attempted user logon that a user no longer exists. In the - <parameter>security = server</parameter> mode a missing user - is treated the same as an invalid password logon attempt. Deleting - the user in this circumstance would not be a good idea.</para> + set to <parameter>security = domain</parameter> or <parameter>security = + user</parameter> and <parameter>delete user script</parameter> + must be set to a full pathname for a script + that will delete a UNIX user given one argument of <parameter>%u</parameter>, + which expands into the UNIX user name to delete.</para> <para>When the Windows user attempts to access the Samba server, at <emphasis>login</emphasis> (session setup in the SMB protocol) @@ -4988,23 +5002,41 @@ <varlistentry> <term><anchor id="NTSMBSUPPORT">nt smb support (G)</term> - <listitem><para>This boolean parameter controls whether <ulink - url="smbd.8.html">smbd(8)</ulink> will negotiate NT specific SMB - support with Windows NT clients. Although this is a developer - debugging option and should be left alone, benchmarking has discovered - that Windows NT clients give faster performance with this option - set to <constant>no</constant>. This is still being investigated. - If this option is set to <constant>no</constant> then Samba offers - exactly the same SMB calls that versions prior to Samba 2.0 offered. - This information may be of use if any users are having problems + <listitem><para>This boolean parameter controls whether <ulink + url="smbd.8.html">smbd(8)</ulink> will negotiate NT specific SMB + support with Windows NT/2k/XP clients. Although this is a developer + debugging option and should be left alone, benchmarking has discovered + that Windows NT clients give faster performance with this option + set to <constant>no</constant>. This is still being investigated. + If this option is set to <constant>no</constant> then Samba offers + exactly the same SMB calls that versions prior to Samba 2.0 offered. + This information may be of use if any users are having problems with NT SMB support.</para> - + <para>You should not need to ever disable this parameter.</para> <para>Default: <command>nt smb support = yes</command></para> </listitem> </varlistentry> - + + + + <varlistentry> + <term><anchor id="NTSTATUSSUPPORT">nt status support (G)</term> + <listitem><para>This boolean parameter controls whether <ulink + url="smbd.8.html">smbd(8)</ulink> will negotiate NT specific status + support with Windows NT/2k/XP clients. This is a developer + debugging option and should be left alone. + If this option is set to <constant>no</constant> then Samba offers + exactly the same DOS error codes that versions prior to Samba 2.2.3 + reported.</para> + + <para>You should not need to ever disable this parameter.</para> + + <para>Default: <command>nt status support = yes</command></para> + </listitem> + </varlistentry> + <varlistentry> @@ -5522,6 +5554,18 @@ <varlistentry> + <term><anchor id="PIDDIRECTORY">pid directory (G)</term> + <listitem><para>This option specifies the directory where pid + files will be placed. </para> + + <para>Default: <command>pid directory = ${prefix}/var/locks</command></para> + <para>Example: <command>pid directory = /var/run/</command> + </para></listitem> + </varlistentry> + + + + <varlistentry> <term><anchor id="POSIXLOCKING">posix locking (S)</term> <listitem><para>The <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> daemon maintains an database of file locks obtained by SMB clients. @@ -5804,6 +5848,8 @@ linkend="PRINTERSSECT">[printers]</link> section above for reasons why you might want to do this.</para> + <para>To use the CUPS printing interface set <command>printcap name = cups + </command>.</para> <para>On System V systems that use <command>lpstat</command> to list available printers you can use <command>printcap name = lpstat </command> to automatically obtain lists of available printers. This @@ -8255,8 +8301,12 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ and <filename>nss_winbind.so</filename> modules for UNIX services. </para> - <para>Example: <command>winbind separator = \</command></para> - <para>Example: <command>winbind separator = +</command></para> + <para>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.</para> + + <para>Example: <command>winbind separator = \\</command></para> + <para>Example: <command>winbind separator = /</command></para> </listitem> </varlistentry> diff --git a/docs/docbook/manpages/smbcontrol.1.sgml b/docs/docbook/manpages/smbcontrol.1.sgml index 05e05f4a6ab..517e2ca41f4 100644 --- a/docs/docbook/manpages/smbcontrol.1.sgml +++ b/docs/docbook/manpages/smbcontrol.1.sgml @@ -9,7 +9,7 @@ <refnamediv> <refname>smbcontrol</refname> - <refpurpose>send messages to smbd or nmbd processes</refpurpose> + <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose> </refnamediv> <refsynopsisdiv> @@ -33,9 +33,10 @@ Samba</ulink> suite.</para> <para><command>smbcontrol</command> is a very small program, which - sends messages to an <ulink url="smbd.8.html">smbd(8)</ulink> or - an <ulink url="nmbd.8.html">nmbd(8)</ulink> daemon running on the - system.</para> + sends messages to an <ulink url="smbd.8.html">smbd(8)</ulink>, + an <ulink url="nmbd.8.html">nmbd(8)</ulink> + or a <ulink url="winbindd.8.html">winbindd(8)</ulink> + daemon running on the system.</para> </refsect1> @@ -81,8 +82,9 @@ message to smbd which will then 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 close, or 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 <constant>smbd</constant>.</para> <para>The <constant>debug</constant> message-type allows @@ -105,7 +107,7 @@ 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 of the destinations.</para> + be sent to any smbd or nmbd destinations.</para> <para>The <constant>debuglevel</constant> message-type sends a "request debug level" message. The current debug level setting @@ -115,18 +117,13 @@ <para>The <constant>profilelevel</constant> message-type sends a "request profile level" message. The current profile level setting is returned by a "profilelevel" message. This can be sent - to any of the destinations.</para> + to any smbd or nmbd destinations.</para> <para>The <constant>printer-notify</constant> message-type sends a message to smbd which in turn sends a printer notify message to any Windows NT clients connected to a printer. This message-type takes an argument of the printer name to send notify messages to. This message can only be sent to <constant>smbd</constant>.</para> - - <para>The <constant>close-share</constant> message-type sends a - message to smbd which forces smbd to close the share that was - specified as an argument. This may be useful if you made changes - to the access controls on the share. </para> </listitem> </varlistentry> diff --git a/docs/docbook/manpages/smbd.8.sgml b/docs/docbook/manpages/smbd.8.sgml index f82e3c65950..f52da46ed1f 100644 --- a/docs/docbook/manpages/smbd.8.sgml +++ b/docs/docbook/manpages/smbd.8.sgml @@ -169,7 +169,9 @@ its size may be controlled by the <ulink url="smb.conf.5.html#maxlogsize">max log size</ulink> option in the <ulink url="smb.conf.5.html"><filename> - smb.conf(5)</filename></ulink> file. + smb.conf(5)</filename></ulink> file. <emphasis>Beware:</emphasis> + If the directory specified does not exist, <command>smbd</command> + will log to the default debug log location defined at compile time. </para> <para>The default log directory is specified at diff --git a/docs/docbook/manpages/smbpasswd.8.sgml b/docs/docbook/manpages/smbpasswd.8.sgml index 5d41651f7d3..ad962144331 100644 --- a/docs/docbook/manpages/smbpasswd.8.sgml +++ b/docs/docbook/manpages/smbpasswd.8.sgml @@ -13,23 +13,18 @@ </refnamediv> <refsynopsisdiv> + <para>When run by root:</para> <cmdsynopsis> <command>smbpasswd</command> - <arg choice="opt">-a</arg> - <arg choice="opt">-x</arg> - <arg choice="opt">-d</arg> - <arg choice="opt">-e</arg> - <arg choice="opt">-D debuglevel</arg> - <arg choice="opt">-n</arg> - <arg choice="opt">-r <remote machine></arg> - <arg choice="opt">-R <name resolve order></arg> - <arg choice="opt">-m</arg> - <arg choice="opt">-j DOMAIN</arg> - <arg choice="opt">-U username[%password]</arg> - <arg choice="opt">-h</arg> - <arg choice="opt">-s</arg> - <arg choice="opt">-w pass</arg> + <arg choice="opt">options</arg> <arg choice="opt">username</arg> + <arg choice="opt">password</arg> + </cmdsynopsis> + <para>otherwise:</para> + <cmdsynopsis> + <command>smbpasswd</command> + <arg choice="opt">options</arg> + <arg choice="opt">password</arg> </cmdsynopsis> </refsynopsisdiv> @@ -80,76 +75,42 @@ <title>OPTIONS</title> <variablelist> <varlistentry> - <term>-a</term> - <listitem><para>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 user to be added must already exist - in the system password file (usually <filename>/etc/passwd</filename>) - else the request to add the user will fail. </para> - - <para>This option is only available when running smbpasswd - as root. </para></listitem> + <term>-L</term> + <listitem><para>Run the smbpasswd command in local mode. This + allows a non-root user to specify the root-only options. This + is used mostly in test environments where a non-root user needs + to make changes to the local <filename>smbpasswd</filename> file. + The <filename>smbpasswd</filename> file must have read/write + permissions for the user running the command.</para></listitem> </varlistentry> - <varlistentry> - <term>-x</term> - <listitem><para>This option specifies that the username - following should be deleted from the local smbpasswd file. - </para> - - <para>This option is only available when running smbpasswd as - root.</para></listitem> + <term>-h</term> + <listitem><para>This option prints the help string for + <command>smbpasswd</command>. </para></listitem> </varlistentry> - <varlistentry> - <term>-d</term> - <listitem><para>This option specifies that the username following - should be <constant>disabled</constant> in the local smbpasswd - file. This is done by writing a <constant>'D'</constant> 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. </para> - - <para>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 so the user is disabled by writing 'X' characters - into the password space in the smbpasswd file. See <command>smbpasswd(5) - </command> for details on the 'old' and new password file formats. - </para> - - <para>This option is only available when running smbpasswd as - root.</para></listitem> + <term>-s</term> + <listitem><para>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 <filename>/dev/tty</filename> + (like the <command>passwd(1)</command> program does). This option + is to aid people writing scripts to drive smbpasswd</para> + </listitem> </varlistentry> - - <varlistentry> - <term>-e</term> - <listitem><para>This option specifies that the username following - should be <constant>enabled</constant> 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. </para> - - <para>If the smbpasswd file is in the 'old' format, then <command> - smbpasswd</command> will prompt for a new password for this user, - otherwise the account will be enabled by removing the <constant>'D' - </constant> flag from account control space in the <filename> - smbpasswd</filename> file. See <command>smbpasswd (5)</command> for - details on the 'old' and new password file formats. </para> - <para>This option is only available when running smbpasswd as root. - </para></listitem> + <varlistentry> + <term>-c smb.conf file</term> + <listitem><para>This option specifies that the configuration + file specified should be used instead of the default value + specified at compile time. </para></listitem> </varlistentry> - - + <varlistentry> <term>-D debuglevel</term> <listitem><para><replaceable>debuglevel</replaceable> is an integer @@ -168,28 +129,6 @@ </varlistentry> - - <varlistentry> - <term>-n</term> - <listitem><para>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. </para> - - <para>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 <filename>smb.conf</filename> file : </para> - - <para><command>null passwords = yes</command></para> - - <para>This option is only available when running smbpasswd as - root.</para></listitem> - </varlistentry> - - - <varlistentry> <term>-r remote machine name</term> <listitem><para>This option allows a user to specify what machine @@ -221,45 +160,74 @@ <varlistentry> - <term>-R name resolve order</term> - <listitem><para>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. </para> + <term>-U username[%pass]</term> + <listitem><para>This option may only be used in conjunction + with the <parameter>-r</parameter> 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. The optional + %pass may be used to specify to old password.</para> - <para>The options are :"lmhosts", "host", "wins" and "bcast". They cause - names to be resolved as follows : </para> - <itemizedlist> - <listitem><para><constant>lmhosts</constant> : Lookup an IP - address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see the <ulink - url="lmhosts.5.html">lmhosts(5)</ulink> for details) then - any name type matches for lookup.</para></listitem> - - <listitem><para><constant>host</constant> : Do a standard host - name to IP address resolution, using the system <filename>/etc/hosts - </filename>, NIS, or DNS lookups. This method of name resolution - is operating system depended for instance on IRIX or Solaris this - may be controlled by the <filename>/etc/nsswitch.conf</filename> - file). Note that this method is only used if the NetBIOS name - type being queried is the 0x20 (server) name type, otherwise - it is ignored.</para></listitem> - - <listitem><para><constant>wins</constant> : Query a name with - the IP address listed in the <parameter>wins server</parameter> - parameter. If no WINS server has been specified this method - will be ignored.</para></listitem> - - <listitem><para><constant>bcast</constant> : Do a broadcast on - each of the known local interfaces listed in the - <parameter>interfaces</parameter> parameter. This is the least - reliable of the name resolution methods as it depends on the - target host being on a locally connected subnet.</para></listitem> - </itemizedlist> + <para>In particular, this parameter specifies the username + used to create the machine account when invoked with -j</para> + </listitem> + </varlistentry> - <para>The default order is <command>lmhosts, host, wins, bcast</command> - and without this parameter or any entry in the - <filename>smb.conf</filename> file the name resolution methods will - be attempted in this order. </para></listitem> + +<varlistentry> +<term><command>NOTE:</command></term> +<listitem><para> +<command>The following options are available only when the smbpasswd command is +run as root or in local mode.</command> +</para></listitem> +</varlistentry> + + <varlistentry> + <term>-a</term> + <listitem><para>This option specifies that the username + following should be added to the local smbpasswd file, with the + new password typed. This + option is ignored if the username specified already exists in + the smbpasswd file and it is treated like a regular change + password command. Note that the user to be added must already exist + in the system password file (usually <filename>/etc/passwd</filename>) + else the request to add the user will fail. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-d</term> + <listitem><para>This option specifies that the username following + should be <constant>disabled</constant> in the local smbpasswd + file. This is done by writing a <constant>'D'</constant> 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. </para> + + <para>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 so the user is disabled by writing 'X' characters + into the password space in the smbpasswd file. See <command>smbpasswd(5) + </command> for details on the 'old' and new password file formats. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-e</term> + <listitem><para>This option specifies that the username following + should be <constant>enabled</constant> 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. </para> + + <para>If the smbpasswd file is in the 'old' format, then <command> + smbpasswd</command> will prompt for a new password for this user, + otherwise the account will be enabled by removing the <constant>'D' + </constant> flag from account control space in the <filename> + smbpasswd</filename> file. See <command>smbpasswd (5)</command> for + details on the 'old' and new password file formats. </para></listitem> </varlistentry> @@ -268,8 +236,48 @@ <listitem><para>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.</para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-n</term> + <listitem><para>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. </para> - <para>This option is only available when running smbpasswd as root. + <para>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 <filename>smb.conf</filename> file : </para> + + <para><command>null passwords = yes</command></para></listitem> + </varlistentry> + + + <varlistentry> + <term>-w password</term> + <listitem><para>This parameter is only available is Samba + has been configured to use the experimental + <command>--with-ldapsam</command> option. The <parameter>-w</parameter> + switch is used to specify the password to be used with the + <ulink url="smb.conf.5.html#LDAPADMINDN"><parameter>ldap admin + dn</parameter></ulink>. Note that the password is stored in + the <filename>private/secrets.tdb</filename> and is keyed off + of the admin's DN. This means that if the value of <parameter>ldap + admin dn</parameter> ever changes, the password will beed to be + manually updated as well. + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-x</term> + <listitem><para>This option specifies that the username + following should be deleted from the local smbpasswd file. </para></listitem> </varlistentry> @@ -316,66 +324,50 @@ done to the PDC all users accessing the Samba server must still have a valid UNIX account on that machine. The <command>winbindd(8)</command> daemon can be used - to create UNIX accounts for NT users.</para> - - - <para>This option is only available when running smbpasswd as root. - </para></listitem> + to create UNIX accounts for NT users.</para></listitem> </varlistentry> - <varlistentry> - <term>-U username</term> - <listitem><para>This option may only be used in conjunction - with the <parameter>-r</parameter> 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. </para> - - <para>In particular, this parameter specifies the username - used to create the machine account when invoked with -j</para> - </listitem> - + <term>-R name resolve order</term> + <listitem><para>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. </para> - </varlistentry> - - - <varlistentry> - <term>-h</term> - <listitem><para>This option prints the help string for <command> - smbpasswd</command>, selecting the correct one for running as root - or as an ordinary user. </para></listitem> - </varlistentry> - - - - <varlistentry> - <term>-s</term> - <listitem><para>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 <filename>/dev/tty</filename> - (like the <command>passwd(1)</command> program does). This option - is to aid people writing scripts to drive smbpasswd</para> - </listitem> - </varlistentry> + <para>The options are :"lmhosts", "host", "wins" and "bcast". They cause + names to be resolved as follows : </para> + <itemizedlist> + <listitem><para><constant>lmhosts</constant> : Lookup an IP + address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see the <ulink + url="lmhosts.5.html">lmhosts(5)</ulink> for details) then + any name type matches for lookup.</para></listitem> + + <listitem><para><constant>host</constant> : Do a standard host + name to IP address resolution, using the system <filename>/etc/hosts + </filename>, 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 <filename>/etc/nsswitch.conf</filename> + file). Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</para></listitem> + + <listitem><para><constant>wins</constant> : Query a name with + the IP address listed in the <parameter>wins server</parameter> + parameter. If no WINS server has been specified this method + will be ignored.</para></listitem> + + <listitem><para><constant>bcast</constant> : Do a broadcast on + each of the known local interfaces listed in the + <parameter>interfaces</parameter> parameter. This is the least + reliable of the name resolution methods as it depends on the + target host being on a locally connected subnet.</para></listitem> + </itemizedlist> - - <varlistentry> - <term>-w password</term> - <listitem><para>This parameter is only available is Samba - has been configured to use the experimental - <command>--with-ldapsam</command> option. The <parameter>-w</parameter> - switch is used to specify the password to be used with the - <ulink url="smb.conf.5.html#LDAPADMINDN"><parameter>ldap admin - dn</parameter></ulink>. Note that the password is stored in - the <filename>private/secrets.tdb</filename> and is keyed off - of the admin's DN. This means that if the value of <parameter>ldap - admin dn</parameter> ever changes, the password will beed to be - manually updated as well. - </para> - </listitem> + <para>The default order is <command>lmhosts, host, wins, bcast</command> + and without this parameter or any entry in the + <filename>smb.conf</filename> file the name resolution methods will + be attempted in this order. </para></listitem> </varlistentry> @@ -387,6 +379,15 @@ to modify attributes directly in the local smbpasswd file. </para></listitem> </varlistentry> + + + <varlistentry> + <term>password</term> + <listitem><para>This specifies the new password. If this parameter + is specified you will not be prompted for the new password. + </para></listitem> + </varlistentry> + </variablelist> </refsect1> |