diff options
author | Gerald Carter <jerry@samba.org> | 2002-10-01 17:02:36 +0000 |
---|---|---|
committer | Gerald Carter <jerry@samba.org> | 2002-10-01 17:02:36 +0000 |
commit | 7faabd42c5cd010f0c19e074e805e41047b5d6c2 (patch) | |
tree | 142ae7da7c9ab6d24168b4b2f4710968007b1a2a /docs | |
parent | 5567ef53cb65e6100825ea909d9c35e322e65293 (diff) | |
download | samba-7faabd42c5cd010f0c19e074e805e41047b5d6c2.tar.gz samba-7faabd42c5cd010f0c19e074e805e41047b5d6c2.tar.bz2 samba-7faabd42c5cd010f0c19e074e805e41047b5d6c2.zip |
* fixed typos in SGML source
* regenerated man pages
(This used to be commit 89bbec5216e1e02469dea6f68ceb797dd9165c1f)
Diffstat (limited to 'docs')
33 files changed, 753 insertions, 809 deletions
diff --git a/docs/docbook/manpages/samba.7.sgml b/docs/docbook/manpages/samba.7.sgml index ce443e78d9..17865edd81 100644 --- a/docs/docbook/manpages/samba.7.sgml +++ b/docs/docbook/manpages/samba.7.sgml @@ -124,7 +124,7 @@ <para>If you require help, visit the Samba webpage at <ulink url="http://samba.org/">http://www.samba.org/</ulink> and explore the many option available to you. - + </para> </refsect1> <refsect1> diff --git a/docs/docbook/manpages/vfstest.1.sgml b/docs/docbook/manpages/vfstest.1.sgml index 11878c1c89..9a7eff1939 100644 --- a/docs/docbook/manpages/vfstest.1.sgml +++ b/docs/docbook/manpages/vfstest.1.sgml @@ -16,8 +16,8 @@ <cmdsynopsis> <command>vfstest</command> <arg choice="opt">-d debuglevel</arg> - <arg choice="opt">-c "command"</arg> - <arg choice="opt">-l "logfile"</arg> + <arg choice="opt">-c command</arg> + <arg choice="opt">-l logfile</arg> <arg choice="opt">-h</arg> </cmdsynopsis> </refsynopsisdiv> @@ -28,9 +28,9 @@ <para>This tool is part of the <ulink url="samba.7.html"> Samba</ulink> suite.</para> - <para><command>vfstest</command> is a small command line + <para><command>vfstest</command> 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 + user the ability to call the various VFS functions manually and supports cascaded VFS modules. </para> </refsect1> @@ -43,20 +43,20 @@ <varlistentry> <term>-c|--command=command</term> - <listitem><para>Execute the specified (colon-seperated) commands. + <listitem><para>Execute the specified (colon-seperated) commands. See below for the commands that are available. - </para> </listitem> + </para> </listitem> </varlistentry> <varlistentry> <term>-d|--debug=debuglevel</term> - <listitem><para>set the debuglevel. Debug level 0 is the lowest + <listitem><para>set the debuglevel. Debug level 0 is the lowest and 100 being the highest. This should be set to 100 if you are - planning on submitting a bug report to the Samba team (see - <filename>BUGS.txt</filename>). + planning on submitting a bug report to the Samba team (see + <filename>BUGS.txt</filename>). </para></listitem> </varlistentry> - + <varlistentry> <term>-h|--help</term> <listitem><para>Print a summary of command line options. @@ -65,8 +65,8 @@ <varlistentry> <term>-l|--logfile=logbasename</term> - <listitem><para>File name for log/debug files. The extension - <constant>'.client'</constant> will be appended. The log file is never removed + <listitem><para>File name for log/debug files. The extension + <constant>'.client'</constant> will be appended. The log file is never removed by the client. </para></listitem> </varlistentry> @@ -81,10 +81,10 @@ <para><emphasis>VFS COMMANDS</emphasis></para> <itemizedlist> <listitem><para><command>load <module.so></command> - Load specified VFS module </para></listitem> - + <listitem><para><command>populate <char> <size></command> - Populate a data buffer with the specified data </para></listitem> - + <listitem><para><command>showdata [<offset> <len>]</command> - Show data currently in data buffer </para></listitem> @@ -122,9 +122,9 @@ <listitem><para><command>mknod</command> - VFS mknod()</para></listitem> <listitem><para><command>realpath</command> - VFS realpath()</para></listitem> </itemizedlist> - + <para><emphasis>GENERAL COMMANDS</emphasis></para> - <itemizedlist> + <itemizedlist> <listitem><para><command>conf <smb.conf></command> - Load a different configuration file</para></listitem> <listitem><para><command>help [<command>]</command> - Get list of commands or info about specified command</para></listitem> @@ -134,25 +134,25 @@ <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem> <listitem><para><command>exit</command> - Exit vfstest</para></listitem> - </itemizedlist> + </itemizedlist> </refsect1> <refsect1> <title>VERSION</title> - <para>This man page is correct for version 3.0 of the Samba + <para>This man page is correct for version 3.0 of the Samba suite.</para> </refsect1> <refsect1> <title>AUTHOR</title> - - <para>The original Samba software and related utilities + + <para>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 + by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.</para> - + <para>The vfstest man page was written by Jelmer Vernooij.</para> </refsect1> diff --git a/docs/manpages/findsmb.1 b/docs/manpages/findsmb.1 index c10076fd5c..c5553267b5 100644 --- a/docs/manpages/findsmb.1 +++ b/docs/manpages/findsmb.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "FINDSMB" "1" "20 augustus 2002" "" "" +.TH "FINDSMB" "1" "01 October 2002" "" "" .SH NAME findsmb \- list info about machines that respond to SMB name queries on a subnet .SH SYNOPSIS @@ -12,12 +12,12 @@ findsmb \- list info about machines that respond to SMB name queries on a subne .SH "DESCRIPTION" .PP -This perl script is part of the Samba <URL:samba.7.html> suite. +This perl script is part of the Samba suite. .PP \fBfindsmb\fR 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 \fB nmblookup(1)\fR <URL:nmblookup.1.html> and \fBsmbclient(1)\fR <URL:smbclient.1.html> to obtain this information. +It uses \fB nmblookup(1)\fR to obtain this information. .SH "OPTIONS" .TP \fBsubnet broadcast address\fR @@ -25,7 +25,7 @@ Without this option, \fBfindsmb \fR will probe the subnet of the machine where \fBfindsmb\fR is run. This value is passed to \fBnmblookup\fR as part of the --B option +-B option. .SH "EXAMPLES" .PP The output of \fBfindsmb\fR lists the following @@ -41,13 +41,13 @@ Machines that are running Windows, Windows 95 or Windows 98 will not show any information about the operating system or server version. .PP -The command must be run on a system without \fBnmbd\fR <URL:nmbd.8.html> running. +The command must be run on a system without \fBnmbd\fR running. If \fBnmbd\fR 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. .PP -For example running \fBfindsmb\fR on a machine +For example, running \fBfindsmb\fR on a machine without \fBnmbd\fR running would yield output similar to the following @@ -72,9 +72,9 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBnmbd(8)\fR <URL:nmbd.8.html>, +\fBnmbd(8)\fR \fBsmbclient(1) -\fR <URL:smbclient.1.html>, and \fBnmblookup(1)\fR <URL:nmblookup.1.html> +\fR and \fBnmblookup(1)\fR .SH "AUTHOR" .PP The original Samba software and related utilities diff --git a/docs/manpages/lmhosts.5 b/docs/manpages/lmhosts.5 index ed3a81251b..f13d8ff78a 100644 --- a/docs/manpages/lmhosts.5 +++ b/docs/manpages/lmhosts.5 @@ -1,20 +1,20 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "LMHOSTS" "5" "28 January 2002" "" "" +.TH "LMHOSTS" "5" "01 October 2002" "" "" .SH NAME lmhosts \- The Samba NetBIOS hosts file .SH SYNOPSIS .PP -\fIlmhosts\fR is the SambaNetBIOS name to IP address mapping file. +\fIlmhosts\fR is the Samba NetBIOS name to IP address mapping file. .SH "DESCRIPTION" .PP -This file is part of the Sambasuite. +This file is part of the Samba suite. .PP \fIlmhosts\fR is the \fBSamba -\fRNetBIOS name to IP address mapping file. It +\fR NetBIOS name to IP address mapping file. It is very similar to the \fI/etc/hosts\fR file format, except that the hostname component must correspond to the NetBIOS naming format. @@ -40,8 +40,7 @@ name, whatever the NetBIOS name type in the lookup. .PP An example follows : .PP -.PP -.sp + .nf # # Sample Samba lmhosts file. @@ -50,25 +49,20 @@ An example follows : 192.9.200.20 NTSERVER#20 192.9.200.21 SAMBASERVER -.sp .fi .PP -.PP 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. .PP -.PP 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. .PP -.PP The default location of the \fIlmhosts\fR file -is in the same directory as the -smb.conf(5)>file. -.PP +is in the same directory as the +smb.conf(5)> file. .SH "VERSION" .PP This man page is correct for version 2.2 of @@ -76,7 +70,7 @@ the Samba suite. .SH "SEE ALSO" .PP \fBsmbclient(1) -\fR +\fR and \fB smbpasswd(8)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -88,5 +82,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/make_smbcodepage.1 b/docs/manpages/make_smbcodepage.1 index 915f0fc44b..143f24dc43 100644 --- a/docs/manpages/make_smbcodepage.1 +++ b/docs/manpages/make_smbcodepage.1 @@ -1,17 +1,18 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "MAKE_SMBCODEPAGE" "1" "28 January 2002" "" "" +.TH "MAKE_SMBCODEPAGE" "1" "01 October 2002" "" "" .SH NAME make_smbcodepage \- construct a codepage file for Samba .SH SYNOPSIS -.sp + \fBmake_smbcodepage\fR \fBc|d\fR \fBcodepage\fR \fBinputfile\fR \fBoutputfile\fR + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBmake_smbcodepage\fR compiles or de-compiles codepage files for use with the internationalization features @@ -30,10 +31,10 @@ number, e.g. 850). .TP \fBinputfile\fR This is the input file to process. In -the \fIc\fR case this will be a text -codepage definition file such as the ones found in the Samba +the \fIc\fR case, this will be a text +codepage definition file such as the ones found in the Samba \fIsource/codepages\fR directory. In -the \fId\fR case this will be the +the \fId\fR case, this will be the binary format codepage definition file normally found in the \fIlib/codepages\fR directory in the Samba install directory path. @@ -43,7 +44,7 @@ This is the output file to produce. .SH "SAMBA CODEPAGE FILES" .PP A text Samba codepage definition file is a description -that tells Samba how to map from upper to lower case for +that tells Samba how to map from upper to lower case for characters greater than ascii 127 in the specified DOS code page. Note that for certain DOS codepages (437 for example) mapping from lower to upper case may be non-symmetrical. For example, in @@ -103,9 +104,8 @@ Samba if it is to map the given lower case character to the given upper case character when upper casing a filename. .PP \fBcodepage.<codepage>\fR - These are the -output (binary) codepage files produced and placed in the Samba +output (binary) codepage files produced and placed in the Samba destination \fIlib/codepage\fR directory. -.PP .SH "INSTALLATION" .PP The location of the server and its support files is a @@ -113,9 +113,9 @@ matter for individual system administrators. The following are thus suggestions only. .PP It is recommended that the \fBmake_smbcodepage -\fRprogram be installed under the \fI/usr/local/samba -\fRhierarchy, in a directory readable by all, writeable -only by root. The program itself should be executable by all. The +\fR program be installed under the \fI/usr/local/samba +\fR hierarchy, in a directory readable by all, writeable +only by root. The program itself should be executable by all. The program should NOT be setuid or setgid! .SH "VERSION" .PP @@ -123,7 +123,7 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd(8)\fR, +\fBsmbd(8)\fR smb.conf(5) .SH "AUTHOR" .PP @@ -136,5 +136,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/make_unicodemap.1 b/docs/manpages/make_unicodemap.1 index a49d66d7a7..0c506349e7 100644 --- a/docs/manpages/make_unicodemap.1 +++ b/docs/manpages/make_unicodemap.1 @@ -1,17 +1,18 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "MAKE_UNICODEMAP" "1" "28 January 2002" "" "" +.TH "MAKE_UNICODEMAP" "1" "01 October 2002" "" "" .SH NAME make_unicodemap \- construct a unicode map file for Samba .SH SYNOPSIS -.sp + \fBmake_unicodemap\fR \fBcodepage\fR \fBinputfile\fR \fBoutputfile\fR + .SH "DESCRIPTION" .PP -This tool is part of the Samba +This tool is part of the Samba suite. .PP \fBmake_unicodemap\fR compiles text unicode map @@ -48,7 +49,7 @@ in the Samba \fIsource/codepages\fR directory. .PP A text unicode map file consists of multiple lines -containing two fields. These fields are : +containing two fields. These fields are : .TP 0.2i \(bu \fIcharacter\fR - which is @@ -59,11 +60,10 @@ the (hex) character mapped on this line. is the (hex) 16 bit unicode character that the character will map to. .PP -\fIunicode_map.<codepage>\fR - These are +\fIunicode_map.<codepage>\fR - These are the output (binary) unicode map files produced and placed in the Samba destination \fIlib/codepage\fR directory. -.PP .SH "INSTALLATION" .PP The location of the server and its support files is a matter @@ -74,7 +74,7 @@ It is recommended that the \fBmake_unicodemap\fR program be installed under the \fI$prefix/samba\fR hierarchy, in a directory readable by all, writeable only by root. The -program itself should be executable by all. The program +program itself should be executable by all. The program should NOT be setuid or setgid! .SH "VERSION" .PP @@ -82,7 +82,7 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd(8)\fR, +\fBsmbd(8)\fR smb.conf(5) .SH "AUTHOR" .PP @@ -95,5 +95,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/net.8 b/docs/manpages/net.8 index e063e3c229..fd2a450a6b 100644 --- a/docs/manpages/net.8 +++ b/docs/manpages/net.8 @@ -1,17 +1,18 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "NET" "8" "28 January 2002" "" "" +.TH "NET" "8" "01 October 2002" "" "" .SH NAME net \- Tool for administration of Samba and remote CIFS servers. .SH SYNOPSIS -.sp + \fBnet\fR \fB<ads|rap|rpc>\fR + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .SH "OPTIONS" .PP .SH "COMMANDS" diff --git a/docs/manpages/nmbd.8 b/docs/manpages/nmbd.8 index 875de31f42..d5662dbdb4 100644 --- a/docs/manpages/nmbd.8 +++ b/docs/manpages/nmbd.8 @@ -1,14 +1,15 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "NMBD" "8" "08 May 2002" "" "" +.TH "NMBD" "8" "01 October 2002" "" "" .SH NAME nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients .SH SYNOPSIS -.sp -\fBnmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-i\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-d <debug level>\fR ] [ \fB-H <lmhosts file>\fR ] [ \fB-l <log directory>\fR ] [ \fB-n <primary netbios name>\fR ] [ \fB-p <port number>\fR ] [ \fB-s <configuration file>\fR ] + +\fBnmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-i\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-d <debug level>\fR ] [ \fB-H <lmhosts file>\fR ] [ \fB-l <log directory>\fR ] [ \fB-n <primary netbios name>\fR ] [ \fB-p <port number>\fR ] [ \fB-s <configuration file>\fR ] + .SH "DESCRIPTION" .PP This program is part of the Samba suite. @@ -27,13 +28,13 @@ IP number a specified host is using. Amongst other services, \fBnmbd\fR 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 +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 with the \fB-n\fR option (see OPTIONS below). Thus \fBnmbd\fR will reply to broadcast queries for its own name(s). Additional names for \fBnmbd\fR to respond on can be set -via parameters in the \fI smb.conf(5)\fRconfiguration file. +via parameters in the \fI smb.conf(5)\fR configuration file. .PP \fBnmbd\fR can also be used as a WINS (Windows Internet Name Server) server. What this basically means @@ -43,7 +44,7 @@ replying to queries from clients for these names. .PP In addition, \fBnmbd\fR can act as a WINS proxy, relaying broadcast queries from clients that do -not understand how to talk the WINS protocol to a WIN +not understand how to talk the WINS protocol to a WINS server. .SH "OPTIONS" .TP @@ -58,19 +59,19 @@ meta-daemon, although this is not recommended. .TP \fB-a\fR If this parameter is specified, each new -connection will append log messages to the log file. +connection will append log messages to the log file. This is the default. .TP \fB-i\fR 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 +parameter negates the implicit daemon mode when run from the command line. .TP \fB-o\fR If this parameter is specified, the -log files will be overwritten when opened. By default, +log files will be overwritten when opened. By default, \fBsmbd\fR will append entries to the log files. .TP @@ -79,10 +80,10 @@ Prints the help information (usage) for \fBnmbd\fR. .TP \fB-H <filename>\fR -NetBIOS lmhosts file. The lmhosts +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 name resolve order +resolution mechanism name resolve order described in \fIsmb.conf(5)\fR to resolve any NetBIOS name queries needed by the server. Note that the contents of this file are \fBNOT\fR used by \fBnmbd\fR to answer any name queries. @@ -93,8 +94,9 @@ The default path to this file is compiled into Samba as part of the build process. Common defaults are \fI/usr/local/samba/lib/lmhosts\fR, \fI/usr/samba/lib/lmhosts\fR or -\fI/etc/lmhosts\fR. See the \fIlmhosts(5)\fRman page for details on the -contents of this file. +\fI/etc/lmhosts\fR. See the +\fIlmhosts(5)\fR +man page for details on the contents of this file. .TP \fB-V\fR Prints the version number for @@ -102,7 +104,7 @@ Prints the version number for .TP \fB-d <debug level>\fR debuglevel is an integer -from 0 to 10. The default value if this parameter is +from 0 to 10. The default value if this parameter is not specified is zero. The higher this value, the more detail will @@ -119,24 +121,24 @@ and generate HUGE amounts of log data, most of which is extremely cryptic. Note that specifying this parameter here will override -the log level -parameter in the \fI smb.conf\fRfile. +the log level +parameter in the \fI smb.conf(5)\fR file. .TP \fB-l <log directory>\fR The -l parameter specifies a directory into which the "log.nmbd" log file will be created -for operational data from the running -\fBnmbd\fR server. The default log directory is compiled into Samba -as part of the build process. Common defaults are \fI /usr/local/samba/var/log.nmb\fR, \fI /usr/samba/var/log.nmb\fR or -\fI/var/log/log.nmb\fR. \fBBeware:\fR +for operational data from the running \fBnmbd\fR +server. The default log directory is compiled into Samba +as part of the build process. Common defaults are \fI /usr/local/samba/var/log.nmb\fR, \fI /usr/samba/var/log.nmb\fR or +\fI/var/log/log.nmb\fR. \fBBeware:\fR If the directory specified does not exist, \fBnmbd\fR will log to the default debug log location defined at compile time. .TP \fB-n <primary NetBIOS name>\fR This option allows you to override the NetBIOS name that Samba uses for itself. This is identical -to setting the NetBIOS nameparameter in the -\fIsmb.conf\fRfile. However, a command +to setting the NetBIOS name parameter in the +\fIsmb.conf\fR file. However, a command line setting will take precedence over settings in \fIsmb.conf\fR. .TP @@ -149,18 +151,18 @@ won't need help! .TP \fB-s <configuration file>\fR The default configuration file name -is set at build time, typically as \fI /usr/local/samba/lib/smb.conf\fR, but +is set at build time, typically as \fI /usr/local/samba/lib/smb.conf\fR, but this may be changed when Samba is autoconfigured. The file specified contains the configuration details -required by the server. See \fIsmb.conf(5)\fRfor more information. +required by the server. See \fIsmb.conf(5)\fR for more information. .SH "FILES" .TP \fB\fI/etc/inetd.conf\fB\fR If the server is to be run by the \fBinetd\fR meta-daemon, this file must contain suitable startup information for the -meta-daemon. See the UNIX_INSTALL.htmldocument +meta-daemon. See the UNIX_INSTALL.html document for details. .TP \fB\fI/etc/rc\fB\fR @@ -169,7 +171,7 @@ system uses). If running the server as a daemon at startup, this file will need to contain an appropriate startup -sequence for the server. See the UNIX_INSTALL.htmldocument +sequence for the server. See the UNIX_INSTALL.html document for details. .TP \fB\fI/etc/services\fB\fR @@ -195,11 +197,11 @@ will store the WINS database in the file \fIwins.dat\fR in the \fIvar/locks\fR directory configured under wherever Samba was configured to install itself. -If \fBnmbd\fR is acting as a \fB browse master\fR (see the local master +If \fBnmbd\fR is acting as a \fB browse master\fR (see the local master parameter in the \fIsmb.conf(5)\fR man page, \fBnmbd\fR will store the browsing database in the file \fIbrowse.dat -\fRin the \fIvar/locks\fR directory +\fR in the \fIvar/locks\fR directory configured under wherever Samba was configured to install itself. .SH "SIGNALS" .PP @@ -211,7 +213,7 @@ a SIGTERM (-15) signal and wait for it to die on its own. .PP \fBnmbd\fR will accept SIGHUP, which will cause it to dump out its namelists into the file \fInamelist.debug -\fRin the \fI/usr/local/samba/var/locks\fR +\fR in the \fI/usr/local/samba/var/locks\fR directory (or the \fIvar/locks\fR directory configured under wherever Samba was configured to install itself). This will also cause \fBnmbd\fR to dump out its server database in @@ -219,7 +221,7 @@ the \fIlog.nmb\fR file. .PP The debug log level of nmbd may be raised or lowered using \fBsmbcontrol(1)\fR -(SIGUSR[1|2] signals are no longer used in Samba 2.2). This is + (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is to allow transient problems to be diagnosed, whilst still running at a normally low log level. .SH "VERSION" @@ -228,10 +230,10 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBinetd(8)\fR, \fBsmbd(8)\fR, +\fBinetd(8)\fR, \fBsmbd(8)\fR \fIsmb.conf(5)\fR -, \fBsmbclient(1) -\fR, and the Internet RFC's + \fBsmbclient(1) +\fR and the Internet RFC's \fIrfc1001.txt\fR, \fIrfc1002.txt\fR. In addition the CIFS (formerly SMB) specification is available as a link from the Web page @@ -247,5 +249,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/nmblookup.1 b/docs/manpages/nmblookup.1 index ed6bd38eba..49f602ab42 100644 --- a/docs/manpages/nmblookup.1 +++ b/docs/manpages/nmblookup.1 @@ -1,17 +1,18 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "NMBLOOKUP" "1" "28 January 2002" "" "" +.TH "NMBLOOKUP" "1" "01 October 2002" "" "" .SH NAME nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS names .SH SYNOPSIS -.sp -\fBnmblookup\fR [ \fB-M\fR ] [ \fB-R\fR ] [ \fB-S\fR ] [ \fB-r\fR ] [ \fB-A\fR ] [ \fB-h\fR ] [ \fB-B <broadcast address>\fR ] [ \fB-U <unicast address>\fR ] [ \fB-d <debug level>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-i <NetBIOS scope>\fR ] [ \fB-T\fR ] \fBname\fR + +\fBnmblookup\fR [ \fB-M\fR ] [ \fB-R\fR ] [ \fB-S\fR ] [ \fB-r\fR ] [ \fB-A\fR ] [ \fB-h\fR ] [ \fB-B <broadcast address>\fR ] [ \fB-U <unicast address>\fR ] [ \fB-d <debug level>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-i <NetBIOS scope>\fR ] [ \fB-T\fR ] \fBname\fR + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBnmblookup\fR is used to query NetBIOS names and map them to IP addresses in a network using NetBIOS over TCP/IP @@ -22,15 +23,15 @@ are done over UDP. .TP \fB-M\fR Searches for a master browser by looking -up the NetBIOS name \fIname\fR with a -type of 0x1d. If \fI name\fR is "-" then it does a lookup on the special name +up the NetBIOS name \fIname\fR with a +type of 0x1d. If \fI name\fR is "-" then it does a lookup on the special name __MSBROWSE__. .TP \fB-R\fR 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 +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. .TP @@ -45,7 +46,7 @@ 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 nmbd(8) +in addition, if the nmbd(8) daemon is running on this machine it also binds to this port. .TP \fB-A\fR @@ -60,7 +61,7 @@ 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 \fIinterfaces\fR -parameter of the \fIsmb.conf (5)\fR file. + parameter of the \fIsmb.conf (5)\fR file. .TP \fB-U <unicast address>\fR Do a unicast query to the specified address or @@ -84,11 +85,11 @@ Levels above 3 are designed for use only by developers and generate HUGE amounts of data, most of which is extremely cryptic. Note that specifying this parameter here will override -the \fI log level\fRparameter in the \fI smb.conf(5)\fR file. +the \fI log level\fR parameter in the \fI smb.conf(5)\fR file. .TP \fB-s <smb.conf>\fR This parameter specifies the pathname to -the Samba configuration file, smb.conf(5). This file controls all aspects of +the Samba configuration file, smb.conf(5) This file controls all aspects of the Samba setup on the machine. .TP \fB-i <scope>\fR @@ -137,8 +138,8 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBnmbd(8)\fR, -samba(7) +\fBnmbd(8)\fR +samba(7) and smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -150,5 +151,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/pdbedit.8 b/docs/manpages/pdbedit.8 index 523751712d..38e5efab59 100644 --- a/docs/manpages/pdbedit.8 +++ b/docs/manpages/pdbedit.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "PDBEDIT" "8" "20 August 2002" "" "" +.TH "PDBEDIT" "8" "01 October 2002" "" "" .SH NAME pdbedit \- manage the SAM database .SH SYNOPSIS @@ -12,14 +12,14 @@ pdbedit \- manage the SAM database .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP The pdbedit program is used to manage the users accounts -stored in the sam database and can be run only by root. +stored in the sam database and can only be run by root. .PP -The pdbedit tool use the passdb modular interface and is +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 addedd +are smbpasswd, ldap, nis+ and tdb based and more can be added without changing the tool). .PP There are five main ways to use pdbedit: adding a user account, @@ -28,7 +28,7 @@ accounts, importing users accounts. .SH "OPTIONS" .TP \fB-l\fR -This option list all the user accounts +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. @@ -43,8 +43,8 @@ Example: \fBpdbedit -l\fR .fi .TP \fB-v\fR -This option sets the verbose listing format. -It will make pdbedit list the users in the database printing +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. Example: \fBpdbedit -l -v\fR @@ -74,9 +74,9 @@ Example: \fBpdbedit -l -v\fR .TP \fB-w\fR This option sets the "smbpasswd" listing format. -It will make pdbedit list the users in the database printing +It will make pdbedit list the users in the database, printing out the account fields in a format compatible with the -\fIsmbpasswd\fR file format. (see the \fIsmbpasswd(5)\fRfor details) +\fIsmbpasswd\fR file format. (see the \fIsmbpasswd(5)\fR for details) Example: \fBpdbedit -l -w\fR @@ -88,8 +88,8 @@ Example: \fBpdbedit -l -w\fR .fi .TP \fB-u username\fR -This option specifies that the username to be -used for the operation requested (listing, adding, removing) +This option specifies the username to be +used for the operation requested (listing, adding, removing). It is \fBrequired\fR in add, remove and modify operations and \fBoptional\fR in list operations. @@ -131,9 +131,9 @@ Example: \fB-p "\\\\\\\\BERSERKER\\\\netlogon"\fR .TP \fB-a\fR This option is used to add a user into the -database. This command need the user name be specified with -the -u switch. When adding a new user pdbedit will also -ask for the password to be used +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. Example: \fBpdbedit -a -u sorce\fR @@ -152,23 +152,28 @@ Example: \fBpdbedit -a -m -u w2k-wks\fR .TP \fB-x\fR This option causes pdbedit to delete an account -from the database. It need the username be specified with the +from the database. It needs a username specified with the -u switch. Example: \fBpdbedit -x -u bob\fR .TP \fB-i passdb-backend\fR -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. +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. -This option will ease migration from one passdb backend to another. +This option will ease migration from one passdb backend to +another. -Example: \fBpdbedit -i smbpasswd:/etc/smbpasswd.old\fR +Example: \fBpdbedit -i smbpasswd:/etc/smbpasswd.old +\fR .TP \fB-e passdb-backend\fR -Export all currently available users to the specified password database backend. +Exports all currently available users to the +specified password database backend. -This option will ease migration from one passdb backend to another and will ease backupping +This option will ease migration from one passdb backend to +another and will ease backing up. Example: \fBpdbedit -e smbpasswd:/root/samba-users.backup\fR .TP @@ -185,7 +190,7 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -smbpasswd(8), +smbpasswd(8) samba(7) .SH "AUTHOR" .PP @@ -197,6 +202,6 @@ to the way the Linux kernel is developed. 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 -ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/rpcclient.1 b/docs/manpages/rpcclient.1 index ea112a35ad..083aef4f5f 100644 --- a/docs/manpages/rpcclient.1 +++ b/docs/manpages/rpcclient.1 @@ -1,43 +1,43 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "RPCCLIENT" "1" "15 August 2002" "" "" +.TH "RPCCLIENT" "1" "01 October 2002" "" "" .SH NAME rpcclient \- tool for executing client side MS-RPC functions .SH SYNOPSIS -.sp -\fBrpcclient\fR [ \fB-A authfile\fR ] [ \fB-c <command string>\fR ] [ \fB-d debuglevel\fR ] [ \fB-h\fR ] [ \fB-l logfile\fR ] [ \fB-N\fR ] [ \fB-s <smb config file>\fR ] [ \fB-U username[%password]\fR ] [ \fB-W workgroup\fR ] [ \fB-N\fR ] [ \fB-I destinationIP\fR ] \fBserver\fR + +\fBrpcclient\fR [ \fB-A authfile\fR ] [ \fB-c <command string>\fR ] [ \fB-d debuglevel\fR ] [ \fB-h\fR ] [ \fB-l logfile\fR ] [ \fB-N\fR ] [ \fB-s <smb config file>\fR ] [ \fB-U username[%password]\fR ] [ \fB-W workgroup\fR ] [ \fB-N\fR ] [ \fB-I destinationIP\fR ] \fBserver\fR + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBrpcclient\fR 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 +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. .SH "OPTIONS" .TP \fBserver\fR NetBIOS name of Server to which to connect. -The server can be any SMB/CIFS server. The name is -resolved using the \fIname resolve order\fRline from +The server can be any SMB/CIFS server. The name is +resolved using the \fIname resolve order\fR line from \fIsmb.conf(5)\fR. .TP \fB-A|--authfile=filename\fR 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 +password used in the connection. The format of the file is + -.sp .nf username = <value> password = <value> domain = <value> -.sp .fi Make certain that the permissions on the file restrict @@ -73,16 +73,17 @@ above. .TP \fB-l|--logfile=logbasename\fR File name for log/debug files. The extension -\&'.client' will be appended. The log file is never removed -by the client. +\&'.client' will be appended. The log file is +never removed by the client. .TP \fB-N|--nopass\fR instruct \fBrpcclient\fR not to ask -for a password. By default, \fBrpcclient\fR will prompt -for a password. See also the \fI-U\fR option. +for a password. By default, \fBrpcclient\fR will +prompt for a password. See also the \fI-U\fR +option. .TP \fB-s|--conf=smb.conf\fR -Specifies the location of the all important +Specifies the location of the all-important \fIsmb.conf\fR file. .TP \fB-U|--user=username[%password]\fR @@ -95,24 +96,24 @@ string is uppercased. If these environmental variables are not found, the username GUEST is used. 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 doesn't -desire to pass the credentials on the command line or via environment +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 +on the file restrict access from unwanted users. See the \fI-A\fR for more details. Be cautious about including passwords in scripts. Also, on many systems the command line of a running process may be seen -via the \fBps\fR command. To be safe always allow +via the \fBps\fR command. To be safe always allow \fBrpcclient\fR to prompt for a password and type it in directly. .TP \fB-W|--workgroup=domain\fR -Set the SMB domain of the username. This +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 server's NetBIOS name, -it causes the client to log on using the server's local SAM (as +smb.conf. If the domain specified is the same as the server's NetBIOS name, +it causes the client to log on using the server's local SAM (as opposed to the Domain SAM). .SH "COMMANDS" .PP @@ -126,16 +127,14 @@ opposed to the Domain SAM). of SIDs to usernames. .TP 0.2i \(bu -\fBlookupnames\fR - Resolve s list +\fBlookupnames\fR - Resolve a list of usernames to SIDs. .TP 0.2i \(bu \fBenumtrusts\fR .PP .PP -.PP \fBSAMR\fR -.PP .TP 0.2i \(bu \fBqueryuser\fR @@ -162,22 +161,20 @@ of usernames to SIDs. \fBenumdomgroups\fR .PP .PP -.PP \fBSPOOLSS\fR -.PP .TP 0.2i \(bu \fBadddriver <arch> <config>\fR - 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 -\fBgetdriverdir\fR. Possible values for +information on the server. Note that the driver files should +already exist in the directory returned by +\fBgetdriverdir\fR. Possible values for \fIarch\fR are the same as those for the \fBgetdriverdir\fR command. The \fIconfig\fR parameter is defined as follows: -.sp + .nf Long Printer Name:\\ Driver File Name:\\ @@ -188,38 +185,37 @@ follows: Default Data Type:\\ Comma Separated list of Files -.sp .fi Any empty fields should be enter as the string "NULL". 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 +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. .TP 0.2i \(bu \fBaddprinter <printername> <sharename> <drivername> <port>\fR -- Add a printer on the remote server. This printer -will be automatically shared. Be aware that the printer driver +- 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 \fBadddriver\fR) and the \fIport\fRmust be a valid port name (see \fBenumports\fR. .TP 0.2i \(bu \fBdeldriver\fR - Delete the -specified printer driver for all architectures. This +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. .TP 0.2i \(bu \fBenumdata\fR - 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 +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). .TP 0.2i @@ -236,22 +232,22 @@ info level. Currently only info levels 1 and 2 are supported. .TP 0.2i \(bu \fBenumdrivers [level]\fR -- Execute an EnumPrinterDrivers() call. This lists the various installed -printer drivers for all architectures. Refer to the MS Platform SDK +- 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. .TP 0.2i \(bu \fBenumprinters [level]\fR -- Execute an EnumPrinters() call. This lists the various installed -and share printers. Refer to the MS Platform SDK documentation for +- 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 0, 1, and 2. .TP 0.2i \(bu \fBgetdata <printername>\fR -- Retrieve the data for a given printer setting. See -the \fBenumdata\fR command for more information. +- Retrieve the data for a given printer setting. See +the \fBenumdata\fR command for more information. This command corresponds to the GetPrinterData() MS Platform SDK function (* This command is currently unimplemented). .TP 0.2i @@ -260,20 +256,20 @@ SDK function (* This command is currently unimplemented). - 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. +MS Platform SDK function. Currently info level 1, 2, and 3 are supported. .TP 0.2i \(bu \fBgetdriverdir <arch>\fR - Execute a GetPrinterDriverDirectory() -RPC to retreive the SMB share name and subdirectory for -storing printer driver files for a given architecture. Possible +RPC to retrieve the SMB share name and subdirectory for +storing printer driver files for a given architecture. Possible values for \fIarch\fR are "Windows 4.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows Alpha_AXP", and "Windows NT R4000". .TP 0.2i \(bu \fBgetprinter <printername>\fR -- Retrieve the current printer information. This command +- Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function. .TP 0.2i \(bu @@ -282,51 +278,51 @@ corresponds to the GetPrinter() MS Platform SDK function. against a given printer. .TP 0.2i \(bu -\fBsetdriver <printername> <drivername>\fR -- 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. +\fBsetdriver <printername> +<drivername>\fR +- 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. See also the \fBenumprinters\fR and \fBenumdrivers\fR commands for obtaining a list of of installed printers and drivers. .PP \fBGENERAL OPTIONS\fR -.PP .TP 0.2i \(bu -\fBdebuglevel\fR - Set the current debug level -used to log information. +\fBdebuglevel\fR - Set the current +debug level used to log information. .TP 0.2i \(bu \fBhelp (?)\fR - Print a listing of all -known commands or extended help on a particular command. +known commands or extended help on a particular command. .TP 0.2i \(bu \fBquit (exit)\fR - Exit \fBrpcclient -\fR\&. +\fR. .SH "BUGS" .PP \fBrpcclient\fR 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 +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. .PP From Luke Leighton's original rpcclient man page: .PP \fB"WARNING!\fR 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) +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. .PP 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 \fBsmbd(8)\fR and \fBrpcclient(1)\fR -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 +and as more of the services are understood, it can even result in +versions of \fBsmbd(8)\fR and \fBrpcclient(1)\fR +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." .SH "VERSION" .PP @@ -340,6 +336,6 @@ by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. .PP The original rpcclient man page was written by Matthew -Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. +Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. diff --git a/docs/manpages/samba.7 b/docs/manpages/samba.7 index 82e7409627..c898b8ce73 100644 --- a/docs/manpages/samba.7 +++ b/docs/manpages/samba.7 @@ -1,21 +1,23 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SAMBA" "7" "28 January 2002" "" "" +.TH "SAMBA" "7" "01 October 2002" "" "" .SH NAME SAMBA \- A Windows SMB/CIFS fileserver for UNIX .SH SYNOPSIS -.sp + \fBSamba\fR + .SH "DESCRIPTION" .PP 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), -LanManager or NetBIOS protocol. +also referred to as the Common Internet File System (CIFS). For a +more thorough description, see http://www.ubiqx.org/cifs/ <URL:http://www.ubiqx.org/cifs/>. Samba also implements the NetBIOS +protocol in nmbd. .TP \fBsmbd\fR The \fBsmbd \fR @@ -26,7 +28,7 @@ for this daemon is described in \fIsmb.conf\fR .TP \fBnmbd\fR The \fBnmbd\fR -daemon provides NetBIOS nameserving and browsing +daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon is described in \fIsmb.conf\fR .TP @@ -46,7 +48,7 @@ utility is a simple syntax checker for Samba's \fBtestprns\fR The \fBtestprns\fR utility supports testing printer names defined -in your \fIprintcap>\fR file used +in your \fIprintcap\fR file used by Samba. .TP \fBsmbstatus\fR @@ -74,8 +76,13 @@ 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 aren't clear enough then please send a patch or -bug report to samba@samba.org <URL:mailto:samba@samba.org> +manual pages and documents aren't clear enough then please visit +http://devel.samba.org <URL:http://devel.samba.org/> +for information on how to file a bug report or submit a patch. +.PP +If you require help, visit the Samba webpage at +http://www.samba.org/ <URL:http://samba.org/> and +explore the many option available to you. .SH "AVAILABILITY" .PP The Samba software suite is licensed under the @@ -108,11 +115,10 @@ If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at http://lists.samba.org <URL:http://lists.samba.org/>. .PP -If you have patches to submit or bugs to report -then you may mail them directly to samba-patches@samba.org. -Note, however, that due to the enormous popularity of this -package the Samba Team may take some time to respond to mail. We -prefer patches in \fBdiff -u\fR format. +If you have patches to submit, visit +http://devel.samba.org/ <URL:http://devel.samba.org/> +for information on how to do it properly. We prefer patches in +\fBdiff -u\fR format. .SH "CONTRIBUTORS" .PP Contributors to the project are now too numerous @@ -125,7 +131,7 @@ Samba. The project would have been unmanageable without it. .PP In addition, several commercial organizations now help fund the Samba Team with money and equipment. For details see -the Samba Web pages at http://samba.org/samba/samba-thanks.html. +the Samba Web pages at http://samba.org/samba/samba-thanks.html .SH "AUTHOR" .PP The original Samba software and related utilities @@ -137,5 +143,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5 index 8967134481..ed4b8cbda2 100644 --- a/docs/manpages/smb.conf.5 +++ b/docs/manpages/smb.conf.5 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMB.CONF" "5" "07 September 2002" "" "" +.TH "SMB.CONF" "5" "01 October 2002" "" "" .SH NAME smb.conf \- The configuration file for the Samba suite .SH "SYNOPSIS" @@ -679,10 +679,13 @@ each parameter for details. Note that some are synonyms. \fIldap suffix\fR .TP 0.2i \(bu -\fIldap suffix\fR +\fIldap user suffix\fR .TP 0.2i \(bu -\fIldap suffix\fR +\fIldap machine suffix\fR +.TP 0.2i +\(bu +\fIldap passwd sync\fR .TP 0.2i \(bu \fIlm announce\fR @@ -1616,13 +1619,16 @@ Example: \fBadd user script = /usr/local/samba/bin/add_user %u\fR .TP \fBadd group script (G)\fR -This is the full pathname to a script that will be run \fBAS ROOT\fR -by smbd(8) when a new group is requested. It will expand any \fI%g\fR -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. +This is the full pathname to a script that will +be run \fBAS ROOT\fR by smbd(8) when a new group is +requested. It will expand any +\fI%g\fR 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. .TP \fBadmin users (S)\fR This is a list of users who will be granted @@ -2964,9 +2970,9 @@ this by trying to log in as your guest user (perhaps by using the \fBsu -\fR command) and trying to print using the system print command such as \fBlpr(1)\fR or \fB lp(1)\fR. -This paramater does not accept % marcos, becouse +This paramater does not accept % macros, because many parts of the system require this value to be -constant for correct operation +constant for correct operation. Default: \fBspecified at compile time, usually "nobody"\fR @@ -3412,11 +3418,19 @@ Samba's previous SSL support which was enabled by specifying the script. The \fIldap ssl\fR can be set to one of three values: -(a) on - Always use SSL when contacting the -\fIldap server\fR, (b) off - -Never use SSL when querying the directory, or (c) start_tls -- Use the LDAPv3 StartTLS extended operation +.RS +.TP 0.2i +\(bu +\fIOn\fR = Always use SSL when contacting the +\fIldap server\fR. +.TP 0.2i +\(bu +\fIOff\fR = Never use SSL when querying the directory. +.TP 0.2i +\(bu +\fIStart_tls\fR = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server. +.RE Default : \fBldap ssl = on\fR .TP @@ -3434,6 +3448,28 @@ added to the ldap tree. Default : \fBnone\fR .TP +\fBldap passwd sync (G)\fR +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. + +The \fIldap passwd sync\fR can be set to one of three values: +.RS +.TP 0.2i +\(bu +\fIYes\fR = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time. +.TP 0.2i +\(bu +\fINo\fR = Update NT and LM passwords and update the pwdLastSet time. +.TP 0.2i +\(bu +\fIOnly\fR = Only update the LDAP password and let the LDAP server do the rest. +.RE + +Default : \fBldap passwd sync = no\fR +.TP \fBlevel2 oplocks (S)\fR This parameter controls whether Samba supports level2 (read-only) oplocks on a share. diff --git a/docs/manpages/smbcacls.1 b/docs/manpages/smbcacls.1 index 449a2a24b8..fccb6ec887 100644 --- a/docs/manpages/smbcacls.1 +++ b/docs/manpages/smbcacls.1 @@ -1,56 +1,57 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBCACLS" "1" "28 January 2002" "" "" +.TH "SMBCACLS" "1" "01 October 2002" "" "" .SH NAME smbcacls \- Set or get ACLs on an NT file or directory names .SH SYNOPSIS -.sp -\fBsmbcacls\fR \fB//server/share\fR \fBfilename\fR [ \fB-U username\fR ] [ \fB-A acls\fR ] [ \fB-M acls\fR ] [ \fB-D acls\fR ] [ \fB-S acls\fR ] [ \fB-C name\fR ] [ \fB-G name\fR ] [ \fB-n\fR ] [ \fB-h\fR ] + +\fBsmbcacls\fR \fB//server/share\fR \fBfilename\fR [ \fB-U username\fR ] [ \fB-A acls\fR ] [ \fB-M acls\fR ] [ \fB-D acls\fR ] [ \fB-S acls\fR ] [ \fB-C name\fR ] [ \fB-G name\fR ] [ \fB-n\fR ] [ \fB-h\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP -The \fBsmbcacls\fR program manipulates NT Access Control Lists -(ACLs) on SMB file shares. +The \fBsmbcacls\fR program manipulates NT Access Control +Lists (ACLs) on SMB file shares. .SH "OPTIONS" .PP -The following options are available to the \fBsmbcacls\fR program. +The following options are available to the \fBsmbcacls\fR program. The format of ACLs is described in the section ACL FORMAT .TP \fB-A acls\fR -Add the ACLs specified to the ACL list. Existing +Add the ACLs specified to the ACL list. Existing access control entries are unchanged. .TP \fB-M acls\fR Modify the mask value (permissions) for the ACLs -specified on the command line. An error will be printed for each +specified on the command line. An error will be printed for each ACL specified that was not already present in the ACL list .TP \fB-D acls\fR -Delete any ACLs specified on the command line. +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. .TP \fB-S acls\fR 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, +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. .TP \fB-U username\fR Specifies a username used to connect to the -specified service. The username may be of the form "username" in +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 \fIsmb.conf\fR file is -used, or "username%password" or "DOMAIN\\username%password" and the +used, or "username%password" or "DOMAIN\\username%password" and the password and workgroup names are used as provided. .TP \fB-C name\fR The owner of a file or directory can be changed -to the name given using the \fI-C\fR option. +to the name given using the \fI-C\fR 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. @@ -59,25 +60,25 @@ This command is a shortcut for -M OWNER:name. \fB-G name\fR The group owner of a file or directory can be changed to the name given using the \fI-G\fR -option. The name can be a sid in the form S-1-x-y-z or a name +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. This command is a shortcut for -M GROUP:name. .TP \fB-n\fR 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. +format. The default is to convert SIDs to names and ACE types +and masks to a readable string format. .TP \fB-h\fR Print usage information on the \fBsmbcacls -\fRprogram. +\fR program. .SH "ACL FORMAT" .PP 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: +either commas or newlines. An ACL entry is one of the following: .PP -.sp + .nf REVISION:<revision number> @@ -85,51 +86,48 @@ OWNER:<sid or name> GROUP:<sid or name> ACL:<sid or name>:<type>/<flags>/<mask> -.sp .fi .PP 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 +NT ACL revision for the security descriptor. +If not specified it defaults to 1. Using values other than 1 may cause strange behaviour. .PP The owner and group specify the owner and group sids for the -object. If a SID in the format CWS-1-x-y-z is specified this is used, +object. If a SID in the format CWS-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. .PP -ACLs specify permissions granted to the SID. This SID again +ACLs specify permissions granted to the SID. This SID again can be specified in CWS-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 +resides. The type, flags and mask values determine the type of access granted to the SID. .PP 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 +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: .TP 0.2i \(bu -#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1 +#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1 .TP 0.2i \(bu -#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2 +#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2 .TP 0.2i \(bu -#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4 +#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4 .TP 0.2i \(bu -#define SEC_ACE_FLAG_INHERIT_ONLY 0x8 +#define SEC_ACE_FLAG_INHERIT_ONLY 0x8 .PP At present flags can only be specified as decimal or hexadecimal values. .PP -.PP 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. -.PP .TP 0.2i \(bu \fBR\fR - Allow read access @@ -150,10 +148,9 @@ file permissions of the same name. \fBO\fR - Take ownership .PP The following combined permissions can be specified: -.PP .TP 0.2i \(bu -\fBREAD\fR - Equivalent to 'RX' +\fBREAD\fR - Equivalent to 'RX' permissions .TP 0.2i \(bu @@ -165,13 +162,13 @@ permissions .SH "EXIT STATUS" .PP The \fBsmbcacls\fR program sets the exit status -depending on the success or otherwise of the operations performed. +depending on the success or otherwise of the operations performed. The exit status may be one of the following values. .PP If the operation succeeded, smbcacls returns and exit -status of 0. If \fBsmbcacls\fR couldn't connect to the specified server, +status of 0. If \fBsmbcacls\fR 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 +of 1 is returned. If there was an error parsing any command line arguments, an exit status of 2 is returned. .SH "VERSION" .PP diff --git a/docs/manpages/smbclient.1 b/docs/manpages/smbclient.1 index 765c9e5273..63d78658a6 100644 --- a/docs/manpages/smbclient.1 +++ b/docs/manpages/smbclient.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBCLIENT" "1" "20 augustus 2002" "" "" +.TH "SMBCLIENT" "1" "01 October 2002" "" "" .SH NAME smbclient \- ftp-like client to access SMB/CIFS resources on servers .SH SYNOPSIS @@ -12,7 +12,7 @@ smbclient \- ftp-like client to access SMB/CIFS resources on servers .SH "DESCRIPTION" .PP -This tool is part of the Samba <URL:samba.7.html> suite. +This tool is part of the Samba suite. .PP \fBsmbclient\fR is a client that can \&'talk' to an SMB/CIFS server. It offers an interface @@ -87,7 +87,7 @@ cause names to be resolved as follows : \(bu lmhosts : 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 lmhosts(5) <URL:lmhosts.5.html> for details) then +no name type attached to the NetBIOS name (see the lmhosts(5) for details) then any name type matches for lookup. .TP 0.2i \(bu diff --git a/docs/manpages/smbcontrol.1 b/docs/manpages/smbcontrol.1 index d1479bff25..b60841dc94 100644 --- a/docs/manpages/smbcontrol.1 +++ b/docs/manpages/smbcontrol.1 @@ -1,24 +1,26 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBCONTROL" "1" "15 August 2002" "" "" +.TH "SMBCONTROL" "1" "01 October 2002" "" "" .SH NAME smbcontrol \- send messages to smbd, nmbd or winbindd processes .SH SYNOPSIS -.sp -\fBsmbcontrol\fR [ \fB-i\fR ] -.sp -\fBsmbcontrol\fR [ \fBdestination\fR ] [ \fBmessage-type\fR ] [ \fBparameter\fR ] + +\fBsmbcontrol\fR [ \fB-i\fR ] + + +\fBsmbcontrol\fR [ \fBdestination\fR ] [ \fBmessage-type\fR ] [ \fBparameter\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBsmbcontrol\fR is a very small program, which -sends messages to an smbd(8), +sends messages to an smbd(8) an nmbd(8) -or a winbindd(8) +or a winbindd(8) daemon running on the system. .SH "OPTIONS" .TP @@ -46,7 +48,7 @@ to only that process. One of: close-share, debug, force-election, ping -, profile, debuglevel, profilelevel, +, profile, debuglevel, profilelevel, or printnotify. The close-share message-type sends a @@ -69,7 +71,7 @@ master election. The ping message-type sends the number of "ping" messages specified by the parameter and waits -for the same number of reply "pong" messages. This can be sent to +for the same number of reply "pong" messages. This can be sent to any of the destinations. The profile message-type sends a @@ -82,12 +84,12 @@ be sent to any smbd or nmbd destinations. The debuglevel message-type sends a "request debug level" message. The current debug level setting -is returned by a "debuglevel" message. This can be +is returned by a "debuglevel" message. This can be sent to any of the destinations. The profilelevel message-type sends -a "request profile level" message. The current profile level -setting is returned by a "profilelevel" message. This can be sent +a "request profile level" message. The current profile level +setting is returned by a "profilelevel" message. This can be sent to any smbd or nmbd destinations. The printnotify message-type sends a @@ -119,9 +121,8 @@ Send a job delete change notify message for the printer and unix jobid specified. .RE -.PP Note that this message only sends notification that an -event has occured. It doesn't actually cause the +event has occured. It doesn't actually cause the event to happen. This message can only be sent to smbd. .TP @@ -133,8 +134,8 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBnmbd(8)\fR, -and \fBsmbd(8)\fR. +\fBnmbd(8)\fR +and \fBsmbd(8)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -146,5 +147,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbd.8 b/docs/manpages/smbd.8 index 83483c8835..7e1b35d5aa 100644 --- a/docs/manpages/smbd.8 +++ b/docs/manpages/smbd.8 @@ -1,14 +1,15 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBD" "8" "08 May 2002" "" "" +.TH "SMBD" "8" "01 October 2002" "" "" .SH NAME smbd \- server to provide SMB/CIFS services to clients .SH SYNOPSIS -.sp -\fBsmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-i\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-b\fR ] [ \fB-d <debug level>\fR ] [ \fB-l <log directory>\fR ] [ \fB-p <port number>\fR ] [ \fB-O <socket option>\fR ] [ \fB-s <configuration file>\fR ] + +\fBsmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-i\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-b\fR ] [ \fB-d <debug level>\fR ] [ \fB-l <log directory>\fR ] [ \fB-p <port number>\fR ] [ \fB-O <socket option>\fR ] [ \fB-s <configuration file>\fR ] + .SH "DESCRIPTION" .PP This program is part of the Samba suite. @@ -18,7 +19,7 @@ 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 +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. .PP @@ -26,12 +27,12 @@ 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 \fIsmb.conf(5) -\fR. This man page will not describe the +\fR This man page will not describe the services, but will concentrate on the administrative aspects of running the server. .PP Please note that there are significant security -implications to running this server, and the \fIsmb.conf(5)\fR +implications to running this server, and the \fIsmb.conf(5)\fR manpage should be regarded as mandatory reading before proceeding with installation. .PP @@ -42,10 +43,10 @@ that session. When all connections from its client are closed, the copy of the server for that client terminates. .PP 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 +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 +that is already established. Either the user will have to disconnect from the service, or \fBsmbd\fR killed and restarted. .SH "OPTIONS" .TP @@ -56,12 +57,12 @@ itself and runs in the background, fielding requests on the appropriate port. Operating the server as a daemon is the recommended way of running \fBsmbd\fR for servers that provide more than casual use file and -print services. This switch is assumed if \fBsmbd -\fRis executed on the command line of a shell. +print services. This switch is assumed if \fBsmbd +\fR is executed on the command line of a shell. .TP \fB-a\fR If this parameter is specified, each new -connection will append log messages to the log file. +connection will append log messages to the log file. This is the default. .TP \fB-i\fR @@ -73,7 +74,7 @@ command line. .TP \fB-o\fR If this parameter is specified, the -log files will be overwritten when opened. By default, +log files will be overwritten when opened. By default, \fBsmbd\fR will append entries to the log files. .TP @@ -96,7 +97,7 @@ Samba was built. .TP \fB-d <debug level>\fR \fIdebuglevel\fR is an integer -from 0 to 10. The default value if this parameter is +from 0 to 10. The default value if this parameter is not specified is zero. The higher this value, the more detail will be @@ -114,7 +115,7 @@ data, most of which is extremely cryptic. Note that specifying this parameter here will override the log -levelfile. +level file. .TP \fB-l <log directory>\fR If specified, @@ -124,7 +125,7 @@ file will be created for informational and debug messages from the running server. The log file generated is never removed by the server although its size may be controlled by the max log size -option in the \fI smb.conf(5)\fRfile. \fBBeware:\fR +option in the \fI smb.conf(5)\fR file. \fBBeware:\fR If the directory specified does not exist, \fBsmbd\fR will log to the default debug log location defined at compile time. @@ -132,13 +133,13 @@ The default log directory is specified at compile time. .TP \fB-O <socket options>\fR -See the socket options +See the socket options parameter in the \fIsmb.conf(5) -\fRfile for details. +\fR file for details. .TP \fB-p <port number>\fR \fIport number\fR is a positive integer -value. The default value if this parameter is not +value. The default value if this parameter is not specified is 139. This number is the port number that will be @@ -161,11 +162,11 @@ in the above situation. .TP \fB-s <configuration file>\fR The file specified contains the -configuration details required by the server. 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 \fI smb.conf(5)\fRfor more information. +to provide. See \fI smb.conf(5)\fR for more information. The default configuration file name is determined at compile time. .SH "FILES" @@ -202,11 +203,11 @@ install this file are \fI/usr/samba/lib/smb.conf\fR and \fI/etc/smb.conf\fR. This file describes all the services the server -is to make available to clients. See \fIsmb.conf(5)\fRfor more information. +is to make available to clients. See \fIsmb.conf(5)\fR for more information. .SH "LIMITATIONS" .PP On some systems \fBsmbd\fR cannot change uid back -to root after a setuid() call. Such systems are called +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 @@ -224,21 +225,21 @@ is not specific to the server, however. .PP 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 +session management. The degree too which samba supports PAM is restricted by the limitations of the SMB protocol and the obey pam restricions -smb.conf paramater. When this is set, the following restrictions apply: +smb.conf paramater. When this is set, the following restrictions apply: .TP 0.2i \(bu -\fBAccount Validation\fR: All acccesses to a +\fBAccount Validation\fR: All acccesses 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. +login at this time. This also applies to encrypted logins. .TP 0.2i \(bu -\fBSession Management\fR: When not using share +\fBSession Management\fR: 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. +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. .SH "VERSION" @@ -276,7 +277,7 @@ it to die on its own. .PP The debug log level of \fBsmbd\fR may be raised or lowered using \fBsmbcontrol(1) -\fRprogram (SIGUSR[1|2] signals are no longer used in +\fR program (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is to allow transient problems to be diagnosed, whilst still running at a normally low log level. .PP @@ -289,10 +290,10 @@ them after, however this would affect performance. .SH "SEE ALSO" .PP hosts_access(5), \fBinetd(8)\fR, -\fBnmbd(8)\fR, +\fBnmbd(8)\fR \fIsmb.conf(5)\fR -, \fBsmbclient(1) -\fR, and the Internet RFC's + \fBsmbclient(1) +\fR and the Internet RFC's \fIrfc1001.txt\fR, \fIrfc1002.txt\fR. In addition the CIFS (formerly SMB) specification is available as a link from the Web page @@ -308,5 +309,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbgroupedit.8 b/docs/manpages/smbgroupedit.8 index 9f01fcaaea..3ee7980e5d 100644 --- a/docs/manpages/smbgroupedit.8 +++ b/docs/manpages/smbgroupedit.8 @@ -1,21 +1,22 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBGROUPEDIT" "8" "28 January 2002" "" "" +.TH "SMBGROUPEDIT" "8" "01 October 2002" "" "" .SH NAME smbgroupedit \- Query/set/change UNIX - Windows NT group mapping .SH SYNOPSIS -.sp -\fBsmbroupedit\fR [ \fB-v [l|s]\fR ] [ \fB-a UNIX-groupname [-d NT-groupname|-p prividge|\fR ] + +\fBsmbroupedit\fR [ \fB-v [l|s]\fR ] [ \fB-a UNIX-groupname [-d NT-groupname|-p privilege|]\fR ] + .SH "DESCRIPTION" .PP This program is part of the Samba suite. .PP -The smbgroupedit command allows for mapping unix groups -to NT Builtin, Domain, or Local groups. Also +The smbgroupedit command allows for mapping unix groups +to NT Builtin, Domain, or Local groups. Also allows setting privileges for that group, such as saAddUser, etc. .SH "OPTIONS" @@ -28,7 +29,7 @@ in the Windows NT domain in which samba is operating. \fB-l\fR give a long listing, of the format: -.sp + .nf "NT Group Name" SID : @@ -36,37 +37,33 @@ give a long listing, of the format: Group type : Comment : Privilege : -.sp .fi For examples, -.sp + .nf Users - SID : S-1-5-32-545 + SID : S-1-5-32-545 Unix group: -1 Group type: Local group - Comment : + Comment : Privilege : No privilege -.sp .fi .TP \fB-s\fR display a short listing of the format: -.sp + .nf NTGroupName(SID) -> UnixGroupName -.sp .fi For example, -.sp + .nf Users (S-1-5-32-545) -> -1 -.sp .fi .RE .SH "FILES" @@ -79,67 +76,64 @@ of a failure. .SH "EXAMPLES" .PP To make a subset of your samba PDC users members of -the 'Domain Admins' Global group: -.IP 1. +the 'Domain Admins' Global group: +.TP 3 +1. create a unix group (usually in \fI/etc/group\fR), let's call it domadm. -.IP 2. +.TP 3 +2. add to this group the users that you want to be domain administrators. For example if you want joe, john and mary, your entry in \fI/etc/group\fR will look like: domadm:x:502:joe,john,mary -.IP 3. +.TP 3 +3. map this domadm group to the 'domain admins' group: .RS -.IP 1. +.TP 3 +1. Get the SID for the Windows NT "Domain Admins" group: -.sp + .nf root# \fBsmbgroupedit -vs | grep "Domain Admins"\fR Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> -1 -.sp .fi -.IP 2. +.TP 3 +2. map the unix domadm group to the Windows NT "Domain Admins" group, by running the command: -.sp + .nf root# \fBsmbgroupedit \\ -c S-1-5-21-1108995562-3116817432-1375597819-512 \\ -u domadm\fR -.sp .fi \fBwarning:\fR don't copy and paste this sample, the Domain Admins SID (the S-1-5-21-...-512) is different for every PDC. .RE .PP -To verify that you mapping has taken effect: -.PP +To verify that your mapping has taken effect: .PP -.sp + .nf root# \fBsmbgroupedit -vs|grep "Domain Admins"\fR Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> domadm -.sp .fi .PP -.PP To give access to a certain directory on a domain member machine (an NT/W2K or a samba server running winbind) to some users who are member of a group on your samba PDC, flag that group as a domain group: .PP -.PP -.sp + .nf root# \fBsmbgroupedit -a unixgroup -td\fR -.sp .fi -.PP .SH "VERSION" .PP This man page is correct for the 3.0alpha releases of diff --git a/docs/manpages/smbmnt.8 b/docs/manpages/smbmnt.8 index 885ab82f99..b316268b0c 100644 --- a/docs/manpages/smbmnt.8 +++ b/docs/manpages/smbmnt.8 @@ -1,14 +1,15 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBMNT" "8" "28 January 2002" "" "" +.TH "SMBMNT" "8" "01 October 2002" "" "" .SH NAME smbmnt \- helper utility for mounting SMB filesystems .SH SYNOPSIS -.sp -\fBsmbmnt\fR \fBmount-point\fR [ \fB-s <share>\fR ] [ \fB-r\fR ] [ \fB-u <uid>\fR ] [ \fB-g <gid>\fR ] [ \fB-f <mask>\fR ] [ \fB-d <mask>\fR ] [ \fB-o <options>\fR ] + +\fBsmbmnt\fR \fBmount-point\fR [ \fB-s <share>\fR ] [ \fB-r\fR ] [ \fB-u <uid>\fR ] [ \fB-g <gid>\fR ] [ \fB-f <mask>\fR ] [ \fB-d <mask>\fR ] [ \fB-o <options>\fR ] + .SH "DESCRIPTION" .PP \fBsmbmnt\fR is a helper application used @@ -21,7 +22,7 @@ by the user, and that the user has write permission on. .PP The \fBsmbmnt\fR program is normally invoked by \fBsmbmount(8)\fR -. It should not be invoked directly by users. + It should not be invoked directly by users. .PP smbmount searches the normal PATH for smbmnt. You must ensure that the smbmnt version in your path matches the smbmount used. @@ -43,7 +44,7 @@ specify the octal file mask applied .TP \fB-d mask\fR specify the octal directory mask -applied +applied .TP \fB-o options\fR list of options that are passed as-is to smbfs, if this diff --git a/docs/manpages/smbmount.8 b/docs/manpages/smbmount.8 index 0d4a7fc870..ac67d0ee60 100644 --- a/docs/manpages/smbmount.8 +++ b/docs/manpages/smbmount.8 @@ -1,14 +1,15 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBMOUNT" "8" "08 May 2002" "" "" +.TH "SMBMOUNT" "8" "01 October 2002" "" "" .SH NAME smbmount \- mount an smbfs filesystem .SH SYNOPSIS -.sp -\fBsmbmount\fR \fBservice\fR \fBmount-point\fR [ \fB-o options\fR ] + +\fBsmbmount\fR \fBservice\fR \fBmount-point\fR [ \fB-o options\fR ] + .SH "DESCRIPTION" .PP \fBsmbmount\fR mounts a Linux SMB filesystem. It @@ -37,7 +38,7 @@ that it can be found. .TP \fBusername=<arg>\fR specifies the username to connect as. If -this is not given, then the environment variable \fB USER\fR is used. This option can also take the +this is not given, then the environment variable \fB USER\fR 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. @@ -50,9 +51,9 @@ no password \fBsmbmount\fR will prompt for a passeword, unless the guest option is given. -Note that password which contain the arguement delimiter +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 +on the command line. However, the same password defined in the PASSWD environment variable or a credentials file (see below) will be read correctly. .TP @@ -60,12 +61,11 @@ below) will be read correctly. specifies a file that contains a username and/or password. The format of the file is: -.sp + .nf username = <value> password = <value> -.sp .fi This is preferred over having passwords in plaintext in a @@ -115,7 +115,7 @@ sets the workgroup on the destination .TP \fBsockopt=<arg>\fR sets the TCP socket options. See the \fIsmb.conf -\fR\fIsocket options\fR option. +\fR \fIsocket options\fR option. .TP \fBscope=<arg>\fR sets the NetBIOS scope @@ -141,7 +141,7 @@ option. Example value cp850. (Note: only kernel 2.4.0 or later) .TP \fBttl=<arg>\fR -how long a directory listing is cached in milliseconds +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 @@ -153,13 +153,13 @@ in many cases. .SH "ENVIRONMENT VARIABLES" .PP The variable \fBUSER\fR may contain the username of the -person using the client. This information is used only if 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. .PP The variable \fBPASSWD\fR may contain the password of the -person using the client. This information is used only if the +person using the client. This information is used only if the protocol level is high enough to support session-level passwords. .PP @@ -189,7 +189,6 @@ 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) -.PP .SH "SEE ALSO" .PP Documentation/filesystems/smbfs.txt in the linux kernel @@ -198,7 +197,7 @@ source tree may contain additional options and information. FreeBSD also has a smbfs, but it is not related to smbmount .PP For Solaris, HP-UX and others you may want to look at -\fBsmbsh(1)\fRor at other +\fBsmbsh(1)\fR or at other solutions, such as sharity or perhaps replacing the SMB server with a NFS server. .SH "AUTHOR" diff --git a/docs/manpages/smbpasswd.5 b/docs/manpages/smbpasswd.5 index 39281eb34e..47eabcaec8 100644 --- a/docs/manpages/smbpasswd.5 +++ b/docs/manpages/smbpasswd.5 @@ -1,9 +1,9 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBPASSWD" "5" "28 January 2002" "" "" +.TH "SMBPASSWD" "5" "01 October 2002" "" "" .SH NAME smbpasswd \- The Samba encrypted password file .SH SYNOPSIS @@ -11,7 +11,7 @@ smbpasswd \- The Samba encrypted password file \fIsmbpasswd\fR .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP smbpasswd is the Samba encrypted password file. It contains the username, Unix user id and the SMB hashed passwords of the @@ -39,7 +39,7 @@ this smbpasswd file entry as being valid for a user. .TP \fBLanman Password Hash\fR This is the LANMAN hash of the user's password, -encoded as 32 hex digits. The LANMAN hash is created by DES +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 @@ -66,7 +66,7 @@ other access. .TP \fBNT Password Hash\fR This is the Windows NT hash of the user's -password, encoded as 32 hex digits. The Windows NT hash is +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. @@ -108,12 +108,12 @@ in the smbpasswd file. \fBN\fR - 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 \fI null passwords\fR parameter is set in the \fIsmb.conf(5) -\fRconfig file. +will only allow users to log on with no password if the \fI null passwords\fR parameter is set in the \fIsmb.conf(5) +\fR config file. .TP 0.2i \(bu \fBD\fR - This means the account -is disabled and no SMB/CIFS logins will be allowed for +is disabled and no SMB/CIFS logins will be allowed for this user. .TP 0.2i \(bu @@ -122,10 +122,9 @@ 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. .RE -.PP + Other flags may be added as the code is extended in future. The rest of this field space is filled in with spaces. -.PP .TP \fBLast Change Time\fR This field consists of the time the account was @@ -134,15 +133,14 @@ last modified. It consists of the characters 'LCT-' (standing for in seconds since the epoch (1970) that the last change was made. .PP All other colon separated fields are ignored at this time. -.PP .SH "VERSION" .PP This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbpasswd(8)\fR, -samba(7), and +\fBsmbpasswd(8)\fR +samba(7) and the Internet RFC1321 for details on the MD4 algorithm. .SH "AUTHOR" .PP @@ -155,5 +153,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbpasswd.8 b/docs/manpages/smbpasswd.8 index 1a841e53ce..ee097cf6f1 100644 --- a/docs/manpages/smbpasswd.8 +++ b/docs/manpages/smbpasswd.8 @@ -1,17 +1,18 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBPASSWD" "8" "28 January 2002" "" "" +.TH "SMBPASSWD" "8" "01 October 2002" "" "" .SH NAME smbpasswd \- change a user's SMB password .SH SYNOPSIS -.sp -\fBsmbpasswd\fR [ \fB-a\fR ] [ \fB-x\fR ] [ \fB-d\fR ] [ \fB-e\fR ] [ \fB-D debuglevel\fR ] [ \fB-n\fR ] [ \fB-r <remote machine>\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-m\fR ] [ \fB-j DOMAIN\fR ] [ \fB-U username[%password]\fR ] [ \fB-h\fR ] [ \fB-s\fR ] [ \fB-w pass\fR ] [ \fBusername\fR ] + +\fBsmbpasswd\fR [ \fB-a\fR ] [ \fB-x\fR ] [ \fB-d\fR ] [ \fB-e\fR ] [ \fB-D debuglevel\fR ] [ \fB-n\fR ] [ \fB-r <remote machine>\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-m\fR ] [ \fB-U username[%password]\fR ] [ \fB-h\fR ] [ \fB-s\fR ] [ \fB-w pass\fR ] [ \fBusername\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP The smbpasswd program has several different functions, depending on whether it is run by the \fBroot\fR @@ -30,7 +31,7 @@ succeed the smbd daemon must be running on the local machine. On a UNIX machine the encrypted SMB passwords are usually stored in the \fIsmbpasswd(5)\fR file. .PP -When run by an ordinary user with no options. smbpasswd +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 @@ -40,7 +41,7 @@ the <Enter> key when asked for your old password. .PP 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 (-r) and -U options below. +Controllers. See the (-r) and -U options below. .PP When run by root, smbpasswd allows new users to be added and deleted in the smbpasswd file, as well as allows changes to @@ -56,7 +57,7 @@ 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 +password command. Note that the default passdb backends require the user to already exist in the system password file (usually \fI/etc/passwd\fR), else the request to add the user will fail. @@ -82,7 +83,7 @@ will fail. 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 \fBsmbpasswd(5) -\fRfor details on the 'old' and new password file formats. +\fR for details on the 'old' and new password file formats. This option is only available when running smbpasswd as root. @@ -94,7 +95,7 @@ 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. -If the smbpasswd file is in the 'old' format, then \fB smbpasswd\fR will FAIL to enable the account. +If the smbpasswd file is in the 'old' format, then \fB smbpasswd\fR will FAIL to enable the account. See \fBsmbpasswd (5)\fR for details on the 'old' and new password file formats. @@ -102,7 +103,7 @@ This option is only available when running smbpasswd as root. .TP \fB-D debuglevel\fR \fIdebuglevel\fR is an integer -from 0 to 10. The default value if this parameter is not specified +from 0 to 10. The default value if this parameter is not specified is zero. The higher this value, the more detail will be logged to the @@ -155,21 +156,21 @@ change). \fBNote\fR 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. +specifying a Win95/98 machine as remote machine target. .TP \fB-R name resolve order\fR -This option allows the user of smbpasswd to determine +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. -The options are :"lmhosts", "host", "wins" and "bcast". They cause -names to be resolved as follows : +The options are :"lmhosts", "host", "wins" and "bcast". They +cause names to be resolved as follows : .RS .TP 0.2i \(bu lmhosts : 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 lmhosts(5)for details) then +no name type attached to the NetBIOS name (see the lmhosts(5) for details) then any name type matches for lookup. .TP 0.2i \(bu @@ -178,14 +179,14 @@ name to IP address resolution, using the system \fI/etc/hosts \fR, 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 \fI/etc/nsswitch.conf\fR -file). Note that this method is only used if the NetBIOS name +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. .TP 0.2i \(bu wins : Query a name with the IP address listed in the \fIwins server\fR -parameter. If no WINS server has been specified this method +parameter. If no WINS server has been specified this method will be ignored. .TP 0.2i \(bu @@ -195,19 +196,18 @@ each of the known local interfaces listed in the reliable of the name resolution methods as it depends on the target host being on a locally connected subnet. .RE -.PP + The default order is \fBlmhosts, host, wins, bcast\fR and without this parameter or any entry in the \fIsmb.conf\fR file the name resolution methods will be attempted in this order. -.PP .TP \fB-m\fR 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. -This option is only available when running smbpasswd as root. +This option is only available when running smbpasswd as root. .TP \fB-U username\fR This option may only be used in conjunction @@ -218,26 +218,26 @@ is present to allow users who have different user names on different systems to change these passwords. .TP \fB-h\fR -This option prints the help string for \fB smbpasswd\fR, selecting the correct one for running as root +This option prints the help string for \fB smbpasswd\fR, selecting the correct one for running as root or as an ordinary user. .TP \fB-s\fR 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 \fI/dev/tty\fR +standard input, rather than from \fI/dev/tty\fR (like the \fBpasswd(1)\fR program does). This option is to aid people writing scripts to drive smbpasswd .TP \fB-w password\fR -This parameter is only available is Samba -has been configured to use the experiemental +This parameter is only available if Samba +has been configured to use the experimental \fB--with-ldapsam\fR option. The \fI-w\fR switch is used to specify the password to be used with the \fIldap admin -dn\fR. Note that the password is stored in +dn\fR Note that the password is stored in the \fIprivate/secrets.tdb\fR and is keyed off -of the admin's DN. This means that if the value of \fIldap -admin dn\fR ever changes, the password will beed to be +of the admin's DN. This means that if the value of \fIldap +admin dn\fR ever changes, the password will need to be manually updated as well. .TP \fBusername\fR @@ -248,7 +248,7 @@ to modify attributes directly in the local smbpasswd file. .SH "NOTES" .PP Since \fBsmbpasswd\fR works in client-server -mode communicating with a local smbd for a non-root user then +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 \fB smbd\fR running on the local machine by specifying a \fIallow hosts\fR or \fIdeny hosts\fR @@ -265,7 +265,7 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fIsmbpasswd(5)\fR, +\fIsmbpasswd(5)\fR samba(7) .SH "AUTHOR" .PP @@ -278,5 +278,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbsh.1 b/docs/manpages/smbsh.1 index 774607c3a2..b2eec12c81 100644 --- a/docs/manpages/smbsh.1 +++ b/docs/manpages/smbsh.1 @@ -1,17 +1,18 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBSH" "1" "08 May 2002" "" "" +.TH "SMBSH" "1" "01 October 2002" "" "" .SH NAME smbsh \- Allows access to Windows NT filesystem using UNIX commands .SH SYNOPSIS -.sp -\fBsmbsh\fR [ \fB-W workgroup\fR ] [ \fB-U username\fR ] [ \fB-P prefix\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-d <debug level>\fR ] [ \fB-l logfile\fR ] [ \fB-L libdir\fR ] + +\fBsmbsh\fR [ \fB-W workgroup\fR ] [ \fB-U username\fR ] [ \fB-P prefix\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-d <debug level>\fR ] [ \fB-l logfile\fR ] [ \fB-L libdir\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBsmbsh\fR allows you to access an NT filesystem using UNIX commands such as \fBls\fR, \fB egrep\fR, and \fBrcp\fR. You must use a @@ -28,7 +29,7 @@ servers. \fB-U username[%pass]\fR 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, +both the username and the password. If %pass is not specified, the user will be prompted for the password. .TP \fB-P prefix\fR @@ -62,14 +63,14 @@ the system \fI/etc/hosts\fR, 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 \fI/etc/nsswitch.conf -\fRfile). Note that this method is only used +\fR 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. .TP 0.2i \(bu wins : Query a name with the IP address listed in the -\fIwins server\fR parameter. If no +\fIwins server\fR parameter. If no WINS server has been specified this method will be ignored. .TP 0.2i @@ -81,18 +82,16 @@ parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet. .RE -.PP + If this parameter is not set then the name resolve order -defined in the \fIsmb.conf\fR file parameter +defined in the \fIsmb.conf\fR file parameter (name resolve order) will be used. -.PP -.PP + The default order is lmhosts, host, wins, bcast. Without this parameter or any entry in the \fIname resolve order -\fRparameter of the \fIsmb.conf\fR +\fR parameter of the \fIsmb.conf\fR file, the name resolution methods will be attempted in this order. -.PP .TP \fB-d <debug level>\fR debug level is an integer from 0 to 10. @@ -107,7 +106,7 @@ about the activities of \fBnmblookup\fR. At level \fB-l logfilename\fR If specified causes all debug messages to be written to the file specified by \fIlogfilename -\fR\&. If not specified then all messages will be +\fR. If not specified then all messages will be written to\fIstderr\fR. .TP \fB-L libdir\fR @@ -120,24 +119,23 @@ To use the \fBsmbsh\fR command, execute \fB smbsh\fR from the prompt and enter t that authenticates you to the machine running the Windows NT operating system. .PP -.sp + .nf system% \fBsmbsh\fR Username: \fBuser\fR Password: \fBXXXXXXX\fR -.sp .fi .PP Any dynamically linked command you execute from this shell will access the \fI/smb\fR directory using the smb protocol. For example, the command \fBls /smb -\fRwill show a list of workgroups. The command +\fR will show a list of workgroups. The command \fBls /smb/MYGROUP \fR will show all the machines in -the workgroup MYGROUP. The command +the workgroup MYGROUP. The command \fBls /smb/MYGROUP/<machine-name>\fR will show the share names for that machine. You could then, for example, use the \fB cd\fR command to change directories, \fBvi\fR to -edit files, and \fBrcp\fR to copy files. +edit files, and \fBrcp\fR to copy files. .SH "VERSION" .PP This man page is correct for version 2.2 of @@ -147,7 +145,7 @@ the Samba suite. \fBsmbsh\fR works by intercepting the standard libc calls with the dynamically loaded versions in \fI smbwrapper.o\fR. Not all calls have been "wrapped", so some programs may not function correctly under \fBsmbsh -\fR\&. +\fR. .PP Programs which are not dynamically linked cannot make use of \fBsmbsh\fR's functionality. Most versions @@ -155,7 +153,7 @@ of UNIX have a \fBfile\fR command that will describe how a program was linked. .SH "SEE ALSO" .PP -\fBsmbd(8)\fR, +\fBsmbd(8)\fR smb.conf(5) .SH "AUTHOR" .PP @@ -168,5 +166,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbspool.8 b/docs/manpages/smbspool.8 index 779ba4921f..e9496e7a74 100644 --- a/docs/manpages/smbspool.8 +++ b/docs/manpages/smbspool.8 @@ -1,17 +1,18 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBSPOOL" "8" "28 January 2002" "" "" +.TH "SMBSPOOL" "8" "01 October 2002" "" "" .SH NAME -smbspool \- send print file to an SMB printer +smbspool \- send a print file to an SMB printer .SH SYNOPSIS -.sp -\fBsmbspool\fR [ \fBjob\fR ] [ \fBuser\fR ] [ \fBtitle\fR ] [ \fBcopies\fR ] [ \fBoptions\fR ] [ \fBfilename\fR ] + +\fBsmbspool\fR [ \fBjob\fR ] [ \fBuser\fR ] [ \fBtitle\fR ] [ \fBcopies\fR ] [ \fBoptions\fR ] [ \fBfilename\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP smbspool is a very small print spooling program that sends a print file to an SMB printer. The command-line arguments @@ -40,12 +41,10 @@ smb://username:password@workgroup/server/printer smbspool tries to get the URI from argv[0]. If argv[0] contains the name of the program then it looks in the \fB DEVICE_URI\fR environment variable. .PP -.PP Programs using the \fBexec(2)\fR functions can pass the URI in argv[0], while shell scripts must set the \fBDEVICE_URI\fR environment variable prior to running smbspool. -.PP .SH "OPTIONS" .TP 0.2i \(bu @@ -64,12 +63,12 @@ when sending the print job. \(bu The copies argument (argv[4]) contains the number of copies to be printed of the named file. If -no filename is provided than this argument is not used by +no filename is provided then this argument is not used by smbspool. .TP 0.2i \(bu The options argument (argv[5]) contains -the print options in a single string and is presently +the print options in a single string and is currently not used by smbspool. .TP 0.2i \(bu @@ -82,8 +81,8 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd(8)\fR, -and samba(7). +\fBsmbd(8)\fR +and samba(7) .SH "AUTHOR" .PP \fBsmbspool\fR was written by Michael Sweet @@ -98,5 +97,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbstatus.1 b/docs/manpages/smbstatus.1 index 1f5d4f7571..fc452ae731 100644 --- a/docs/manpages/smbstatus.1 +++ b/docs/manpages/smbstatus.1 @@ -3,16 +3,16 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBSTATUS" "1" "28 March 2002" "" "" +.TH "SMBSTATUS" "1" "01 October 2002" "" "" .SH NAME smbstatus \- report on current Samba connections .SH SYNOPSIS -\fBsmbstatus\fR [ \fB-P\fR] [ \fB-b\fR] [ \fB-d <debug level>\fR] [ \fB-v\fR] [ \fB-L\fR] [ \fB-B\fR] [ \fB-p\fR] [ \fB-S\fR] [ \fB-s <configuration file>\fR] [ \fB-u <username>\fR] +\fBsmbstatus\fR [ \fB-P\fR ] [ \fB-b\fR ] [ \fB-d <debug level>\fR ] [ \fB-v\fR ] [ \fB-L\fR ] [ \fB-B\fR ] [ \fB-p\fR ] [ \fB-S\fR ] [ \fB-s <configuration file>\fR ] [ \fB-u <username>\fR ] .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBsmbstatus\fR is a very simple program to list the current Samba connections. @@ -39,7 +39,7 @@ causes smbstatus to only list locks. causes smbstatus to include byte range locks. .TP \fB-p|--processes\fR -print a list of \fBsmbd(8)\fRprocesses and exit. +print a list of \fBsmbd(8)\fR processes and exit. Useful for scripting. .TP \fB-S|--shares\fR @@ -49,7 +49,7 @@ causes smbstatus to only list shares. The default configuration file name is determined at compile time. The file specified contains the configuration details required by the server. See \fIsmb.conf(5)\fR -for more information. + for more information. .TP \fB-u|--user=<username>\fR selects information relevant to @@ -60,8 +60,8 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd(8)\fRand -smb.conf(5). +\fBsmbd(8)\fR and +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities diff --git a/docs/manpages/smbtar.1 b/docs/manpages/smbtar.1 index b9bbf3df15..bee874dcba 100644 --- a/docs/manpages/smbtar.1 +++ b/docs/manpages/smbtar.1 @@ -1,20 +1,21 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBTAR" "1" "28 January 2002" "" "" +.TH "SMBTAR" "1" "01 October 2002" "" "" .SH NAME smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives .SH SYNOPSIS -.sp -\fBsmbtar\fR \fB-s server\fR [ \fB-p password\fR ] [ \fB-x services\fR ] [ \fB-X\fR ] [ \fB-d directory\fR ] [ \fB-u user\fR ] [ \fB-t tape\fR ] [ \fB-t tape\fR ] [ \fB-b blocksize\fR ] [ \fB-N filename\fR ] [ \fB-i\fR ] [ \fB-r\fR ] [ \fB-l loglevel\fR ] [ \fB-v\fR ] \fBfilenames\fR + +\fBsmbtar\fR \fB-s server\fR [ \fB-p password\fR ] [ \fB-x services\fR ] [ \fB-X\fR ] [ \fB-d directory\fR ] [ \fB-u user\fR ] [ \fB-t tape\fR ] [ \fB-t tape\fR ] [ \fB-b blocksize\fR ] [ \fB-N filename\fR ] [ \fB-i\fR ] [ \fB-r\fR ] [ \fB-l loglevel\fR ] [ \fB-v\fR ] \fBfilenames\fR + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBsmbtar\fR is a very small shell script on top -of \fBsmbclient(1)\fR +of \fBsmbclient(1)\fR which dumps SMB shares directly to tape. .SH "OPTIONS" .TP @@ -32,7 +33,7 @@ create or restore. .TP \fB-d directory\fR Change to initial \fIdirectory -\fRbefore restoring / backing up files. +\fR before restoring / backing up files. .TP \fB-v\fR Verbose mode. @@ -49,7 +50,7 @@ UNIX login name. Tape device. May be regular file or tape device. Default: \fI$TAPE\fR environmental variable; if not set, a file called \fItar.out -\fR\&. +\fR. .TP \fB-b blocksize\fR Blocking factor. Defaults to 20. See @@ -72,7 +73,7 @@ from the tar file. \fB-l log level\fR Log (debug) level. Corresponds to the \fI-d\fR flag of \fBsmbclient(1) -\fR\&. +\fR. .SH "ENVIRONMENT VARIABLES" .PP The \fI$TAPE\fR variable specifies the @@ -81,27 +82,27 @@ with the -t option. .SH "BUGS" .PP The \fBsmbtar\fR script has different -options from ordinary tar and tar called from smbclient. +options from ordinary tar and from smbclient's tar command. .SH "CAVEATS" .PP 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 +on entire shares; should work on file lists. smbtar works best with GNU tar and may not work well with other versions. .SH "DIAGNOSTICS" .PP See the \fBDIAGNOSTICS\fR section for the \fBsmbclient(1)\fR -command. + command. .SH "VERSION" .PP -This man page is correct for version 2.2 of +This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd(8)\fR, -\fBsmbclient(1)\fR, -smb.conf(5), +\fBsmbd(8)\fR +\fBsmbclient(1)\fR +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -109,12 +110,12 @@ 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. .PP -Ricky Poulten <URL:mailto:poultenr@logica.co.uk> +Ricky Poulten <URL:mailto:poultenr@logica.co.uk> wrote the tar extension and this man page. The \fBsmbtar\fR script was heavily rewritten and improved by Martin Kraemer <URL:mailto:Martin.Kraemer@mch.sni.de>. 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. diff --git a/docs/manpages/smbumount.8 b/docs/manpages/smbumount.8 index bf64061e3a..da16cc5288 100644 --- a/docs/manpages/smbumount.8 +++ b/docs/manpages/smbumount.8 @@ -1,21 +1,22 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBUMOUNT" "8" "28 January 2002" "" "" +.TH "SMBUMOUNT" "8" "01 October 2002" "" "" .SH NAME smbumount \- smbfs umount for normal users .SH SYNOPSIS -.sp + \fBsmbumount\fR \fBmount-point\fR + .SH "DESCRIPTION" .PP With this program, normal users can unmount smb-filesystems, -provided that it is suid root. \fBsmbumount\fR has +provided that it is suid root. \fBsmbumount\fR 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. +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, but it would certainly be problematic to make umount setuid root. diff --git a/docs/manpages/swat.8 b/docs/manpages/swat.8 index e42d963806..c097dd499b 100644 --- a/docs/manpages/swat.8 +++ b/docs/manpages/swat.8 @@ -1,20 +1,21 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SWAT" "8" "28 January 2002" "" "" +.TH "SWAT" "8" "01 October 2002" "" "" .SH NAME swat \- Samba Web Administration Tool .SH SYNOPSIS -.sp -\fBswat\fR [ \fB-s <smb config file>\fR ] [ \fB-a\fR ] + +\fBswat\fR [ \fB-s <smb config file>\fR ] [ \fB-a\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBswat\fR allows a Samba administrator to -configure the complex \fI smb.conf(5)\fRfile via a Web browser. In addition, +configure the complex \fI smb.conf(5)\fR file via a Web browser. In addition, a \fBswat\fR configuration page has help links to all the configurable options in the \fIsmb.conf\fR file allowing an administrator to easily look up the effects of any change. @@ -24,9 +25,9 @@ administrator to easily look up the effects of any change. .TP \fB-s smb configuration file\fR The default configuration file path is -determined at compile time. The file specified contains +determined at compile time. The file specified contains the configuration details required by the \fBsmbd -\fRserver. This is the file that \fBswat\fR will modify. +\fR server. This is the file that \fBswat\fR 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. @@ -37,12 +38,12 @@ This option disables authentication and puts \fBswat\fR in demo mode. In that mode anyone will be able to modify the \fIsmb.conf\fR file. -\fBDo NOT enable this option on a production +\fBWARNING: Do NOT enable this option on a production server. \fR .SH "INSTALLATION" .PP After you compile SWAT you need to run \fBmake install -\fRto install the \fBswat\fR binary +\fR to install the \fBswat\fR binary and the various help files and images. A default install would put these in: .TP 0.2i @@ -57,16 +58,16 @@ these in: .SS "INETD INSTALLATION" .PP You need to edit your \fI/etc/inetd.conf -\fRand \fI/etc/services\fR +\fR and \fI/etc/services\fR to enable SWAT to be launched via \fBinetd\fR. .PP In \fI/etc/services\fR you need to add a line like this: .PP -\fBswat 901/tcp\fR +\fBswat 901/tcp\fR .PP Note for NIS/YP users - you may need to rebuild the -NIS service maps rather than alter your local \fI /etc/services\fR file. +NIS service maps rather than alter your local \fI /etc/services\fR file. .PP the choice of port number isn't really important except that it should be less than 1024 and not currently @@ -77,13 +78,13 @@ hole depending on the implementation details of your In \fI/etc/inetd.conf\fR you should add a line like this: .PP -\fBswat stream tcp nowait.400 root +\fBswat stream tcp nowait.400 root /usr/local/samba/bin/swat swat\fR .PP One you have edited \fI/etc/services\fR and \fI/etc/inetd.conf\fR you need to send a HUP signal to inetd. To do this use \fBkill -1 PID -\fRwhere PID is the process ID of the inetd daemon. +\fR where PID is the process ID of the inetd daemon. .SS "LAUNCHING" .PP To launch SWAT just run your favorite web browser and @@ -102,20 +103,20 @@ information for the meta-daemon. \fB\fI/etc/services\fB\fR This file must contain a mapping of service name (e.g., swat) to service port (e.g., 901) and protocol type -(e.g., tcp). +(e.g., tcp). .TP \fB\fI/usr/local/samba/lib/smb.conf\fB\fR This is the default location of the \fIsmb.conf(5) -\fRserver configuration file that swat edits. Other -common places that systems install this file are \fI /usr/samba/lib/smb.conf\fR and \fI/etc/smb.conf -\fR\&. This file describes all the services the server +\fR server configuration file that swat edits. Other +common places that systems install this file are \fI /usr/samba/lib/smb.conf\fR and \fI/etc/smb.conf +\fR. This file describes all the services the server is to make available to clients. .SH "WARNINGS" .PP \fBswat\fR will rewrite your \fIsmb.conf -\fRfile. It will rearrange the entries and delete all -comments, \fIinclude=\fR and \fIcopy=" -\fRoptions. If you have a carefully crafted \fI smb.conf\fR then back it up or don't use swat! +\fR file. It will rearrange the entries and delete all +comments, \fIinclude=\fR and \fIcopy= +\fR options. If you have a carefully crafted \fI smb.conf\fR then back it up or don't use swat! .SH "VERSION" .PP This man page is correct for version 2.2 of @@ -123,7 +124,7 @@ the Samba suite. .SH "SEE ALSO" .PP \fBinetd(5)\fR, -\fBsmbd(8)\fR, +\fBsmbd(8)\fR smb.conf(5) .SH "AUTHOR" .PP @@ -136,5 +137,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/testparm.1 b/docs/manpages/testparm.1 index d463db78b1..a53e066acf 100644 --- a/docs/manpages/testparm.1 +++ b/docs/manpages/testparm.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "TESTPARM" "1" "21 August 2002" "" "" +.TH "TESTPARM" "1" "01 October 2002" "" "" .SH NAME testparm \- check an smb.conf configuration file for internal correctness .SH SYNOPSIS @@ -12,7 +12,7 @@ testparm \- check an smb.conf configuration file for internal correctness .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBtestparm\fR is a very simple test program to check an \fBsmbd\fR configuration file for @@ -90,7 +90,7 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fIsmb.conf(5)\fR, +\fIsmb.conf(5)\fR \fBsmbd(8)\fR .SH "AUTHOR" .PP @@ -102,6 +102,6 @@ to the way the Linux kernel is developed. 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 -ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/testprns.1 b/docs/manpages/testprns.1 index bc1a27b198..5d5cb97f31 100644 --- a/docs/manpages/testprns.1 +++ b/docs/manpages/testprns.1 @@ -1,21 +1,22 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "TESTPRNS" "1" "28 January 2002" "" "" +.TH "TESTPRNS" "1" "01 October 2002" "" "" .SH NAME testprns \- check printer name for validity with smbd .SH SYNOPSIS -.sp -\fBtestprns\fR \fBprintername\fR [ \fBprintcapname\fR ] + +\fBtestprns\fR \fBprintername\fR [ \fBprintcapname\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP \fBtestprns\fR is a very simple test program to determine whether a given printer name is valid for use in -a service to be provided by \fB smbd(8)\fR. +a service to be provided by \fB smbd(8)\fR .PP "Valid" in this context means "can be found in the printcap specified". This program is very stupid - so stupid in @@ -41,7 +42,7 @@ This is the name of the printcap file within which to search for the given printer name. If no printcap name is specified \fBtestprns -\fRwill attempt to scan the printcap file name +\fR will attempt to scan the printcap file name specified at compile time. .SH "FILES" .TP @@ -73,7 +74,7 @@ the Samba suite. .SH "SEE ALSO" .PP \fIprintcap(5)\fR, -\fBsmbd(8)\fR, +\fBsmbd(8)\fR \fBsmbclient(1)\fR .SH "AUTHOR" .PP @@ -86,5 +87,5 @@ 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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1 index 78e6e6c35a..dc3092bc66 100644 --- a/docs/manpages/vfstest.1 +++ b/docs/manpages/vfstest.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "VFSTEST" "1" "20 August 2002" "" "" +.TH "VFSTEST" "1" "01 October 2002" "" "" .SH NAME vfstest \- tool for testing samba VFS modules .SH SYNOPSIS @@ -12,29 +12,30 @@ vfstest \- tool for testing samba VFS modules .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP -\fBvfstest\fR is a small command line +\fBvfstest\fR 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 +user the ability to call the various VFS functions manually and supports cascaded VFS modules. .SH "OPTIONS" .TP \fB-c|--command=command\fR -Execute the specified (colon-seperated) commands. +Execute the specified (colon-seperated) commands. See below for the commands that are available. .TP \fB-d|--debug=debuglevel\fR -set the debuglevel. Debug level 0 is the lowest +set the debuglevel. Debug level 0 is the lowest and 100 being the highest. This should be set to 100 if you are -planning on submitting a bug report to the Samba team (see \fIBUGS.txt\fR). +planning on submitting a bug report to the Samba team (see +\fIBUGS.txt\fR). .TP \fB-h|--help\fR Print a summary of command line options. .TP \fB-l|--logfile=logbasename\fR -File name for log/debug files. The extension -\&'.client' will be appended. The log file is never removed +File name for log/debug files. The extension +\&'.client' will be appended. The log file is never removed by the client. .SH "COMMANDS" .PP @@ -166,13 +167,13 @@ by the client. \fBexit\fR - Exit vfstest .SH "VERSION" .PP -This man page is correct for version 3.0 of the Samba +This man page is correct for version 3.0 of the Samba suite. .SH "AUTHOR" .PP -The original Samba software and related utilities +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 +by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. .PP The vfstest man page was written by Jelmer Vernooij. diff --git a/docs/manpages/wbinfo.1 b/docs/manpages/wbinfo.1 index 57aaf98b62..96464987e3 100644 --- a/docs/manpages/wbinfo.1 +++ b/docs/manpages/wbinfo.1 @@ -1,20 +1,21 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "WBINFO" "1" "08 May 2002" "" "" +.TH "WBINFO" "1" "01 October 2002" "" "" .SH NAME wbinfo \- Query information from winbind daemon .SH SYNOPSIS -.sp -\fBwbinfo\fR [ \fB-u\fR ] [ \fB-g\fR ] [ \fB-h name\fR ] [ \fB-i ip\fR ] [ \fB-n name\fR ] [ \fB-s sid\fR ] [ \fB-U uid\fR ] [ \fB-G gid\fR ] [ \fB-S sid\fR ] [ \fB-Y sid\fR ] [ \fB-t\fR ] [ \fB-m\fR ] [ \fB-r user\fR ] [ \fB-a user%password\fR ] [ \fB-A user%password\fR ] + +\fBwbinfo\fR [ \fB-u\fR ] [ \fB-g\fR ] [ \fB-h name\fR ] [ \fB-i ip\fR ] [ \fB-n name\fR ] [ \fB-s sid\fR ] [ \fB-U uid\fR ] [ \fB-G gid\fR ] [ \fB-S sid\fR ] [ \fB-Y sid\fR ] [ \fB-t\fR ] [ \fB-m\fR ] [ \fB-r user\fR ] [ \fB-a user%password\fR ] [ \fB-A user%password\fR ] + .SH "DESCRIPTION" .PP -This tool is part of the Sambasuite. +This tool is part of the Samba suite. .PP The \fBwbinfo\fR program queries and returns information -created and used by the \fB winbindd(8)\fRdaemon. +created and used by the \fB winbindd(8)\fR daemon. .PP The \fBwinbindd(8)\fR daemon must be configured and running for the \fBwbinfo\fR program to be able @@ -24,16 +25,16 @@ to return information. \fB-u\fR This option will list all users available in the Windows NT domain for which the \fBwinbindd(8) -\fRdaemon is operating in. Users in all trusted domains -will also be listed. Note that this operation does not assign +\fR 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 \fBwinbindd(8)\fR. .TP \fB-g\fR This option will list all groups available in the Windows NT domain for which the \fBwinbindd(8) -\fRdaemon is operating in. Groups in all trusted domains -will also be listed. Note that this operation does not assign +\fR 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 \fBwinbindd(8)\fR. .TP @@ -51,38 +52,38 @@ specified by the \fIip\fR parameter. .TP \fB-n name\fR The \fI-n\fR option -queries \fBwinbindd(8)\fR for the SID +queries \fBwinbindd(8)\fR for the SID associated with the name specified. Domain names can be specified -before the user name by using the winbind separator character. +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 +user in the domain CWDOM1. If no domain is specified then the domain used is the one specified in the \fIsmb.conf\fR \fIworkgroup\fR parameter. .TP \fB-s sid\fR Use \fI-s\fR to resolve -a SID to a name. This is the inverse of the \fI-n -\fRoption above. SIDs must be specified as ASCII strings +a SID to a name. This is the inverse of the \fI-n +\fR option above. SIDs must be specified as ASCII strings in the traditional Microsoft format. For example, S-1-5-21-1455342024-3071081365-2475485837-500. .TP \fB-U uid\fR Try to convert a UNIX user id to a Windows NT -SID. If the uid specified does not refer to one within +SID. If the uid specified does not refer to one within the winbind uid range then the operation will fail. .TP \fB-G gid\fR Try to convert a UNIX group id to a Windows -NT SID. If the gid specified does not refer to one within +NT SID. If the gid specified does not refer to one within the winbind gid range then the operation will fail. .TP \fB-S sid\fR -Convert a SID to a UNIX user id. If the SID -does not correspond to a UNIX user mapped by \fB winbindd(8)\fR then the operation will fail. +Convert a SID to a UNIX user id. If the SID +does not correspond to a UNIX user mapped by \fB winbindd(8)\fR then the operation will fail. .TP \fB-Y sid\fR -Convert a SID to a UNIX group id. If the SID -does not correspond to a UNIX group mapped by \fB winbindd(8)\fR then the operation will fail. +Convert a SID to a UNIX group id. If the SID +does not correspond to a UNIX group mapped by \fB winbindd(8)\fR then the operation will fail. .TP \fB-t\fR Verify that the workstation trust account @@ -92,12 +93,12 @@ domain is working. \fB-m\fR Produce a list of domains trusted by the Windows NT server \fBwinbindd(8)\fR contacts -when resolving names. This list does not include the Windows +when resolving names. This list does not include the Windows NT domain the server is a Primary Domain Controller for. .TP \fB-r username\fR Try to obtain the list of UNIX group ids -to which the user belongs. This only works for users +to which the user belongs. This only works for users defined on a Domain Controller. .TP \fB-a username%password\fR @@ -106,15 +107,15 @@ This checks both authenticaion methods and reports its results. .TP \fB-A username%password\fR Store username and password used by winbindd -during session setup to a domain controller. This enables +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 compatiable with Windows 2000 servers only). .SH "EXIT STATUS" .PP The wbinfo program returns 0 if the operation -succeeded, or 1 if the operation failed. If the \fBwinbindd(8) -\fRdaemon is not working \fBwbinfo\fR will always return +succeeded, or 1 if the operation failed. If the \fBwinbindd(8) +\fR daemon is not working \fBwbinfo\fR will always return failure. .SH "VERSION" .PP diff --git a/docs/manpages/winbindd.8 b/docs/manpages/winbindd.8 index ca0c87bd08..fe02c424e1 100644 --- a/docs/manpages/winbindd.8 +++ b/docs/manpages/winbindd.8 @@ -1,24 +1,25 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "WINBINDD" "8" "08 May 2002" "" "" +.TH "WINBINDD" "8" "01 October 2002" "" "" .SH NAME winbindd \- Name Service Switch daemon for resolving names from NT servers .SH SYNOPSIS -.sp -\fBwinbindd\fR [ \fB-i\fR ] [ \fB-d <debug level>\fR ] [ \fB-s <smb config file>\fR ] + +\fBwinbindd\fR [ \fB-i\fR ] [ \fB-d <debug level>\fR ] [ \fB-s <smb config file>\fR ] + .SH "DESCRIPTION" .PP -This program is part of the Sambasuite. +This program is part of the Samba suite. .PP \fBwinbindd\fR is a daemon that provides a service for the Name Service Switch capability that is present -in most modern C libraries. The Name Service Switch allows user +in most modern C libraries. 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 \fI/etc/nsswitch.conf\fR file. +services such as NIS or DNS. The exact behaviour can be configured +throught the \fI/etc/nsswitch.conf\fR 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. @@ -30,10 +31,10 @@ services via an associated PAM module. .PP The \fIpam_winbind\fR module in the 2.2.2 release only supports the \fIauth\fR and \fIaccount\fR -module-types. The latter is simply +module-types. The latter simply performs a getpwnam() to verify that the system can obtain a uid for the -user. If the \fIlibnss_winbind\fR library has been correctly -installed, this should always suceed. +user. If the \fIlibnss_winbind\fR library has been correctly +installed, this should always succeed. .PP The following nsswitch databases are implemented by the winbindd service: @@ -51,37 +52,33 @@ the \fIpasswd(5)\fR file and used by .TP \fBgroup\fR Group information traditionally stored in -the \fIgroup(5)\fR file and used by +the \fIgroup(5)\fR file and used by \fBgetgrent(3)\fR functions. .PP For example, the following simple configuration in the \fI/etc/nsswitch.conf\fR file can be used to initially resolve user and group information from \fI/etc/passwd -\fRand \fI/etc/group\fR and then from the +\fR and \fI/etc/group\fR and then from the Windows NT server. .PP -.PP -.sp + .nf passwd: files winbind group: files winbind -.sp .fi .PP -.PP The following simple configuration in the \fI/etc/nsswitch.conf\fR file can be used to initially resolve hostnames from \fI/etc/hosts\fR and then from the WINS server. -.PP .SH "OPTIONS" .TP \fB-d debuglevel\fR Sets the debuglevel to an integer between 0 and 100. 0 is for no debugging and 100 is for reams and reams. To submit a bug report to the Samba Team, use debug -level 100 (see BUGS.txt). +level 100 (see BUGS.txt). .TP \fB-i\fR Tells \fBwinbindd\fR to not @@ -92,20 +89,20 @@ of \fBwinbindd\fR is required. .PP Users and groups on a Windows NT server are assigned a relative id (rid) which is unique for the domain when the -user or group is created. To convert the Windows NT user or group +user or group is created. To convert the Windows NT user or group into a unix user or group, a mapping between rids and unix user -and group ids is required. This is one of the jobs that \fB winbindd\fR performs. +and group ids is required. This is one of the jobs that \fB winbindd\fR performs. .PP As winbindd users and groups are resolved from a server, user -and group ids are allocated from a specified range. This +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 +or group enumeration command. The allocated unix ids are stored in a database file under the Samba lock directory and will be remembered. .PP WARNING: The rid to unix id database is the only location -where the user and group mappings are stored by winbindd. If this +where the user and group mappings are stored by winbindd. If this file 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. @@ -113,121 +110,35 @@ and group rids. .PP Configuration of the \fBwinbindd\fR daemon is done through configuration parameters in the \fIsmb.conf(5) -\fRfile. All parameters should be specified in the +\fR file. All parameters should be specified in the [global] section of smb.conf. -.TP -\fBwinbind separator\fR -The winbind separator option allows you -to specify how NT domain names and user names are combined -into unix user names when presented to users. By default, -\fBwinbindd\fR will use the traditional '\\' -separator so that the unix user names look like -DOMAIN\\username. In some cases this separator character may -cause problems as the '\\' character has special meaning in -unix shells. In that case you can use the winbind separator -option to specify an alternative separator character. Good -alternatives may be '/' (although that conflicts -with the unix directory separator) or a '+ 'character. -The '+' character appears to be the best choice for 100% -compatibility with existing unix utilities, but may be an -aesthetically bad choice depending on your taste. - -Default: \fBwinbind separator = \\ \fR - -Example: \fBwinbind separator = + \fR -.TP -\fBwinbind uid\fR -The winbind uid parameter specifies the -range of user ids that are allocated by the winbindd daemon. -This range of ids should have no existing local or NIS users -within it as strange conflicts can occur otherwise. - -Default: \fBwinbind uid = <empty string> -\fR -Example: \fBwinbind uid = 10000-20000\fR -.TP -\fBwinbind gid\fR -The winbind gid parameter specifies the -range of group ids that are allocated by the winbindd daemon. -This range of group ids should have no existing local or NIS -groups within it as strange conflicts can occur otherwise. - -Default: \fBwinbind gid = <empty string> -\fR -Example: \fBwinbind gid = 10000-20000 -\fR.TP -\fBwinbind cache time\fR -This parameter specifies the number of -seconds the winbindd daemon will cache user and group information -before querying a Windows NT server again. When a item in the -cache is older than this time winbindd will ask the domain -controller for the sequence number of the server's account database. -If the sequence number has not changed then the cached item is -marked as valid for a further \fIwinbind cache time -\fRseconds. Otherwise the item is fetched from the -server. This means that as long as the account database is not -actively changing winbindd will only have to send one sequence -number query packet every \fIwinbind cache time -\fRseconds. - -Default: \fBwinbind cache time = 15\fR -.TP -\fBwinbind enum users\fR -On large installations it may be necessary -to suppress the enumeration of users through the \fB setpwent()\fR, \fBgetpwent()\fR and -\fBendpwent()\fR group of system calls. If -the \fIwinbind enum users\fR parameter is false, -calls to the \fBgetpwent\fR system call will not -return any data. - -\fBWarning:\fR Turning off user enumeration -may cause some programs to behave oddly. For example, the \fBfinger\fR -program relies on having access to the full user list when -searching for matching usernames. - -Default: \fBwinbind enum users = yes \fR -.TP -\fBwinbind enum groups\fR -On large installations it may be necessary -to suppress the enumeration of groups through the \fB setgrent()\fR, \fBgetgrent()\fR and -\fBendgrent()\fR group of system calls. If -the \fIwinbind enum groups\fR parameter is -false, calls to the \fBgetgrent()\fR system -call will not return any data. - -\fBWarning:\fR Turning off group -enumeration may cause some programs to behave oddly. - -Default: \fBwinbind enum groups = no \fR -.TP -\fBtemplate homedir\fR -When filling out the user information -for a Windows NT user, the \fBwinbindd\fR daemon -uses this parameter to fill in the home directory for that user. -If the string \fI%D\fR is present it is -substituted with the user's Windows NT domain name. If the -string \fI%U\fR is present it is substituted -with the user's Windows NT user name. - -Default: \fBtemplate homedir = /home/%D/%U \fR -.TP -\fBtemplate shell\fR -When filling out the user information for -a Windows NT user, the \fBwinbindd\fR daemon -uses this parameter to fill in the shell for that user. - -Default: \fBtemplate shell = /bin/false \fR -.TP -\fBwinbind use default domain\fR -This parameter specifies whether the \fBwinbindd\fR -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. - -Default: \fBwinbind use default domain = <falseg> -\fR -Example: \fBwinbind use default domain = true\fR +.TP 0.2i +\(bu +\fIwinbind separator\fR +.TP 0.2i +\(bu +\fIwinbind uid\fR +.TP 0.2i +\(bu +\fIwinbind gid\fR +.TP 0.2i +\(bu +\fIwinbind cache time\fR +.TP 0.2i +\(bu +\fIwinbind enum users\fR +.TP 0.2i +\(bu +\fIwinbind enum groups\fR +.TP 0.2i +\(bu +\fItemplate homedir\fR +.TP 0.2i +\(bu +\fItemplate shell\fR +.TP 0.2i +\(bu +\fIwinbind use default domain\fR .SH "EXAMPLE SETUP" .PP To setup winbindd for user and group lookups plus @@ -237,25 +148,23 @@ following setup. This was tested on a RedHat 6.2 Linux box. In \fI/etc/nsswitch.conf\fR put the following: .PP -.sp + .nf passwd: files winbind group: files winbind -.sp .fi .PP In \fI/etc/pam.d/*\fR replace the \fIauth\fR lines with something like this: .PP -.sp + .nf 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_pwdb.so use_first_pass shadow nullok -.sp .fi .PP Note in particular the use of the \fIsufficient\fR @@ -263,10 +172,11 @@ keyword and the \fIuse_first_pass\fR keyword. .PP Now replace the account lines with this: .PP -\fBaccount required /lib/security/pam_winbind.so -\fR.PP +\fBaccount required /lib/security/pam_winbind.so +\fR +.PP The next step is to join the domain. To do that use the -\fBsmbpasswd\fR program like this: +\fBsmbpasswd\fR program like this: .PP \fBsmbpasswd -j DOMAIN -r PDC -U Administrator\fR @@ -278,16 +188,16 @@ for "PDC". .PP Next copy \fIlibnss_winbind.so\fR to \fI/lib\fR and \fIpam_winbind.so\fR -to \fI/lib/security\fR. A symbolic link needs to be +to \fI/lib/security\fR. A symbolic link needs to be made from \fI/lib/libnss_winbind.so\fR to -\fI/lib/libnss_winbind.so.2\fR. If you are using an +\fI/lib/libnss_winbind.so.2\fR. If you are using an older version of glibc then the target of the link should be \fI/lib/libnss_winbind.so.1\fR. .PP Finally, setup a \fIsmb.conf\fR containing directives like the -following: +following: .PP -.sp + .nf [global] winbind separator = + @@ -300,7 +210,6 @@ following: security = domain password server = * -.sp .fi .PP Now start winbindd and you should find that your user and @@ -308,7 +217,7 @@ 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 \fBgetent passwd\fR and \fBgetent group -\fRto confirm the correct operation of winbindd. +\fR to confirm the correct operation of winbindd. .SH "NOTES" .PP The following notes are useful when configuring and @@ -317,21 +226,21 @@ running \fBwinbindd\fR: \fBnmbd\fR must be running on the local machine for \fBwinbindd\fR to work. \fBwinbindd\fR queries the list of trusted domains for the Windows NT server -on startup and when a SIGHUP is received. Thus, for a running \fB winbindd\fR to become aware of new trust relationships between +on startup and when a SIGHUP is received. Thus, for a running \fB winbindd\fR to become aware of new trust relationships between servers, it must be sent a SIGHUP signal. .PP Client processes resolving names through the \fBwinbindd\fR -nsswitch module read an environment variable named \fB $WINBINDD_DOMAIN\fR. If this variable contains a comma separated +nsswitch module read an environment variable named \fB $WINBINDD_DOMAIN\fR. If this variable contains a comma separated list of Windows NT domain names, then winbindd will only resolve users and groups within those Windows NT domains. .PP -PAM is really easy to misconfigure. Make sure you know what -you are doing when modifying PAM configuration files. It is possible +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. .PP If more than one UNIX machine is running \fBwinbindd\fR, 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 +be the same. The user and group ids will only be valid for the local machine. .PP If the the Windows NT RID to UNIX user and group id mapping @@ -344,12 +253,12 @@ The following signals can be used to manipulate the \fBSIGHUP\fR Reload the \fIsmb.conf(5)\fR 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. +version of winbindd. This signal also clears any cached +user and group information. The list of other domains trusted +by winbindd is also reloaded. .TP \fBSIGUSR1\fR -The SIGUSR1 signal will cause \fB winbindd\fR to write status information to the winbind +The SIGUSR1 signal will cause \fB winbindd\fR to write status information to the winbind log file including information about the number of user and group ids allocated by \fBwinbindd\fR. @@ -362,7 +271,7 @@ Name service switch configuration file. .TP \fB/tmp/.winbindd/pipe\fR The UNIX pipe over which clients communicate with -the \fBwinbindd\fR program. For security reasons, the +the \fBwinbindd\fR program. For security reasons, the winbind client will only attempt to connect to the winbindd daemon if both the \fI/tmp/.winbindd\fR directory and \fI/tmp/.winbindd/pipe\fR file are owned by @@ -373,10 +282,10 @@ Implementation of name service switch library. .TP \fB$LOCKDIR/winbindd_idmap.tdb\fR Storage for the Windows NT rid to UNIX user/group -id mapping. The lock directory is specified when Samba is initially +id mapping. The lock directory is specified when Samba is initially compiled using the \fI--with-lockdir\fR option. This directory is by default \fI/usr/local/samba/var/locks -\fR\&. +\fR. .TP \fB$LOCKDIR/winbindd_cache.tdb\fR Storage for cached user and group information. @@ -387,8 +296,8 @@ the Samba suite. .SH "SEE ALSO" .PP \fInsswitch.conf(5)\fR, -samba(7), -wbinfo(1), +samba(7) +wbinfo(1) smb.conf(5) .SH "AUTHOR" .PP |