diff options
Diffstat (limited to 'docs/manpages')
29 files changed, 1732 insertions, 2090 deletions
diff --git a/docs/manpages/findsmb.1 b/docs/manpages/findsmb.1 index 733537fad8..22362f8b6d 100644 --- a/docs/manpages/findsmb.1 +++ b/docs/manpages/findsmb.1 @@ -3,8 +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" "07 april 2003" "" "" - +.TH "FINDSMB" "1" "04 March 2003" "" "" .SH NAME findsmb \- list info about machines that respond to SMB name queries on a subnet .SH SYNOPSIS @@ -13,15 +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 \fBSamba\fR(7) -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 \fBnmblookup\fR(1) -and \fBsmbclient\fR(1) -to obtain this information. +It uses \fB nmblookup(1)\fR to obtain this information. .SH "OPTIONS" .TP \fB-r\fR @@ -29,16 +25,15 @@ Controls whether \fBfindsmb\fR takes bugs in Windows95 into account when trying to find a Netbios name registered of the remote machine. This option is disabled by default because it is specific to Windows 95 and Windows 95 machines only. -If set, \fBnmblookup\fR(1) +If set, \fBnmblookup\fR will be called with -B option. .TP \fBsubnet broadcast address\fR Without this option, \fBfindsmb \fR will probe the subnet of the machine where -\fBfindsmb\fR(1) -is run. This value is passed to -\fBnmblookup\fR(1) -as part of the -B option. +\fBfindsmb\fR is run. This value is passed +to \fBnmblookup\fR as part of the +-B option. .SH "EXAMPLES" .PP The output of \fBfindsmb\fR lists the following @@ -55,15 +50,15 @@ not show any information about the operating system or server version. .PP The command with -r option -must be run on a system without \fBnmbd\fR(8) running. +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 and with -r option on a machine without \fBnmbd\fR running. .PP -For example, running \fBfindsmb\fR -without -r option set would yield output similar +For example, running \fBfindsmb\fR without +-r option set would yield output similar to the following .nf @@ -79,6 +74,7 @@ IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION 192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0] 192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager] 192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0] + .fi .SH "VERSION" .PP @@ -86,8 +82,9 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBnmbd\fR(8), -\fBsmbclient\fR(1), and \fBnmblookup\fR(1) +\fBnmbd(8)\fR +\fBsmbclient(1) +\fR and \fBnmblookup(1)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -97,7 +94,7 @@ to the way the Linux kernel is developed. .PP 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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook -XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. +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 +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/lmhosts.5 b/docs/manpages/lmhosts.5 index 021d2179d4..82660f26bd 100644 --- a/docs/manpages/lmhosts.5 +++ b/docs/manpages/lmhosts.5 @@ -3,16 +3,15 @@ .\" <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" "07 april 2003" "" "" - +.TH "LMHOSTS" "5" "04 March 2003" "" "" .SH NAME lmhosts \- The Samba NetBIOS hosts file .SH SYNOPSIS .PP -\fIlmhosts\fR is the \fBSamba\fR(7) NetBIOS 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 \fBSamba\fR(7) suite. +This file is part of the Samba suite. .PP \fIlmhosts\fR is the \fBSamba \fR NetBIOS name to IP address mapping file. It @@ -24,7 +23,7 @@ to the NetBIOS naming format. It is an ASCII file containing one line for NetBIOS name. The two fields on each line are separated from each other by white space. Any entry beginning with '#' is ignored. Each line -in the lmhosts file contains the following information: +in the lmhosts file contains the following information : .TP 0.2i \(bu IP Address - in dotted decimal format. @@ -39,7 +38,8 @@ If the trailing '#' is omitted then the given IP address will be returned for all names that match the given name, whatever the NetBIOS name type in the lookup. .PP -An example follows: +An example follows : +.PP .nf # @@ -61,13 +61,16 @@ type for a name "NTSERVER" is queried. Any other name type will not be resolved. .PP The default location of the \fIlmhosts\fR file -is in the same directory as the \fBsmb.conf\fR(5) file. +is in the same directory as the +smb.conf(5)> file. .SH "VERSION" .PP -This man page is correct for version 3.0 of the Samba suite. +This man page is correct for version 2.2 of +the Samba suite. .SH "SEE ALSO" .PP -\fBsmbclient\fR(1), \fBsmb.conf\fR(5), and \fBsmbpasswd\fR(8) +\fBsmbclient(1) +\fR and \fB smbpasswd(8)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -80,5 +83,4 @@ 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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook -XML 4.2 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/net.8 b/docs/manpages/net.8 index e80a5d730b..9b25d30c4f 100644 --- a/docs/manpages/net.8 +++ b/docs/manpages/net.8 @@ -3,8 +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 "NET" "8" "07 april 2003" "" "" - +.TH "NET" "8" "04 March 2003" "" "" .SH NAME net \- Tool for administration of Samba and remote CIFS servers. .SH SYNOPSIS @@ -13,7 +12,7 @@ net \- Tool for administration of Samba and remote CIFS servers. .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP The samba net utility is meant to work just like the net utility available for windows and DOS. @@ -23,8 +22,7 @@ available for windows and DOS. Display summary of all available options. .TP \fB-w target-workgroup\fR -Sets target workgroup or domain. You have to specify -either this option or the IP address or the name of a server. +Sets target workgroup or domain. You have to specify either this option or the IP address or the name of a server. .TP \fB-W workgroup\fR Sets client workgroup or domain @@ -33,8 +31,7 @@ Sets client workgroup or domain User name to use .TP \fB-I ip-address\fR -IP address of target server to use. You have to -specify either this option or a target workgroup or a target server. +IP address of target server to use. You have to specify either this option or a target workgroup or a target server. .TP \fB-p port\fR Port on the target server to connect to. @@ -46,8 +43,7 @@ Sets name of the client. Specify alternative configuration file that should be loaded. .TP \fB-S server\fR -Name of target server. You should specify either -this option or a target workgroup or a target IP address. +Name of target server. You should specify either this option or a target workgroup or a target IP address. .TP \fB-C comment\fR FIXME @@ -91,11 +87,11 @@ Without any options, the \fBNET TIME\fR command displays the time on the remote server. .TP \fBSYSTEM\fR -Displays the time on the remote server in a format ready for \fB/bin/date\fR +Displays the time on the remote server in a format ready for /bin/date .TP \fBSET\fR Tries to set the date and time of the local server to that on -the remote server using \fB/bin/date\fR. +the remote server using /bin/date. .TP \fBZONE\fR Displays the timezone in hours from GMT on the remote computer. @@ -120,7 +116,7 @@ delete specified user \fBUSER INFO <name> [misc options]\fR list the domain groups of the specified user .TP -\fBUSER ADD <name> [password] [-F user flags] [misc. options]\fR +\fBUSER ADD <name> [password] [-F user flags] [misc. options\fR Add specified user .TP \fBGROUP [misc options] [targets]\fR diff --git a/docs/manpages/nmbd.8 b/docs/manpages/nmbd.8 index bd3eb9155c..44a39c1730 100644 --- a/docs/manpages/nmbd.8 +++ b/docs/manpages/nmbd.8 @@ -3,8 +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 "NMBD" "8" "07 april 2003" "" "" - +.TH "NMBD" "8" "04 March 2003" "" "" .SH NAME nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients .SH SYNOPSIS @@ -13,7 +12,7 @@ nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clien .SH "DESCRIPTION" .PP -This program is part of the \fBSamba\fR(7) suite. +This program is part of the Samba suite. .PP \fBnmbd\fR is a server that understands and can reply to NetBIOS over IP name service requests, like @@ -35,7 +34,7 @@ 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 \fBsmb.conf\fR(5) configuration 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 @@ -75,25 +74,36 @@ If specified, this parameter causes \fBnmbd\fR to log to standard output rather than a file. .TP +\fB-a\fR +If this parameter is specified, each new +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 daemon mode when run from the command line. \fBnmbd\fR also logs to standard -output, as if the -S parameter had been +output, as if the \fB-S\fR parameter had been given. .TP -\fB-h|--help\fR -Print a summary of command line options. +\fB-o\fR +If this parameter is specified, the +log files will be overwritten when opened. By default, +\fBsmbd\fR will append entries to the log +files. +.TP +\fB-h\fR +Prints the help information (usage) +for \fBnmbd\fR. .TP \fB-H <filename>\fR 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 \fIname resolve -order\fR described in \fBsmb.conf\fR(5) to resolve any -NetBIOS name queries needed by the server. Note +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. Adding a line to this file affects name NetBIOS resolution @@ -103,48 +113,53 @@ 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/samba/lmhosts\fR. See the \fBlmhosts\fR(5) man 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 -\fBsmbd\fR. +\fBnmbd\fR. .TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer +\fB-d <debug level>\fR +debuglevel is an integer 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 log files about the activities of the +The higher this value, the more detail will +be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out. -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. +Levels above 1 will generate considerable amounts +of log data, and should only be used when investigating +a problem. Levels above 3 are designed for use only by developers +and generate HUGE amounts of log data, most of which is extremely +cryptic. -Note that specifying this parameter here will -override the log -level file. +Note that specifying this parameter here will override +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 +If the directory specified does not exist, \fBnmbd\fR +will log to the default debug log location defined at compile time. .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. +\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 name parameter in the +\fIsmb.conf\fR file. However, a command +line setting will take precedence over settings in +\fIsmb.conf\fR. .TP \fB-p <UDP port number>\fR UDP port number is a positive integer value. @@ -152,13 +167,21 @@ This option changes the default UDP port number (normally 137) that \fBnmbd\fR responds to name queries on. Don't use this option unless you are an expert, in which case you 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 +this may be changed when Samba is autoconfigured. + +The file specified contains the configuration details +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 install document +meta-daemon. See the UNIX_INSTALL.html document for details. .TP \fB\fI/etc/rc\fB\fR @@ -167,7 +190,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 "How to Install and Test SAMBA" document +sequence for the server. See the UNIX_INSTALL.html document for details. .TP \fB\fI/etc/services\fB\fR @@ -175,26 +198,27 @@ If running the server via the meta-daemon \fBinetd\fR, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). -See the "How to Install and Test SAMBA" +See the UNIX_INSTALL.html document for details. .TP \fB\fI/usr/local/samba/lib/smb.conf\fB\fR -This is the default location of -the \fBsmb.conf\fR(5) server -configuration file. Other common places that systems +This is the default location of the +\fIsmb.conf\fR +server configuration file. Other common places that systems install this file are \fI/usr/samba/lib/smb.conf\fR -and \fI/etc/samba/smb.conf\fR. +and \fI/etc/smb.conf\fR. When run as a WINS server (see the wins support -parameter in the \fBsmb.conf\fR(5) man page), +parameter in the \fIsmb.conf(5)\fR man page), \fBnmbd\fR 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 -parameter in the \fBsmb.conf\fR(5) man page, \fBnmbd\fR +parameter in the \fIsmb.conf(5)\fR man page, +\fBnmbd\fR will store the browsing database in the file \fIbrowse.dat \fR in the \fIvar/locks\fR directory configured under wherever Samba was configured to install itself. @@ -214,10 +238,10 @@ under wherever Samba was configured to install itself). This will also cause \fBnmbd\fR to dump out its server database in the \fIlog.nmb\fR file. .PP -The debug log level of nmbd may be raised or lowered -using \fBsmbcontrol\fR(1) (SIGUSR[1|2] signals -are no longer used since Samba 2.2). This is to allow -transient problems to be diagnosed, whilst still running +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 +to allow transient problems to be diagnosed, whilst still running at a normally low log level. .SH "VERSION" .PP @@ -225,8 +249,11 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBinetd\fR(8), \fBsmbd\fR(8), \fBsmb.conf\fR(5), \fBsmbclient\fR(1), \fBtestparm\fR(1), \fBtestprns\fR(1), and the Internet -RFC's \fIrfc1001.txt\fR, \fIrfc1002.txt\fR. +\fBinetd(8)\fR, \fBsmbd(8)\fR +\fIsmb.conf(5)\fR + \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 http://samba.org/cifs/ <URL:http://samba.org/cifs/>. @@ -239,7 +266,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook -XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/nmblookup.1 b/docs/manpages/nmblookup.1 index d57ec24fa3..06e608a62e 100644 --- a/docs/manpages/nmblookup.1 +++ b/docs/manpages/nmblookup.1 @@ -3,8 +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 "NMBLOOKUP" "1" "07 april 2003" "" "" - +.TH "NMBLOOKUP" "1" "04 March 2003" "" "" .SH NAME nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS names .SH SYNOPSIS @@ -13,7 +12,7 @@ nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS names .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +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 @@ -34,7 +33,7 @@ to do a recursive lookup. This is used when sending a name query to a machine running a WINS server and the user wishes to query the names in the WINS server. If this bit is unset the normal (broadcast responding) NetBIOS processing code -on a machine is used instead. See RFC1001, RFC1002 for details. +on a machine is used instead. See rfc1001, rfc1002 for details. .TP \fB-S\fR Once the name query has returned an IP @@ -47,51 +46,22 @@ 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 \fBnmbd\fR(8) daemon is running on this machine it also binds to this port. +in addition, if the nmbd(8) +daemon is running on this machine it also binds to this port. .TP \fB-A\fR Interpret \fIname\fR as an IP Address and do a node status query on this address. .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 \fINetBIOS -name\fR parameter in the \fBsmb.conf\fR(5) file. However, a command -line setting will take precedence over settings in -\fBsmb.conf\fR(5). -.TP -\fB-i <scope>\fR -This specifies a NetBIOS scope that -\fBnmblookup\fR will use to communicate with when -generating NetBIOS names. For details on the use of NetBIOS -scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are -\fBvery\fR rarely used, only set this parameter -if you are the system administrator in charge of all the -NetBIOS systems you communicate with. -.TP -\fB-W|--workgroup=domain\fR -Set the SMB domain of the username. This -overrides the default domain which is the domain defined in -smb.conf. If the domain specified is the same as the servers -NetBIOS name, it causes the client to log on using the servers local -SAM (as opposed to the Domain SAM). -.TP -\fB-O socket options\fR -TCP socket options to set on the client -socket. See the socket options parameter in -the \fBsmb.conf\fR(5) manual page for the list of valid -options. -.TP -\fB-h|--help\fR -Print a summary of command line options. +\fB-h\fR +Print a help (usage) message. .TP \fB-B <broadcast address>\fR 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 \fBsmb.conf\fR(5) file. + parameter of the \fIsmb.conf (5)\fR file. .TP \fB-U <unicast address>\fR Do a unicast query to the specified address or @@ -99,46 +69,37 @@ host \fIunicast address\fR. This option (along with the \fI-R\fR option) is needed to query a WINS server. .TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer -from 0 to 10. The default value if this parameter is -not specified is zero. +\fB-d <debuglevel>\fR +debuglevel is an integer from 0 to 10. -The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day to day running - it generates a small amount of -information about operations carried out. +The default value if this parameter is not specified +is zero. -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. +The higher this value, the more detail will be logged +about the activities of \fBnmblookup\fR. At level +0, only critical errors and serious warnings will be logged. -Note that specifying this parameter here will -override the log -level file. +Levels above 1 will generate considerable amounts of +log data, and should only be used when investigating a problem. +Levels above 3 are designed for use only by developers and +generate HUGE amounts of data, most of which is extremely cryptic. + +Note that specifying this parameter here will override +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 setup on the machine. .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. +\fB-i <scope>\fR +This specifies a NetBIOS scope that +\fBnmblookup\fR will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +\fBvery\fR rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with. .TP \fB-T\fR This causes any IP addresses found in the @@ -165,8 +126,8 @@ area. .PP \fBnmblookup\fR can be used to query a WINS server (in the same way \fBnslookup\fR is -used to query DNS servers). To query a WINS server, \fBnmblookup\fR -must be called like this: +used to query DNS servers). To query a WINS server, +\fBnmblookup\fR must be called like this: .PP \fBnmblookup -U server -R 'name'\fR .PP @@ -182,7 +143,8 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBnmbd\fR(8), \fBsamba\fR(7), and \fBsmb.conf\fR(5). +\fBnmbd(8)\fR +samba(7) and smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -192,7 +154,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook -XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/pdbedit.8 b/docs/manpages/pdbedit.8 index b0731cdffd..82765d6dad 100644 --- a/docs/manpages/pdbedit.8 +++ b/docs/manpages/pdbedit.8 @@ -3,17 +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 "PDBEDIT" "8" "07 april 2003" "" "" - +.TH "PDBEDIT" "8" "30 March 2003" "" "" .SH NAME pdbedit \- manage the SAM database .SH SYNOPSIS -\fBpdbedit\fR [ \fB-l\fR ] [ \fB-v\fR ] [ \fB-w\fR ] [ \fB-u username\fR ] [ \fB-f fullname\fR ] [ \fB-h homedir\fR ] [ \fB-D drive\fR ] [ \fB-S script\fR ] [ \fB-p profile\fR ] [ \fB-a\fR ] [ \fB-m\fR ] [ \fB-x\fR ] [ \fB-i passdb-backend\fR ] [ \fB-e passdb-backend\fR ] [ \fB-g\fR ] [ \fB-b passdb-backend\fR ] [ \fB-g\fR ] [ \fB-d debuglevel\fR ] [ \fB-s configfile\fR ] [ \fB-P account-policy\fR ] [ \fB-C value\fR ] +\fBpdbedit\fR [ \fB-l\fR ] [ \fB-v\fR ] [ \fB-w\fR ] [ \fB-u username\fR ] [ \fB-f fullname\fR ] [ \fB-h homedir\fR ] [ \fB-D drive\fR ] [ \fB-S script\fR ] [ \fB-p profile\fR ] [ \fB-a\fR ] [ \fB-m\fR ] [ \fB-x\fR ] [ \fB-i passdb-backend\fR ] [ \fB-e passdb-backend\fR ] [ \fB-g\fR ] [ \fB-b passdb-backend\fR ] [ \fB-d debuglevel\fR ] [ \fB-s configfile\fR ] [ \fB-P account-policy\fR ] [ \fB-V value\fR ] .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +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 only be run by root. @@ -38,8 +37,9 @@ Example: \fBpdbedit -l\fR .nf -sorce:500:Simo Sorce -samba:45:Test User + sorce:500:Simo Sorce + samba:45:Test User + .fi .TP \fB-v\fR @@ -51,38 +51,40 @@ Example: \fBpdbedit -l -v\fR .nf ---------------- -username: sorce -user ID/Group: 500/500 -user RID/GRID: 2000/2001 -Full Name: Simo Sorce -Home Directory: \\\\BERSERKER\\sorce -HomeDir Drive: H: -Logon Script: \\\\BERSERKER\\netlogon\\sorce.bat -Profile Path: \\\\BERSERKER\\profile ---------------- -username: samba -user ID/Group: 45/45 -user RID/GRID: 1090/1091 -Full Name: Test User -Home Directory: \\\\BERSERKER\\samba -HomeDir Drive: -Logon Script: -Profile Path: \\\\BERSERKER\\profile + --------------- + username: sorce + user ID/Group: 500/500 + user RID/GRID: 2000/2001 + Full Name: Simo Sorce + Home Directory: \\\\BERSERKER\\sorce + HomeDir Drive: H: + Logon Script: \\\\BERSERKER\\netlogon\\sorce.bat + Profile Path: \\\\BERSERKER\\profile + --------------- + username: samba + user ID/Group: 45/45 + user RID/GRID: 1090/1091 + Full Name: Test User + Home Directory: \\\\BERSERKER\\samba + HomeDir Drive: + Logon Script: + Profile Path: \\\\BERSERKER\\profile + .fi .TP \fB-w\fR This option sets the "smbpasswd" listing format. It will make pdbedit list the users in the database, printing out the account fields in a format compatible with the -\fIsmbpasswd\fR file format. (see the -\fBsmbpasswd\fR(5) for details) +\fIsmbpasswd\fR file format. (see the \fIsmbpasswd(5)\fR for details) Example: \fBpdbedit -l -w\fR + .nf -sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX ]:LCT-00000000: -samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX ]:LCT-3BFA1E8D: + sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX ]:LCT-00000000: + samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX ]:LCT-3BFA1E8D: + .fi .TP \fB-u username\fR @@ -137,7 +139,7 @@ Example: \fBpdbedit -a -u sorce\fR .nf new password: -retype new password + retype new password .fi .TP \fB-m\fR @@ -183,14 +185,6 @@ applies to the group mapping instead of the user database. This option will ease migration from one passdb backend to another and will ease backing up. .TP -\fB-g\fR -If you specify \fI-g\fR, -then \fI-i in-backend -e out-backend\fR -applies to the group mapping instead of the user database. - -This option will ease migration from one passdb backend to -another and will ease backing up. -.TP \fB-b passdb-backend\fR Use a different default passdb backend. @@ -207,39 +201,24 @@ Example: \fBpdbedit -P "bad lockout attempt"\fR .nf -account policy value for bad lockout attempt is 0 + account policy value for bad lockout attempt is 0 + .fi .TP -\fB-C account-policy-value\fR +\fB-V account-policy-value\fR Sets an account policy to a specified value. This option may only be used in conjunction with the \fI-P\fR option. -Example: \fBpdbedit -P "bad lockout attempt" -C 3\fR +Example: \fBpdbedit -P "bad lockout attempt" -V 3\fR .nf -account policy value for bad lockout attempt was 0 -account policy value for bad lockout attempt is now 3 + account policy value for bad lockout attempt was 0 + account policy value for bad lockout attempt is now 3 + .fi .TP -\fB-h|--help\fR -Print a summary of command line options. -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP \fB-d|--debug=debuglevel\fR \fIdebuglevel\fR is an integer from 0 to 10. The default value if this parameter is @@ -262,10 +241,18 @@ Note that specifying this parameter here will override the log level file. .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. +\fB-h|--help\fR +Print a summary of command line options. +.TP +\fB-s <configuration file>\fR +The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See \fIsmb.conf(5)\fR for more information. +The default configuration file name is determined at +compile time. .SH "NOTES" .PP This command may be used only by root. @@ -275,7 +262,8 @@ This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbpasswd\fR(5), \fBsamba\fR(7) +smbpasswd(8) +samba(7) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -285,7 +273,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook -XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/rpcclient.1 b/docs/manpages/rpcclient.1 index 92b80e02cb..dcba30100b 100644 --- a/docs/manpages/rpcclient.1 +++ b/docs/manpages/rpcclient.1 @@ -3,8 +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 "RPCCLIENT" "1" "07 april 2003" "" "" - +.TH "RPCCLIENT" "1" "04 March 2003" "" "" .SH NAME rpcclient \- tool for executing client side MS-RPC functions .SH SYNOPSIS @@ -13,7 +12,7 @@ rpcclient \- tool for executing client side MS-RPC functions .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +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 @@ -25,41 +24,28 @@ their UNIX workstation. \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\fR line from \fBsmb.conf\fR(5). -.TP -\fB-c|--command='command string'\fR -execute semicolon separated commands (listed -below)) +resolved using the \fIname resolve order\fR line from +\fIsmb.conf(5)\fR. .TP -\fB-I IP-address\fR -\fIIP address\fR is the address of the server to connect to. -It should be specified in standard "a.b.c.d" notation. +\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 -Normally the client would attempt to locate a named -SMB/CIFS server by looking it up via the NetBIOS name resolution -mechanism described above in the \fIname resolve order\fR -parameter above. Using this parameter will force the client -to assume that the server is on the machine with the specified IP -address and the NetBIOS name component of the resource being -connected to will be ignored. -There is no default for this parameter. If not supplied, -it will be determined automatically by the client as described -above. -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. +.nf + username = <value> + password = <value> + domain = <value> + +.fi + +Make certain that the permissions on the file restrict +access from unwanted users. .TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. +\fB-c|--command='command string'\fR +execute semicolon separated commands (listed +below)) .TP \fB-d|--debug=debuglevel\fR \fIdebuglevel\fR is an integer @@ -83,238 +69,120 @@ Note that specifying this parameter here will override the log level file. .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. +\fB-h|--help\fR +Print a summary of command line options. .TP -\fB-N\fR -If specified, this parameter suppresses the normal -password prompt from the client to the user. This is useful when -accessing a service that does not require a password. +\fB-I IP-address\fR +\fIIP address\fR is the address of the server to connect to. +It should be specified in standard "a.b.c.d" notation. + +Normally the client would attempt to locate a named +SMB/CIFS server by looking it up via the NetBIOS name resolution +mechanism described above in the \fIname resolve order\fR +parameter above. Using this parameter will force the client +to assume that the server is on the machine with the specified IP +address and the NetBIOS name component of the resource being +connected to will be ignored. -Unless a password is specified on the command line or -this parameter is specified, the client will request a -password. +There is no default for this parameter. If not supplied, +it will be determined automatically by the client as described +above. .TP -\fB-k\fR -Try to authenticate with kerberos. Only useful in -an Active Directory environment. +\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. .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 - - -.nf -username = <value> -password = <value> -domain = <value> -.fi - -Make certain that the permissions on the file restrict -access from unwanted users. +\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. +.TP +\fB-s|--conf=smb.conf\fR +Specifies the location of the all-important +\fIsmb.conf\fR file. .TP \fB-U|--user=username[%password]\fR Sets the SMB username or username and password. -If %password is not specified, the user will be prompted. The -client will first check the \fBUSER\fR environment variable, then the -\fBLOGNAME\fR variable and if either exists, the -string is uppercased. If these environmental variables are not +If %password is not specified, the user will be prompted. The +client will first check the \fBUSER\fR environment variable, then the +\fBLOGNAME\fR variable and if either exists, the +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 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 +A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the \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 -\fBrpcclient\fR to prompt for a password and type +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 +\fBrpcclient\fR to prompt for a password and type it in directly. .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 \fINetBIOS -name\fR parameter in the \fBsmb.conf\fR(5) file. However, a command -line setting will take precedence over settings in -\fBsmb.conf\fR(5). -.TP -\fB-i <scope>\fR -This specifies a NetBIOS scope that -\fBnmblookup\fR will use to communicate with when -generating NetBIOS names. For details on the use of NetBIOS -scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are -\fBvery\fR rarely used, only set this parameter -if you are the system administrator in charge of all the -NetBIOS systems you communicate with. -.TP \fB-W|--workgroup=domain\fR -Set the SMB domain of the username. This -overrides the default domain which is the domain defined in -smb.conf. If the domain specified is the same as the servers -NetBIOS name, it causes the client to log on using the servers local -SAM (as opposed to the Domain SAM). -.TP -\fB-O socket options\fR -TCP socket options to set on the client -socket. See the socket options parameter in -the \fBsmb.conf\fR(5) manual page for the list of valid -options. -.TP -\fB-h|--help\fR -Print a summary of command line options. +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 +opposed to the Domain SAM). .SH "COMMANDS" -.SS "LSARPC" -.TP +.PP +\fBLSARPC\fR +.TP 0.2i +\(bu \fBlsaquery\fR -Query info policy -.TP -\fBlookupsids\fR -Resolve a list +.TP 0.2i +\(bu +\fBlookupsids\fR - Resolve a list of SIDs to usernames. -.TP -\fBlookupnames\fR -Resolve a list +.TP 0.2i +\(bu +\fBlookupnames\fR - Resolve a list of usernames to SIDs. -.TP +.TP 0.2i +\(bu \fBenumtrusts\fR -Enumerate trusted domains -.TP -\fBenumprivs\fR -Enumerate privileges -.TP -\fBgetdispname\fR -Get the privilege name -.TP -\fBlsaenumsid\fR -Enumerate the LSA SIDS -.TP -\fBlsaenumprivsaccount\fR -Enumerate the privileges of an SID -.TP -\fBlsaenumacctrights\fR -Enumerate the rights of an SID -.TP -\fBlsaenumacctwithright\fR -Enumerate accounts with a right -.TP -\fBlsaaddacctrights\fR -Add rights to an account -.TP -\fBlsaremoveacctrights\fR -Remove rights from an account -.TP -\fBlsalookupprivvalue\fR -Get a privilege value given its name -.TP -\fBlsaquerysecobj\fR -Query LSA security object -.SS "LSARPC-DS" -.TP -\fBdsroledominfo\fR -Get Primary Domain Information .PP .PP -\fBDFS\fR -.TP -\fBdfsexist\fR -Query DFS support -.TP -\fBdfsadd\fR -Add a DFS share -.TP -\fBdfsremove\fR -Remove a DFS share -.TP -\fBdfsgetinfo\fR -Query DFS share info -.TP -\fBdfsenum\fR -Enumerate dfs shares -.SS "REG" -.TP -\fBshutdown\fR -Remote Shutdown -.TP -\fBabortshutdown\fR -Abort Shutdown -.SS "SRVSVC" -.TP -\fBsrvinfo\fR -Server query info -.TP -\fBnetshareenum\fR -Enumerate shares -.TP -\fBnetfileenum\fR -Enumerate open files -.TP -\fBnetremotetod\fR -Fetch remote time of day -.SS "SAMR" -.TP +\fBSAMR\fR +.TP 0.2i +\(bu \fBqueryuser\fR -Query user info -.TP +.TP 0.2i +\(bu \fBquerygroup\fR -Query group info -.TP +.TP 0.2i +\(bu \fBqueryusergroups\fR -Query user groups -.TP +.TP 0.2i +\(bu \fBquerygroupmem\fR -Query group membership -.TP +.TP 0.2i +\(bu \fBqueryaliasmem\fR -Query alias membership -.TP +.TP 0.2i +\(bu \fBquerydispinfo\fR -Query display info -.TP +.TP 0.2i +\(bu \fBquerydominfo\fR -Query domain info -.TP -\fBenumdomusers\fR -Enumerate domain users -.TP +.TP 0.2i +\(bu \fBenumdomgroups\fR -Enumerate domain groups -.TP -\fBenumalsgroups\fR -Enumerate alias groups -.TP -\fBcreatedomuser\fR -Create domain user -.TP -\fBsamlookupnames\fR -Look up names -.TP -\fBsamlookuprids\fR -Look up names -.TP -\fBdeletedomuser\fR -Delete domain user -.TP -\fBsamquerysecobj\fR -Query SAMR security object -.TP -\fBgetdompwinfo\fR -Retrieve domain password info -.TP -\fBlookupdomain\fR -Look up domain -.SS "SPOOLSS" -.TP -\fBadddriver <arch> <config>\fR -Execute an AddPrinterDriver() RPC to install the printer driver +.PP +.PP +\fBSPOOLSS\fR +.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 @@ -325,14 +193,15 @@ follows: .nf -Long Printer Name:\\ -Driver File Name:\\ -Data File Name:\\ -Config File Name:\\ -Help File Name:\\ -Language Monitor Name:\\ -Default Data Type:\\ -Comma Separated list of Files + Long Printer Name:\\ + Driver File Name:\\ + Data File Name:\\ + Config File Name:\\ + Help File Name:\\ + Language Monitor Name:\\ + Default Data Type:\\ + Comma Separated list of Files + .fi Any empty fields should be enter as the string "NULL". @@ -343,149 +212,111 @@ 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 -\fBaddprinter <printername> <sharename> <drivername> <port>\fR -Add a printer on the remote server. This printer +.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 must already be installed on the server (see \fBadddriver\fR) and the \fIport\fRmust be a valid port name (see \fBenumports\fR. -.TP -\fBdeldriver\fR -Delete the +.TP 0.2i +\(bu +\fBdeldriver\fR - Delete the specified printer driver for all architectures. This does not delete the actual driver files from the server, only the entry from the server's list of drivers. -.TP -\fBenumdata\fR -Enumerate all +.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 to the MS Platform SDK GetPrinterData() function (* This command is currently unimplemented). -.TP -\fBenumdataex\fR -Enumerate printer data for a key -.TP -\fBenumjobs <printer>\fR -List the jobs and status of a given printer. +.TP 0.2i +\(bu +\fBenumjobs <printer>\fR +- List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() -function -.TP -\fBenumkey\fR -Enumerate printer keys -.TP -\fBenumports [level]\fR -Executes an EnumPorts() call using the specified +function (* This command is currently unimplemented). +.TP 0.2i +\(bu +\fBenumports [level]\fR +- Executes an EnumPorts() call using the specified info level. Currently only info levels 1 and 2 are supported. -.TP -\fBenumdrivers [level]\fR -Execute an EnumPrinterDrivers() call. This lists the various installed +.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 documentation for more details of the various flags and calling options. Currently supported info levels are 1, 2, and 3. -.TP -\fBenumprinters [level]\fR -Execute an EnumPrinters() call. This lists the various installed +.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 more details of the various flags and calling options. Currently supported info levels are 0, 1, and 2. -.TP -\fBgetdata <printername> <valuename;>\fR -Retrieve the data for a given printer setting. See +.TP 0.2i +\(bu +\fBgetdata <printername>\fR +- 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. -.TP -\fBgetdataex\fR -Get printer driver data with keyname -.TP -\fBgetdriver <printername>\fR -Retrieve the printer driver information (such as driver file, +SDK function (* This command is currently unimplemented). +.TP 0.2i +\(bu +\fBgetdriver <printername>\fR +- 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. -.TP -\fBgetdriverdir <arch>\fR -Execute a GetPrinterDriverDirectory() +.TP 0.2i +\(bu +\fBgetdriverdir <arch>\fR +- Execute a GetPrinterDriverDirectory() 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 -\fBgetprinter <printername>\fR -Retrieve the current printer information. This command +.TP 0.2i +\(bu +\fBgetprinter <printername>\fR +- Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function. -.TP -\fBgetprintprocdir\fR -Get print processor directory -.TP -\fBopenprinter <printername>\fR -Execute an OpenPrinterEx() and ClosePrinter() RPC +.TP 0.2i +\(bu +\fBopenprinter <printername>\fR +- Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer. -.TP -\fBsetdriver <printername> <drivername>\fR -Execute a SetPrinter() command to update the printer driver +.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. See also the \fBenumprinters\fR and \fBenumdrivers\fR commands for obtaining a list of of installed printers and drivers. -.TP -\fBaddform\fR -Add form -.TP -\fBsetform\fR -Set form -.TP -\fBgetform\fR -Get form -.TP -\fBdeleteform\fR -Delete form -.TP -\fBenumforms\fR -Enumerate form -.TP -\fBsetprinter\fR -Set printer comment -.TP -\fBsetprinterdata\fR -Set REG_SZ printer data -.TP -\fBrffpcnex\fR -Rffpcnex test -.SS "NETLOGON" -.TP -\fBlogonctrl2\fR -Logon Control 2 -.TP -\fBlogonctrl\fR -Logon Control -.TP -\fBsamsync\fR -Sam Synchronisation -.TP -\fBsamdeltas\fR -Query Sam Deltas -.TP -\fBsamlogon\fR -Sam Logon -.SS "GENERAL COMMANDS" -.TP -\fBdebuglevel\fR -Set the current +.PP +\fBGENERAL OPTIONS\fR +.TP 0.2i +\(bu +\fBdebuglevel\fR - Set the current debug level used to log information. -.TP -\fBhelp (?)\fR -Print a listing of all +.TP 0.2i +\(bu +\fBhelp (?)\fR - Print a listing of all known commands or extended help on a particular command. -.TP -\fBquit (exit)\fR -Exit \fBrpcclient +.TP 0.2i +\(bu +\fBquit (exit)\fR - Exit \fBrpcclient \fR. .SH "BUGS" .PP @@ -496,7 +327,7 @@ parameters where passed to the interpreter. .PP From Luke Leighton's original rpcclient man page: .PP -\fBWARNING!\fR The MSRPC over SMB code has +\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 @@ -504,11 +335,12 @@ 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\fR(8) and \fBrpcclient\fR(1) that are incompatible for some commands or services. Additionally, +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. +result in incompatibilities." .SH "VERSION" .PP This man page is correct for version 3.0 of the Samba @@ -523,5 +355,4 @@ to the way the Linux kernel is developed. The original rpcclient man page was written by Matthew Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. The conversion to DocBook for Samba 2.2 was done by Gerald -Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was -done by Alexander Bokovoy. +Carter. diff --git a/docs/manpages/samba.7 b/docs/manpages/samba.7 index e1ae7d77bf..0a64a78718 100644 --- a/docs/manpages/samba.7 +++ b/docs/manpages/samba.7 @@ -3,10 +3,9 @@ .\" <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" "07 april 2003" "" "" - +.TH "SAMBA" "7" "04 March 2003" "" "" .SH NAME -Samba \- A Windows SMB/CIFS fileserver for UNIX +SAMBA \- A Windows SMB/CIFS fileserver for UNIX .SH SYNOPSIS \fBSamba\fR @@ -20,19 +19,20 @@ 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(8)\fR -The \fBsmbd\fR daemon provides the file and print services to +\fBsmbd\fR +The \fBsmbd \fR +daemon provides the file and print services to SMB clients, such as Windows 95/98, Windows NT, Windows for Workgroups or LanManager. The configuration file -for this daemon is described in \fBsmb.conf\fR(5) +for this daemon is described in \fIsmb.conf\fR .TP -\fBnmbd(8)\fR +\fBnmbd\fR The \fBnmbd\fR daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon -is described in \fBsmb.conf\fR(5) +is described in \fIsmb.conf\fR .TP -\fBsmbclient(1)\fR +\fBsmbclient\fR The \fBsmbclient\fR program implements a simple ftp-like client. This is useful for accessing SMB shares on other compatible @@ -40,33 +40,33 @@ servers (such as Windows NT), and can also be used to allow a UNIX box to print to a printer attached to any SMB server (such as a PC running Windows NT). .TP -\fBtestparm(1)\fR +\fBtestparm\fR The \fBtestparm\fR -utility is a simple syntax checker for Samba's \fBsmb.conf\fR(5) configuration file. +utility is a simple syntax checker for Samba's +\fIsmb.conf\fRconfiguration file. .TP -\fBtestprns(1)\fR +\fBtestprns\fR The \fBtestprns\fR utility supports testing printer names defined in your \fIprintcap\fR file used by Samba. .TP -\fBsmbstatus(1)\fR +\fBsmbstatus\fR The \fBsmbstatus\fR tool provides access to information about the current connections to \fBsmbd\fR. .TP -\fBnmblookup(1)\fR +\fBnmblookup\fR The \fBnmblookup\fR tools allows NetBIOS name queries to be made from a UNIX host. .TP -\fBsmbgroupedit(8)\fR -The \fBsmbgroupedit\fR -tool allows for mapping unix groups to NT Builtin, -Domain, or Local groups. Also it allows setting -priviledges for that group, such as saAddUser, etc. +\fBmake_smbcodepage\fR +The \fBmake_smbcodepage\fR +utility provides a means of creating SMB code page +definition files for your \fBsmbd\fR server. .TP -\fBsmbpasswd(8)\fR +\fBsmbpasswd\fR The \fBsmbpasswd\fR command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers. @@ -101,13 +101,13 @@ on the newsgroup comp.protocol.smb <URL:news:comp.protocols.smb> and the Samba list. Details on how to join the mailing list are given in the README file that comes with Samba. .PP -If you have access to a WWW viewer (such as Mozilla -or Konqueror) then you will also find lots of useful information, +If you have access to a WWW viewer (such as Netscape +or Mosaic) then you will also find lots of useful information, including back issues of the Samba mailing list, at http://lists.samba.org <URL:http://lists.samba.org/>. .SH "VERSION" .PP -This man page is correct for version 3.0 of the +This man page is correct for version 2.2 of the Samba suite. .SH "CONTRIBUTIONS" .PP @@ -117,8 +117,8 @@ http://lists.samba.org <URL:http://lists.samba.org/>. .PP 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. +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 @@ -141,7 +141,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML -4.2 for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5 index 70e1731220..02861d492d 100644 --- a/docs/manpages/smb.conf.5 +++ b/docs/manpages/smb.conf.5 @@ -3,18 +3,18 @@ .\" <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 april 2003" "" "" - +.TH "SMB.CONF" "5" "30 March 2003" "" "" .SH NAME smb.conf \- The configuration file for the Samba suite .SH "SYNOPSIS" .PP -The \fIsmb.conf\fR file is a configuration -file for the Samba suite. \fIsmb.conf\fR contains -runtime configuration information for the Samba programs. The \fIsmb.conf\fR file -is designed to be configured and administered by the \fBswat\fR(8) program. The complete -description of the file format and possible parameters held within -are here for reference purposes. +The \fIsmb.conf\fR file is a configuration +file for the Samba suite. \fIsmb.conf\fR contains +runtime configuration information for the Samba programs. The +\fIsmb.conf\fR file is designed to be configured and +administered by the \fBswat(8)\fR + program. The complete description of the file format and +possible parameters held within are here for reference purposes. .SH "FILE FORMAT" .PP The file consists of sections and parameters. A section @@ -93,9 +93,11 @@ The user has write access to the path \fI/home/bar\fR. The share is accessed via the share name "foo": .nf -[foo] - path = /home/bar - read only = no + [foo] + path = /home/bar + read only = no + + .fi .PP The following sample section defines a printable share. @@ -106,11 +108,13 @@ access will be permitted as the default guest user (specified elsewhere): .nf -[aprinter] - path = /usr/spool/public - read only = yes - printable = yes - guest ok = yes + [aprinter] + path = /usr/spool/public + read only = yes + printable = yes + guest ok = yes + + .fi .SH "SPECIAL SECTIONS" .SS "THE [GLOBAL] SECTION" @@ -168,8 +172,10 @@ than others. The following is a typical and suitable [homes] section: .nf -[homes] - read only = no + [homes] + read only = no + + .fi .PP An important point is that if guest access is specified @@ -229,10 +235,11 @@ it. A typical [printers] entry would look like this: .nf -[printers] - path = /usr/spool/public - guest ok = yes - printable = yes + [printers] + path = /usr/spool/public + guest ok = yes + printable = yes + .fi .PP All aliases given for a printer in the printcap file @@ -242,7 +249,9 @@ to set up a pseudo-printcap. This is a file consisting of one or more lines like this: .nf -alias|alias|alias|alias... + alias|alias|alias|alias... + + .fi .PP Each alias should be an acceptable printer name for @@ -256,15 +265,12 @@ An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols ('|'). -.sp -.RS -.B "Note:" -On SYSV systems which use lpstat to determine what +.PP +NOTE: On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use "printcap name = lpstat" to automatically obtain a list of printers. See the "printcap name" option for more details. -.RE .SH "PARAMETERS" .PP parameters define the specific attributes of sections. @@ -667,6 +673,9 @@ each parameter for details. Note that some are synonyms. \fIldap delete dn\fR .TP 0.2i \(bu +\fIldap del only sam attr\fR +.TP 0.2i +\(bu \fIldap filter\fR .TP 0.2i \(bu @@ -745,9 +754,6 @@ each parameter for details. Note that some are synonyms. \fImachine password timeout\fR .TP 0.2i \(bu -\fImangle prefix\fR -.TP 0.2i -\(bu \fImangled stack\fR .TP 0.2i \(bu @@ -877,15 +883,15 @@ each parameter for details. Note that some are synonyms. \fIpreload\fR .TP 0.2i \(bu -\fIpreload modules\fR -.TP 0.2i -\(bu \fIprintcap\fR .TP 0.2i \(bu \fIprintcap name\fR .TP 0.2i \(bu +\fIprinter driver file\fR +.TP 0.2i +\(bu \fIprivate dir\fR .TP 0.2i \(bu @@ -925,15 +931,9 @@ each parameter for details. Note that some are synonyms. \fIsecurity\fR .TP 0.2i \(bu -\fIserver schannel\fR -.TP 0.2i -\(bu \fIserver string\fR .TP 0.2i \(bu -\fIset primary group script\fR -.TP 0.2i -\(bu \fIshow add printer wizard\fR .TP 0.2i \(bu @@ -1009,6 +1009,9 @@ each parameter for details. Note that some are synonyms. \fIuse mmap\fR .TP 0.2i \(bu +\fIuse rhosts\fR +.TP 0.2i +\(bu \fIuse sendfile\fR .TP 0.2i \(bu @@ -1310,6 +1313,9 @@ each parameter for details. Note that some are synonyms. \fIpostexec\fR .TP 0.2i \(bu +\fIpostscript\fR +.TP 0.2i +\(bu \fIpreexec\fR .TP 0.2i \(bu @@ -1334,6 +1340,12 @@ each parameter for details. Note that some are synonyms. \fIprinter admin\fR .TP 0.2i \(bu +\fIprinter driver\fR +.TP 0.2i +\(bu +\fIprinter driver location\fR +.TP 0.2i +\(bu \fIprinter name\fR .TP 0.2i \(bu @@ -1439,9 +1451,10 @@ each parameter for details. Note that some are synonyms. \fIwriteable\fR .SH "EXPLANATION OF EACH PARAMETER" .TP -\fB>abort shutdown script (G)\fR +\fBabort shutdown script (G)\fR \fBThis parameter only exists in the HEAD cvs branch\fR -This a full path name to a script called by \fBsmbd\fR(8) that +This a full path name to a script called by +\fBsmbd(8)\fR that should stop a shutdown procedure issued by the \fIshutdown script\fR. This command will be run as user. @@ -1450,7 +1463,7 @@ Default: \fBNone\fR. Example: \fBabort shutdown script = /sbin/shutdown -c\fR .TP -\fB>addprinter command (G)\fR +\fBaddprinter command (G)\fR With the introduction of MS-RPC based printing support for Windows NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon is now also available in the @@ -1464,11 +1477,12 @@ printer command\fR defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the \fIsmb.conf\fR file in order that it can be -shared by \fBsmbd\fR(8). +shared by \fBsmbd(8)\fR + The \fIaddprinter command\fR is automatically invoked with the following parameter (in -order): +order: .RS .TP 0.2i \(bu @@ -1501,10 +1515,6 @@ been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the exists. If the sharename is still invalid, then \fBsmbd \fR will return an ACCESS_DENIED error to the client. -The "add printer command" program can output a single line of text, -which Samba will set as the port the new printer is connected to. -If this line isn't output, Samba won't reload its printer shares. - See also \fI deleteprinter command\fR, \fIprinting\fR, \fIshow add printer wizard\fR @@ -1514,7 +1524,7 @@ Default: \fBnone\fR Example: \fBaddprinter command = /usr/bin/addprinter \fR .TP -\fB>add share command (G)\fR +\fBadd share command (G)\fR Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The \fIadd share command\fR is used to define an @@ -1557,9 +1567,9 @@ Default: \fBnone\fR Example: \fBadd share command = /usr/local/bin/addshare\fR .TP -\fB>add machine script (G)\fR +\fBadd machine script (G)\fR This is the full pathname to a script that will -be run by \fBsmbd\fR(8) when a machine is added +be run by smbd(8) when a machine is added to it's domain using the administrator username and password method. This option is only required when using sam back-ends tied to the @@ -1572,7 +1582,7 @@ Default: \fBadd machine script = <empty string> Example: \fBadd machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u \fR .TP -\fB>ads server (G)\fR +\fBads server (G)\fR If this option is specified, samba does not try to figure out what ads server to use itself, but uses the specified ads server. Either one DNS name or IP @@ -1582,9 +1592,10 @@ Default: \fBads server = \fR Example: \fBads server = 192.168.1.2\fR .TP -\fB>add user script (G)\fR +\fBadd user script (G)\fR This is the full pathname to a script that will -be run \fBAS ROOT\fR by \fBsmbd\fR(8) under special circumstances described below. +be run \fBAS ROOT\fR by smbd(8) + under special circumstances described below. Normally, a Samba server requires that UNIX users are created for all users accessing files on this server. For sites @@ -1593,14 +1604,15 @@ creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users \fBON DEMAND\fR when a user accesses the Samba server. -In order to use this option, \fBsmbd\fR(8) must \fBNOT\fR be set to \fIsecurity = share\fR +In order to use this option, smbd +must \fBNOT\fR be set to \fIsecurity = share\fR and \fIadd user script\fR must be set to a full pathname for a script that will create a UNIX user given one argument of \fI%u\fR, which expands into the UNIX user name to create. When the Windows user attempts to access the Samba server, -at login (session setup in the SMB protocol) time, \fBsmbd\fR(8) contacts the \fIpassword server\fR and +at login (session setup in the SMB protocol) time, smbd contacts the \fIpassword server\fR and attempts to authenticate the given user with the given password. If the authentication succeeds then \fBsmbd\fR attempts to find a UNIX user in the UNIX password database to map the @@ -1624,9 +1636,9 @@ Default: \fBadd user script = <empty string> Example: \fBadd user script = /usr/local/samba/bin/add_user %u\fR .TP -\fB>add group script (G)\fR +\fBadd group script (G)\fR This is the full pathname to a script that will -be run \fBAS ROOT\fR by \fBsmbd\fR(8) when a new group is +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 @@ -1636,7 +1648,7 @@ circumvent unix group name restrictions. In that case the script must print the numeric gid of the created group on stdout. .TP -\fB>admin users (S)\fR +\fBadmin users (S)\fR This is a list of users who will be granted administrative privileges on the share. This means that they will do all file operations as the super-user (root). @@ -1649,21 +1661,22 @@ Default: \fBno admin users\fR Example: \fBadmin users = jason\fR .TP -\fB>add user to group script (G)\fR +\fBadd user to group script (G)\fR Full path to the script that will be called when a user is added to a group using the Windows NT domain administration -tools. It will be run by \fBsmbd\fR(8) \fBAS ROOT\fR. -Any \fI%g\fR will be replaced with the group name and -any \fI%u\fR will be replaced with the user name. +tools. It will be run by smbd(8) +\fBAS ROOT\fR. Any \fI%g\fR will be +replaced with the group name and any \fI%u\fR will +be replaced with the user name. Default: \fBadd user to group script = \fR Example: \fBadd user to group script = /usr/sbin/adduser %u %g\fR .TP -\fB>allow hosts (S)\fR +\fBallow hosts (S)\fR Synonym for \fIhosts allow\fR. .TP -\fB>algorithmic rid base (G)\fR +\fBalgorithmic rid base (G)\fR This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers. @@ -1682,7 +1695,7 @@ Default: \fBalgorithmic rid base = 1000\fR Example: \fBalgorithmic rid base = 100000\fR .TP -\fB>allow trusted domains (G)\fR +\fBallow trusted domains (G)\fR This option only takes effect when the \fIsecurity\fR option is set to server or domain. If it is set to no, then attempts to connect to a resource from @@ -1701,8 +1714,10 @@ can make implementing a security boundary difficult. Default: \fBallow trusted domains = yes\fR .TP -\fB>announce as (G)\fR -This specifies what type of server \fBnmbd\fR(8) will announce itself as, to a network neighborhood browse +\fBannounce as (G)\fR +This specifies what type of server +\fBnmbd\fR +will announce itself as, to a network neighborhood browse list. By default this is set to Windows NT. The valid options are : "NT Server" (which can also be written as "NT"), "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, @@ -1716,7 +1731,7 @@ Default: \fBannounce as = NT Server\fR Example: \fBannounce as = Win95\fR .TP -\fB>announce version (G)\fR +\fBannounce version (G)\fR This specifies the major and minor version numbers that nmbd will use when announcing itself as a server. The default is 4.9. Do not change this parameter unless you have a specific @@ -1726,10 +1741,10 @@ Default: \fBannounce version = 4.9\fR Example: \fBannounce version = 2.0\fR .TP -\fB>auto services (G)\fR +\fBauto services (G)\fR This is a synonym for the \fIpreload\fR. .TP -\fB>auth methods (G)\fR +\fBauth methods (G)\fR This option allows the administrator to chose what authentication methods \fBsmbd\fR will use when authenticating a user. This option defaults to sensible values based on \fI security\fR. @@ -1741,7 +1756,7 @@ Default: \fBauth methods = <empty string>\fR Example: \fBauth methods = guest sam ntdomain\fR .TP -\fB>available (S)\fR +\fBavailable (S)\fR This parameter lets you "turn off" a service. If \fIavailable = no\fR, then \fBALL\fR attempts to connect to the service will fail. Such failures are @@ -1749,10 +1764,12 @@ logged. Default: \fBavailable = yes\fR .TP -\fB>bind interfaces only (G)\fR +\fBbind interfaces only (G)\fR This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests. It -affects file service \fBsmbd\fR(8) and name service \fBnmbd\fR(8) in a slightly different ways. +affects file service smbd(8) and +name service nmbd(8) in slightly +different ways. For name service it causes \fBnmbd\fR to bind to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd @@ -1771,8 +1788,8 @@ send packets that arrive through any interfaces not listed in the does defeat this simple check, however, so it must not be used seriously as a security feature for \fBnmbd\fR. -For file service it causes \fBsmbd\fR(8) to bind only to the interface list -given in the interfaces parameter. This restricts the networks that +For file service it causes smbd(8) +to bind only to the interface list given in the interfaces parameter. This restricts the networks that \fBsmbd\fR will serve to packets coming in those interfaces. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non-broadcast network @@ -1780,7 +1797,9 @@ interfaces as it will not cope with non-permanent interfaces. If \fIbind interfaces only\fR is set then unless the network address \fB127.0.0.1\fR is added -to the \fIinterfaces\fR parameter list \fBsmbpasswd\fR(8) and \fBswat\fR(8) may not work as expected due to the reasons covered below. +to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fR +and \fBswat(8)\fR may +not work as expected due to the reasons covered below. To change a users SMB password, the \fBsmbpasswd\fR by default connects to the \fBlocalhost - 127.0.0.1\fR @@ -1789,8 +1808,8 @@ address as an SMB client to issue the password change request. If network address \fB127.0.0.1\fR is added to the \fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode. \fBsmbpasswd\fR can be forced to use the primary IP interface -of the local host by using its \fBsmbpasswd\fR(8) \fI-r remote machine\fR -parameter, with \fIremote machine\fR set +of the local host by using its \fI-r remote machine\fR + parameter, with \fIremote machine\fR set to the IP name of the primary interface of the local host. The \fBswat\fR status page tries to connect with @@ -1802,9 +1821,8 @@ and \fBnmbd\fR. Default: \fBbind interfaces only = no\fR .TP -\fB>blocking locks (S)\fR -This parameter controls the behavior -of \fBsmbd\fR(8) when given a request by a client +\fBblocking locks (S)\fR +This parameter controls the behavior of smbd(8) when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it. @@ -1820,8 +1838,9 @@ cannot be obtained. Default: \fBblocking locks = yes\fR .TP -\fB>block size (S)\fR -This parameter controls the behavior of \fBsmbd\fR(8) when reporting disk free +\fBblock size (S)\fR +This parameter controls the behavior of +smbd(8) when reporting disk free sizes. By default, this reports a disk block size of 1024 bytes. Changing this parameter may have some effect on the @@ -1833,38 +1852,42 @@ is an experimental option it may be removed in a future release. Changing this option does not change the disk free reporting size, just the block size unit reported to the client. + +Default: \fBblock size = 1024\fR + +Example: \fBblock size = 65536\fR .TP -\fB>browsable (S)\fR +\fBbrowsable (S)\fR See the \fI browseable\fR. .TP -\fB>browse list (G)\fR -This controls whether \fBsmbd\fR(8) will serve a browse list to +\fBbrowse list (G)\fR +This controls whether \fBsmbd(8)\fR will serve a browse list to a client doing a \fBNetServerEnum\fR call. Normally set to yes. You should never need to change this. Default: \fBbrowse list = yes\fR .TP -\fB>browseable (S)\fR +\fBbrowseable (S)\fR This controls whether this share is seen in the list of available shares in a net view and in the browse list. Default: \fBbrowseable = yes\fR .TP -\fB>case sensitive (S)\fR +\fBcase sensitive (S)\fR See the discussion in the section NAME MANGLING. Default: \fBcase sensitive = no\fR .TP -\fB>casesignames (S)\fR +\fBcasesignames (S)\fR Synonym for case sensitive. .TP -\fB>change notify timeout (G)\fR +\fBchange notify timeout (G)\fR This SMB allows a client to tell a server to "watch" a particular directory for any changes and only reply to the SMB request when a change has occurred. Such constant scanning of -a directory is expensive under UNIX, hence an \fBsmbd\fR(8) daemon only performs such a scan +a directory is expensive under UNIX, hence an \fBsmbd(8)\fR daemon only performs such a scan on each requested directory once every \fIchange notify timeout\fR seconds. @@ -1874,7 +1897,7 @@ Example: \fBchange notify timeout = 300\fR Would change the scan time to every 5 minutes. .TP -\fB>change share command (G)\fR +\fBchange share command (G)\fR Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The \fIchange share command\fR is used to define an @@ -1916,7 +1939,7 @@ Default: \fBnone\fR Example: \fBchange share command = /usr/local/bin/addshare\fR .TP -\fB>comment (S)\fR +\fBcomment (S)\fR This is a text field that is seen next to a share when a client does a queries the server, either via the network neighborhood or via \fBnet view\fR to list what shares @@ -1929,7 +1952,7 @@ Default: \fBNo comment string\fR Example: \fBcomment = Fred's Files\fR .TP -\fB>config file (G)\fR +\fBconfig file (G)\fR This allows you to override the config file to use, instead of the default (usually \fIsmb.conf\fR). There is a chicken and egg problem here as this option is set @@ -1949,7 +1972,7 @@ clients). Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m \fR .TP -\fB>copy (S)\fR +\fBcopy (S)\fR This parameter allows you to "clone" service entries. The specified service is simply duplicated under the current service's name. Any parameters specified in the current @@ -1964,7 +1987,7 @@ Default: \fBno value\fR Example: \fBcopy = otherservice\fR .TP -\fB>create mask (S)\fR +\fBcreate mask (S)\fR A synonym for this parameter is \fIcreate mode\fR \&. @@ -2001,10 +2024,10 @@ Default: \fBcreate mask = 0744\fR Example: \fBcreate mask = 0775\fR .TP -\fB>create mode (S)\fR +\fBcreate mode (S)\fR This is a synonym for \fI create mask\fR. .TP -\fB>csc policy (S)\fR +\fBcsc policy (S)\fR This stands for \fBclient-side caching policy\fR, and specifies how clients capable of offline caching will cache the files in the share. The valid values @@ -2021,7 +2044,7 @@ Default: \fBcsc policy = manual\fR Example: \fBcsc policy = programs\fR .TP -\fB>deadtime (G)\fR +\fBdeadtime (G)\fR The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected. The deadtime only takes @@ -2044,7 +2067,7 @@ Default: \fBdeadtime = 0\fR Example: \fBdeadtime = 15\fR .TP -\fB>debug hires timestamp (G)\fR +\fBdebug hires timestamp (G)\fR Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp @@ -2055,7 +2078,7 @@ effect. Default: \fBdebug hires timestamp = no\fR .TP -\fB>debug pid (G)\fR +\fBdebug pid (G)\fR When using only one log file for more then one forked smbdprocess there may be hard to follow which process outputs which message. This boolean parameter is adds the process-id @@ -2066,7 +2089,7 @@ effect. Default: \fBdebug pid = no\fR .TP -\fB>debug timestamp (G)\fR +\fBdebug timestamp (G)\fR Samba debug log messages are timestamped by default. If you are running at a high \fIdebug level\fR these timestamps can be distracting. This boolean parameter allows timestamping @@ -2074,7 +2097,7 @@ to be turned off. Default: \fBdebug timestamp = yes\fR .TP -\fB>debug uid (G)\fR +\fBdebug uid (G)\fR Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers @@ -2085,18 +2108,18 @@ effect. Default: \fBdebug uid = no\fR .TP -\fB>debuglevel (G)\fR +\fBdebuglevel (G)\fR Synonym for \fI log level\fR. .TP -\fB>default (G)\fR +\fBdefault (G)\fR A synonym for \fI default service\fR. .TP -\fB>default case (S)\fR +\fBdefault case (S)\fR See the section on NAME MANGLING. Also note the \fIshort preserve case\fR parameter. Default: \fBdefault case = lower\fR .TP -\fB>default devmode (S)\fR +\fBdefault devmode (S)\fR This parameter is only applicable to printable services. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and @@ -2124,7 +2147,7 @@ see the MSDN documentation <URL:http://msdn.microsoft.com/>. Default: \fBdefault devmode = no\fR .TP -\fB>default service (G)\fR +\fBdefault service (G)\fR This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found. Note that the square brackets are \fBNOT\fR @@ -2154,15 +2177,14 @@ Example: [pub] path = /%S + .fi .TP -\fB>delete group script (G)\fR +\fBdelete group script (G)\fR This is the full pathname to a script that will -be run \fBAS ROOT\fR \fBsmbd\fR(8) when a group is requested to be deleted. -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. +be run \fBAS ROOT\fR by smbd(8) when a group is requested to be deleted. 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. .TP -\fB>deleteprinter command (G)\fR +\fBdeleteprinter command (G)\fR With the introduction of MS-RPC based printer support for Windows NT/2000 clients in Samba 2.2, it is now possible to delete printer at run time by issuing the @@ -2190,7 +2212,7 @@ Default: \fBnone\fR Example: \fBdeleteprinter command = /usr/bin/removeprinter \fR .TP -\fB>delete readonly (S)\fR +\fBdelete readonly (S)\fR This parameter allows readonly files to be deleted. This is not normal DOS semantics, but is allowed by UNIX. @@ -2200,7 +2222,7 @@ permissions, and DOS semantics prevent deletion of a read only file. Default: \fBdelete readonly = no\fR .TP -\fB>delete share command (G)\fR +\fBdelete share command (G)\fR Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The \fIdelete share command\fR is used to define an @@ -2235,10 +2257,10 @@ Default: \fBnone\fR Example: \fBdelete share command = /usr/local/bin/delshare\fR .TP -\fB>delete user script (G)\fR +\fBdelete user script (G)\fR This is the full pathname to a script that will -be run by \fBsmbd\fR(8) when managing users -with remote RPC (NT) tools. +be run by \fBsmbd(8)\fR +when managing user's with remote RPC (NT) tools. This script is called when a remote client removes a user from the server, normally using 'User Manager for Domains' or @@ -2252,18 +2274,19 @@ Default: \fBdelete user script = <empty string> Example: \fBdelete user script = /usr/local/samba/bin/del_user %u\fR .TP -\fB>delete user from group script (G)\fR +\fBdelete user from group script (G)\fR Full path to the script that will be called when a user is removed from a group using the Windows NT domain administration -tools. It will be run by \fBsmbd\fR(8) \fBAS ROOT\fR. -Any \fI%g\fR will be replaced with the group name and -any \fI%u\fR will be replaced with the user name. +tools. It will be run by smbd(8) +\fBAS ROOT\fR. Any \fI%g\fR will be +replaced with the group name and any \fI%u\fR will +be replaced with the user name. Default: \fBdelete user from group script = \fR Example: \fBdelete user from group script = /usr/sbin/deluser %u %g\fR .TP -\fB>delete veto files (S)\fR +\fBdelete veto files (S)\fR This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the \fIveto files\fR @@ -2287,11 +2310,11 @@ files\fR parameter. Default: \fBdelete veto files = no\fR .TP -\fB>deny hosts (S)\fR +\fBdeny hosts (S)\fR Synonym for \fIhosts deny\fR. .TP -\fB>dfree command (G)\fR +\fBdfree command (G)\fR The \fIdfree command\fR setting should only be used on systems where a problem occurs with the internal disk space calculations. This has been known to happen with Ultrix, @@ -2327,8 +2350,9 @@ Where the script dfree (which must be made executable) could be: .nf -#!/bin/sh -df $1 | tail -1 | awk '{print $2" "$4}' + #!/bin/sh + df $1 | tail -1 | awk '{print $2" "$4}' + .fi or perhaps (on Sys V based systems): @@ -2336,18 +2360,19 @@ or perhaps (on Sys V based systems): .nf -#!/bin/sh -/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' + #!/bin/sh + /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' + .fi Note that you may have to replace the command names with full path names on some systems. .TP -\fB>directory (S)\fR +\fBdirectory (S)\fR Synonym for \fIpath \fR. .TP -\fB>directory mask (S)\fR +\fBdirectory mask (S)\fR This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories. @@ -2388,10 +2413,10 @@ Default: \fBdirectory mask = 0755\fR Example: \fBdirectory mask = 0775\fR .TP -\fB>directory mode (S)\fR +\fBdirectory mode (S)\fR Synonym for \fI directory mask\fR .TP -\fB>directory security mask (S)\fR +\fBdirectory security mask (S)\fR This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog @@ -2421,7 +2446,7 @@ Default: \fBdirectory security mask = 0777\fR Example: \fBdirectory security mask = 0700\fR .TP -\fB>disable netbios (G)\fR +\fBdisable netbios (G)\fR Enabling this parameter will disable netbios support in Samba. Netbios is the only available form of browsing in all windows versions except for 2000 and XP. @@ -2433,7 +2458,7 @@ Default: \fBdisable netbios = no\fR Example: \fBdisable netbios = yes\fR .TP -\fB>disable spoolss (G)\fR +\fBdisable spoolss (G)\fR Enabling this parameter will disable Samba's support for the SPOOLSS set of MS-RPC's and will yield identical behavior as Samba 2.0.x. Windows NT/2000 clients will downgrade to using @@ -2449,7 +2474,7 @@ See also use client driver Default : \fBdisable spoolss = no\fR .TP -\fB>display charset (G)\fR +\fBdisplay charset (G)\fR Specifies the charset that samba will use to print messages to stdout and stderr and SWAT will use. Should generally be the same as the \fBunix charset\fR. @@ -2458,11 +2483,12 @@ Default: \fBdisplay charset = ASCII\fR Example: \fBdisplay charset = UTF8\fR .TP -\fB>dns proxy (G)\fR -Specifies that \fBnmbd\fR(8) when acting as a WINS server and -finding that a NetBIOS name has not been registered, should treat the -NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server -for that name on behalf of the name-querying client. +\fBdns proxy (G)\fR +Specifies that nmbd(8) +when acting as a WINS server and finding that a NetBIOS name has not +been registered, should treat the NetBIOS name word-for-word as a DNS +name and do a lookup with the DNS server for that name on behalf of +the name-querying client. Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be @@ -2476,7 +2502,7 @@ See also the parameter \fI wins support\fR. Default: \fBdns proxy = yes\fR .TP -\fB>domain logons (G)\fR +\fBdomain logons (G)\fR If set to yes, the Samba server will serve Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 has limited capability to act as a domain controller for Windows @@ -2486,17 +2512,18 @@ directory shipped with the source code. Default: \fBdomain logons = no\fR .TP -\fB>domain master (G)\fR -Tell \fBsmbd\fR(8) to enable WAN-wide browse list +\fBdomain master (G)\fR +Tell \fB nmbd(8)\fR to enable WAN-wide browse list collation. Setting this option causes \fBnmbd\fR to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given \fIworkgroup\fR. Local master browsers in the same \fIworkgroup\fR on broadcast-isolated subnets will give this \fBnmbd\fR their local browse lists, -and then ask \fBsmbd\fR(8) for a complete copy of the browse -list for the whole wide area network. Browser clients will then contact -their local master browser, and will receive the domain-wide browse list, -instead of just the list for their broadcast-isolated subnet. +and then ask \fBsmbd(8)\fR +for a complete copy of the browse list for the whole wide area +network. Browser clients will then contact their local master browser, +and will receive the domain-wide browse list, instead of just the list +for their broadcast-isolated subnet. Note that Windows NT Primary Domain Controllers expect to be able to claim this \fIworkgroup\fR specific special @@ -2516,7 +2543,7 @@ master\fR be enabled by default. Default: \fBdomain master = auto\fR .TP -\fB>dont descend (S)\fR +\fBdont descend (S)\fR There are certain directories on some systems (e.g., the \fI/proc\fR tree under Linux) that are either not of interest to clients or are infinitely deep (recursive). This @@ -2532,16 +2559,17 @@ to descend)\fR Example: \fBdont descend = /proc,/dev\fR .TP -\fB>dos charset (G)\fR +\fBdos charset (G)\fR DOS SMB clients assume the server has the same charset as they do. This option specifies which charset Samba should talk to DOS clients. -The default depends on which charsets you have installed. +The default depends on which charsets you have instaled. Samba tries to use charset 850 but falls back to ASCII in -case it is not available. Run \fBtestparm\fR(1) to check the default on your system. +case it is not available. Run testparm(1) + to check the default on your system. .TP -\fB>dos filemode (S)\fR +\fBdos filemode (S)\fR The default behavior in Samba is to provide UNIX-like behavior where only the owner of a file/directory is able to change the permissions on it. However, this behavior @@ -2555,12 +2583,13 @@ are modified. Default: \fBdos filemode = no\fR .TP -\fB>dos filetime resolution (S)\fR +\fBdos filetime resolution (S)\fR Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second -resolution is made to \fBsmbd\fR(8). +resolution is made to \fBsmbd(8)\fR + This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. If oplocks are enabled on a @@ -2575,18 +2604,18 @@ happy. Default: \fBdos filetime resolution = no\fR .TP -\fB>dos filetimes (S)\fR +\fBdos filetimes (S)\fR Under DOS and Windows, if a user can write to a file they can change the timestamp on it. Under POSIX semantics, only the owner of the file or root may change the timestamp. By default, Samba runs with POSIX semantics and refuses to change the timestamp on a file if the user \fBsmbd\fR is acting -on behalf of is not the file owner. Setting this option to yes allows DOS semantics and \fBsmbd\fR(8) will change the file +on behalf of is not the file owner. Setting this option to yes allows DOS semantics and smbd will change the file timestamp as DOS requires. Default: \fBdos filetimes = no\fR .TP -\fB>encrypt passwords (G)\fR +\fBencrypt passwords (G)\fR This boolean controls whether encrypted passwords will be negotiated with the client. Note that Windows NT 4.0 SP3 and above and also Windows 98 will by default expect encrypted passwords @@ -2595,15 +2624,16 @@ Samba see the file ENCRYPTION.txt in the Samba documentation directory \fIdocs/\fR shipped with the source code. In order for encrypted passwords to work correctly -\fBsmbd\fR(8) must either -have access to a local \fBsmbpasswd\fR(5) file (see the \fBsmbpasswd\fR(8) program for information on how to set up +\fBsmbd(8)\fR must either +have access to a local \fIsmbpasswd(5) +\fR program for information on how to set up and maintain this file), or set the security = [server|domain|ads] parameter which causes \fBsmbd\fR to authenticate against another server. Default: \fBencrypt passwords = yes\fR .TP -\fB>enhanced browsing (G)\fR +\fBenhanced browsing (G)\fR This option enables a couple of enhancements to cross-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations. @@ -2624,7 +2654,7 @@ cross-subnet browse propagation much more reliable. Default: \fBenhanced browsing = yes\fR .TP -\fB>enumports command (G)\fR +\fBenumports command (G)\fR The concept of a "port" is fairly foreign to UNIX hosts. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of @@ -2645,10 +2675,10 @@ Default: \fBno enumports command\fR Example: \fBenumports command = /usr/bin/listports \fR .TP -\fB>exec (S)\fR +\fBexec (S)\fR This is a synonym for \fIpreexec\fR. .TP -\fB>fake directory create times (S)\fR +\fBfake directory create times (S)\fR NTFS and Windows VFAT file systems keep a create time for all files and directories. This is not the same as the ctime - status change time - that Unix keeps, so Samba by default @@ -2677,7 +2707,7 @@ will proceed as expected. Default: \fBfake directory create times = no\fR .TP -\fB>fake oplocks (S)\fR +\fBfake oplocks (S)\fR Oplocks are the way that SMB clients get permission from a server to locally cache file operations. If a server grants an oplock (opportunistic lock) then the client is free to assume @@ -2702,10 +2732,10 @@ this option carefully! Default: \fBfake oplocks = no\fR .TP -\fB>follow symlinks (S)\fR +\fBfollow symlinks (S)\fR This parameter allows the Samba administrator -to stop \fBsmbd\fR(8) from following symbolic -links in a particular share. Setting this +to stop \fBsmbd(8)\fR +from following symbolic links in a particular share. Setting this parameter to no prevents any file or directory that is a symbolic link from being followed (the user will get an error). This option is very useful to stop users from adding a @@ -2718,7 +2748,7 @@ follow symbolic links) by default. Default: \fBfollow symlinks = yes\fR .TP -\fB>force create mode (S)\fR +\fBforce create mode (S)\fR This parameter specifies a set of UNIX mode bit permissions that will \fBalways\fR be set on a file created by Samba. This is done by bitwise 'OR'ing these bits onto @@ -2742,7 +2772,7 @@ would force all created files to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'. .TP -\fB>force directory mode (S)\fR +\fBforce directory mode (S)\fR This parameter specifies a set of UNIX mode bit permissions that will \fBalways\fR be set on a directory created by Samba. This is done by bitwise 'OR'ing these bits onto the @@ -2765,7 +2795,7 @@ would force all created directories to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'. .TP -\fB>force directory security mode (S)\fR +\fBforce directory security mode (S)\fR This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box. @@ -2794,7 +2824,7 @@ Default: \fBforce directory security mode = 0\fR Example: \fBforce directory security mode = 700\fR .TP -\fB>force group (S)\fR +\fBforce group (S)\fR This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service. This is useful for sharing files by ensuring @@ -2828,7 +2858,7 @@ Default: \fBno forced group\fR Example: \fBforce group = agroup\fR .TP -\fB>force security mode (S)\fR +\fBforce security mode (S)\fR This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog @@ -2858,7 +2888,7 @@ Default: \fBforce security mode = 0\fR Example: \fBforce security mode = 700\fR .TP -\fB>force user (S)\fR +\fBforce user (S)\fR This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service. This is useful for sharing files. You should also use it carefully @@ -2882,10 +2912,11 @@ Default: \fBno forced user\fR Example: \fBforce user = auser\fR .TP -\fB>fstype (S)\fR +\fBfstype (S)\fR This parameter allows the administrator to configure the string that specifies the type of filesystem a share -is using that is reported by \fBsmbd\fR(8) when a client queries the filesystem type +is using that is reported by \fBsmbd(8) +\fR when a client queries the filesystem type for a share. The default type is NTFS for compatibility with Windows NT but this can be changed to other strings such as Samba or FAT @@ -2895,7 +2926,7 @@ Default: \fBfstype = NTFS\fR Example: \fBfstype = Samba\fR .TP -\fB>getwd cache (G)\fR +\fBgetwd cache (G)\fR This is a tuning option. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls. This can have a significant impact on performance, especially @@ -2904,11 +2935,11 @@ parameter is set to no. Default: \fBgetwd cache = yes\fR .TP -\fB>group (S)\fR +\fBgroup (S)\fR Synonym for \fIforce group\fR. .TP -\fB>guest account (S)\fR +\fBguest account (S)\fR This is a username which will be used for access to services which are specified as \fI guest ok\fR (see below). Whatever privileges this user has will be available to any client connecting to the guest service. @@ -2932,20 +2963,16 @@ Default: \fBspecified at compile time, usually Example: \fBguest account = ftp\fR .TP -\fB>guest ok (S)\fR +\fBguest ok (S)\fR If this parameter is yes for a service, then no password is required to connect to the service. Privileges will be those of the \fI guest account\fR. -This paramater nullifies the benifits of setting -\fIrestrict -anonymous\fR = 2 - See the section below on \fI security\fR for more information about this option. Default: \fBguest ok = no\fR .TP -\fB>guest only (S)\fR +\fBguest only (S)\fR If this parameter is yes for a service, then only guest connections to the service are permitted. This parameter will have no effect if \fIguest ok\fR is not set for the service. @@ -2954,13 +2981,13 @@ See the section below on \fI security\fR for more information about this option Default: \fBguest only = no\fR .TP -\fB>hide dot files (S)\fR +\fBhide dot files (S)\fR This is a boolean parameter that controls whether files starting with a dot appear as hidden files. Default: \fBhide dot files = yes\fR .TP -\fB>hide files(S)\fR +\fBhide files(S)\fR This is a list of files or directories that are not visible but are accessible. The DOS 'hidden' attribute is applied to any files or directories that match. @@ -2993,35 +3020,35 @@ SMB client (DAVE) available from Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides all files beginning with a dot. .TP -\fB>hide local users(G)\fR +\fBhide local users(G)\fR This parameter toggles the hiding of local UNIX users (root, wheel, floppy, etc) from remote clients. Default: \fBhide local users = no\fR .TP -\fB>hide unreadable (G)\fR +\fBhide unreadable (G)\fR This parameter prevents clients from seeing the existance of files that cannot be read. Defaults to off. Default: \fBhide unreadable = no\fR .TP -\fB>hide unwriteable files (G)\fR +\fBhide unwriteable files (G)\fR This parameter prevents clients from seeing the existance of files that cannot be written to. Defaults to off. Note that unwriteable directories are shown as usual. Default: \fBhide unwriteable = no\fR .TP -\fB>hide special files (G)\fR +\fBhide special files (G)\fR This parameter prevents clients from seeing special files such as sockets, devices and fifo's in directory listings. Default: \fBhide special files = no\fR .TP -\fB>homedir map (G)\fR +\fBhomedir map (G)\fR If\fInis homedir -\fR is yes, and \fBsmbd\fR(8) is also acting +\fR is yes, and \fBsmbd(8)\fR is also acting as a Win95/98 \fIlogon server\fR then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted. At present, only the Sun @@ -3033,12 +3060,9 @@ and the program will extract the servername from before the first ':'. There should probably be a better parsing system that copes with different map formats and also Amd (another automounter) maps. -.sp -.RS -.B "Note:" -A working NIS client is required on + +\fBNOTE :\fRA working NIS client is required on the system for this option to work. -.RE See also \fInis homedir\fR , \fIdomain logons\fR @@ -3048,7 +3072,7 @@ Default: \fBhomedir map = <empty string>\fR Example: \fBhomedir map = amd.homedir\fR .TP -\fB>host msdfs (G)\fR +\fBhost msdfs (G)\fR This boolean parameter is only available if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes, Samba will act as a Dfs server, and allow Dfs-aware clients @@ -3060,7 +3084,7 @@ refer to msdfs_setup.html Default: \fBhost msdfs = no\fR .TP -\fB>hostname lookups (G)\fR +\fBhostname lookups (G)\fR Specifies whether samba should use (expensive) hostname lookups or use the ip addresses instead. An example place where hostname lookups are currently used is when checking @@ -3070,7 +3094,7 @@ Default: \fBhostname lookups = yes\fR Example: \fBhostname lookups = no\fR .TP -\fB>hosts allow (S)\fR +\fBhosts allow (S)\fR A synonym for this parameter is \fIallow hosts\fR. @@ -3118,8 +3142,9 @@ deny access from one particular host Note that access still requires suitable user-level passwords. -See \fBtestparm\fR(1) for a way of testing your host access -to see if it does what you expect. +See \fBtestparm(1)\fR + for a way of testing your host access to see if it does +what you expect. Default: \fBnone (i.e., all hosts permitted access) \fR @@ -3127,7 +3152,7 @@ Default: \fBnone (i.e., all hosts permitted access) Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au \fR .TP -\fB>hosts deny (S)\fR +\fBhosts deny (S)\fR The opposite of \fIhosts allow\fR - hosts listed here are \fBNOT\fR permitted access to services unless the specific services have their own lists to override @@ -3140,7 +3165,7 @@ Default: \fBnone (i.e., no hosts specifically excluded) Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au \fR .TP -\fB>hosts equiv (G)\fR +\fBhosts equiv (G)\fR If this global parameter is a non-null string, it specifies the name of a file to read for the names of hosts and users who will be allowed access without specifying a password. @@ -3148,10 +3173,8 @@ and users who will be allowed access without specifying a password. This is not be confused with \fIhosts allow\fR which is about hosts access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will not supply passwords to Samba. -.sp -.RS -.B "Note:" -The use of \fIhosts equiv + +\fBNOTE :\fR The use of \fIhosts equiv \fR can be a major security hole. This is because you are trusting the PC to supply the correct username. It is very easy to get a PC to supply a false username. I recommend that the @@ -3159,13 +3182,12 @@ get a PC to supply a false username. I recommend that the know what you are doing, or perhaps on a home network where you trust your spouse and kids. And only if you \fBreally\fR trust them :-). -.RE Default: \fBno host equivalences\fR Example: \fBhosts equiv = /etc/hosts.equiv\fR .TP -\fB>include (G)\fR +\fBinclude (G)\fR This allows you to include one config file inside another. The file is included literally, as though typed in place. @@ -3178,7 +3200,7 @@ Default: \fBno file included\fR Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf \fR .TP -\fB>inherit acls (S)\fR +\fBinherit acls (S)\fR This parameter can be used to ensure that if default acls exist on parent directories, they are always honored when creating a subdirectory. @@ -3189,7 +3211,7 @@ default directory acls are propagated. Default: \fBinherit acls = no\fR .TP -\fB>inherit permissions (S)\fR +\fBinherit permissions (S)\fR The permissions on new files and directories are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR and \fIforce @@ -3219,7 +3241,7 @@ See also \fIcreate mask Default: \fBinherit permissions = no\fR .TP -\fB>interfaces (G)\fR +\fBinterfaces (G)\fR This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NBT traffic. By default Samba will query @@ -3270,7 +3292,7 @@ interfaces only\fR. Default: \fBall active interfaces except 127.0.0.1 that are broadcast capable\fR .TP -\fB>invalid users (S)\fR +\fBinvalid users (S)\fR This is a list of users that should not be allowed to login to this service. This is really a \fBparanoid\fR check to absolutely ensure an improper setting does not breach @@ -3302,7 +3324,7 @@ Default: \fBno invalid users\fR Example: \fBinvalid users = root fred admin @wheel \fR .TP -\fB>keepalive (G)\fR +\fBkeepalive (G)\fR The value of the parameter (an integer) represents the number of seconds between \fIkeepalive\fR packets. If this parameter is zero, no keepalive packets will be @@ -3317,16 +3339,17 @@ Default: \fBkeepalive = 300\fR Example: \fBkeepalive = 600\fR .TP -\fB>kernel oplocks (G)\fR +\fBkernel oplocks (G)\fR For UNIXes that support kernel based \fIoplocks\fR (currently only IRIX and the Linux 2.4 kernel), this parameter allows the use of them to be turned on or off. Kernel oplocks support allows Samba \fIoplocks \fR to be broken whenever a local UNIX process or NFS operation -accesses a file that \fBsmbd\fR(8) has oplocked. This allows complete -data consistency between SMB/CIFS, NFS and local file access (and is -a \fBvery\fR cool feature :-). +accesses a file that \fBsmbd(8)\fR + has oplocked. This allows complete data consistency between +SMB/CIFS, NFS and local file access (and is a \fBvery\fR +cool feature :-). This parameter defaults to on, but is translated to a no-op on systems that no not have the necessary kernel support. @@ -3338,17 +3361,18 @@ and \fIlevel2 oplocks Default: \fBkernel oplocks = yes\fR .TP -\fB>lanman auth (G)\fR -This parameter determines whether or not \fBsmbd\fR(8) will attempt to authenticate users -using the LANMAN password hash. If disabled, only clients which support NT -password hashes (e.g. Windows NT/2000 clients, smbclient, etc... but not -Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host. +\fBlanman auth (G)\fR +This parameter determines whether or not smbd will +attempt to authenticate users using the LANMAN password hash. +If disabled, only clients which support NT password hashes (e.g. Windows +NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS +network client) will be able to connect to the Samba host. Default : \fBlanman auth = yes\fR .TP -\fB>large readwrite (G)\fR -This parameter determines whether or not \fBsmbd\fR(8) supports the new 64k streaming -read and write varient SMB requests introduced +\fBlarge readwrite (G)\fR +This parameter determines whether or not smbd +supports the new 64k streaming read and write varient SMB requests introduced with Windows 2000. Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64-bit capable operating system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with @@ -3357,23 +3381,26 @@ code paths. Default : \fBlarge readwrite = yes\fR .TP -\fB>ldap admin dn (G)\fR +\fBldap admin dn (G)\fR The \fIldap admin dn\fR defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information. The \fIldap admin dn\fR is used in conjunction with the admin dn password stored in the \fIprivate/secrets.tdb\fR file. See the -\fBsmbpasswd\fR(8) man page for more information on how -to accmplish this. +\fBsmbpasswd(8)\fR man +page for more information on how to accomplish this. .TP -\fB>ldap delete dn (G)\fR +\fB>ldap del only sam attr (G)\fR This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba. Default : \fBldap delete dn = no\fR .TP -\fB>ldap filter (G)\fR +\fB>ldap del only sam attr (G)\fR +Inverted synonym for \fI ldap delete dn\fR. +.TP +\fBldap filter (G)\fR This parameter specifies the RFC 2254 compliant LDAP search filter. The default is to match the login name with the uid attribute for all entries matching the sambaAccount @@ -3381,7 +3408,7 @@ objectclass. Note that this filter should only return one entry. Default : \fBldap filter = (&(uid=%u)(objectclass=sambaAccount))\fR .TP -\fB>ldap port (G)\fR +\fBldap port (G)\fR This parameter is only available if Samba has been configure to include the \fB--with-ldapsam\fR option at compile time. @@ -3396,7 +3423,7 @@ Default : \fBldap port = 636 ; if ldap ssl = on\fR Default : \fBldap port = 389 ; if ldap ssl = off\fR .TP -\fB>ldap server (G)\fR +\fBldap server (G)\fR This parameter is only available if Samba has been configure to include the \fB--with-ldapsam\fR option at compile time. @@ -3406,7 +3433,7 @@ server which should be queried to locate user account information. Default : \fBldap server = localhost\fR .TP -\fB>ldap ssl (G)\fR +\fBldap ssl (G)\fR This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is \fBNOT\fR related to @@ -3434,23 +3461,23 @@ to configure. See \fIpassdb backend\fR Default : \fBldap ssl = start_tls\fR .TP -\fB>ldap suffix (G)\fR +\fBldap suffix (G)\fR Specifies where user and machine accounts are added to the tree. Can be overriden by \fBldap user suffix\fR and \fBldap machine suffix\fR. It also used as the base dn for all ldap searches. Default : \fBnone\fR .TP -\fB>ldap user suffix (G)\fR +\fBldap user suffix (G)\fR It specifies where users are added to the tree. Default : \fBnone\fR .TP -\fB>ldap machine suffix (G)\fR +\fBldap machine suffix (G)\fR It specifies where machines should be added to the ldap tree. Default : \fBnone\fR .TP -\fB>ldap passwd sync (G)\fR +\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 @@ -3472,7 +3499,7 @@ The \fIldap passwd sync\fR can be set to one of three values: Default : \fBldap passwd sync = no\fR .TP -\fB>ldap trust ids (G)\fR +\fBldap trust ids (G)\fR Normally, Samba validates each entry in the LDAP server against getpwnam(). This allows LDAP to be used for Samba with the unix system using @@ -3489,7 +3516,7 @@ same LDAP server. Default: \fBldap trust ids = No\fR .TP -\fB>level2 oplocks (S)\fR +\fBlevel2 oplocks (S)\fR This parameter controls whether Samba supports level2 (read-only) oplocks on a share. @@ -3526,8 +3553,8 @@ parameters. Default: \fBlevel2 oplocks = yes\fR .TP -\fB>lm announce (G)\fR -This parameter determines if \fBnmbd\fR(8) will produce Lanman announce +\fBlm announce (G)\fR +This parameter determines if \fBnmbd(8)\fR will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list. This parameter can have three values, yes, no, or @@ -3548,7 +3575,7 @@ Default: \fBlm announce = auto\fR Example: \fBlm announce = yes\fR .TP -\fB>lm interval (G)\fR +\fBlm interval (G)\fR If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this parameter defines the frequency in seconds with which they will be @@ -3563,7 +3590,7 @@ Default: \fBlm interval = 60\fR Example: \fBlm interval = 120\fR .TP -\fB>load printers (G)\fR +\fBload printers (G)\fR A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default. See the printers section for @@ -3571,8 +3598,8 @@ more details. Default: \fBload printers = yes\fR .TP -\fB>local master (G)\fR -This option allows \fBnmbd\fR(8) to try and become a local master browser +\fBlocal master (G)\fR +This option allows \fB nmbd(8)\fR to try and become a local master browser on a subnet. If set to no then \fB nmbd\fR will not attempt to become a local master browser on a subnet and will also lose in all browsing elections. By default this value is set to yes. Setting this value to yes doesn't @@ -3584,10 +3611,10 @@ Setting this value to no will cause \fBnmbd\fR Default: \fBlocal master = yes\fR .TP -\fB>lock dir (G)\fR +\fBlock dir (G)\fR Synonym for \fI lock directory\fR. .TP -\fB>lock directory (G)\fR +\fBlock directory (G)\fR This option specifies the directory where lock files will be placed. The lock files are used to implement the \fImax connections\fR @@ -3597,7 +3624,7 @@ Default: \fBlock directory = ${prefix}/var/locks\fR Example: \fBlock directory = /var/run/samba/locks\fR .TP -\fB>lock spin count (G)\fR +\fBlock spin count (G)\fR This parameter controls the number of times that smbd should attempt to gain a byte range lock on the behalf of a client request. Experiments have shown that @@ -3609,7 +3636,7 @@ and FoxPro. Default: \fBlock spin count = 2\fR .TP -\fB>lock spin time (G)\fR +\fBlock spin time (G)\fR The time in microseconds that smbd should pause before attempting to gain a failed lock. See \fIlock spin @@ -3617,7 +3644,7 @@ count\fR for more details. Default: \fBlock spin time = 10\fR .TP -\fB>locking (S)\fR +\fBlocking (S)\fR This controls whether or not locking will be performed by the server in response to lock requests from the client. @@ -3640,7 +3667,7 @@ You should never need to set this parameter. Default: \fBlocking = yes\fR .TP -\fB>log file (G)\fR +\fBlog file (G)\fR This option allows you to override the name of the Samba log file (also known as the debug file). @@ -3650,7 +3677,7 @@ you to have separate log files for each user or machine. Example: \fBlog file = /usr/local/samba/var/log.%m \fR .TP -\fB>log level (G)\fR +\fBlog level (G)\fR The value of the parameter (a astring) allows the debug level (logging level) to be specified in the \fIsmb.conf\fR file. This parameter has been @@ -3664,7 +3691,7 @@ the command line or level zero if none was specified. Example: \fBlog level = 3 passdb:5 auth:10 winbind:2 \fR .TP -\fB>logon drive (G)\fR +\fBlogon drive (G)\fR This parameter specifies the local path to which the home directory will be connected (see \fIlogon home\fR) and is only used by NT Workstations. @@ -3676,7 +3703,7 @@ Default: \fBlogon drive = z:\fR Example: \fBlogon drive = h:\fR .TP -\fB>logon home (G)\fR +\fBlogon home (G)\fR This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC. It allows you to do @@ -3713,7 +3740,7 @@ Default: \fBlogon home = "\\\\%N\\%U"\fR Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR .TP -\fB>logon path (G)\fR +\fBlogon path (G)\fR This parameter specifies the home directory where roaming profiles (NTuser.dat etc files for Windows NT) are stored. Contrary to previous versions of these manual pages, it has @@ -3756,7 +3783,7 @@ Default: \fBlogon path = \\\\%N\\%U\\profile\fR Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR .TP -\fB>logon script (G)\fR +\fBlogon script (G)\fR This parameter specifies the batch file (.bat) or NT command file (.cmd) to be downloaded and run on a machine when a user successfully logs in. The file must contain the DOS @@ -3792,7 +3819,7 @@ Default: \fBno logon script defined\fR Example: \fBlogon script = scripts\\%U.bat\fR .TP -\fB>lppause command (S)\fR +\fBlppause command (S)\fR This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job. @@ -3831,7 +3858,7 @@ is SOFTQ, then the default is: Example for HPUX: \fBlppause command = /usr/bin/lpalt %p-%j -p0\fR .TP -\fB>lpq cache time (G)\fR +\fBlpq cache time (G)\fR This controls how long lpq info will be cached for to prevent the \fBlpq\fR command being called too often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different @@ -3855,7 +3882,7 @@ Default: \fBlpq cache time = 10\fR Example: \fBlpq cache time = 30\fR .TP -\fB>lpq command (S)\fR +\fBlpq command (S)\fR This parameter specifies the command to be executed on the server host in order to obtain \fBlpq \fR-style printer status information. @@ -3893,7 +3920,7 @@ Default: \fBdepends on the setting of \fI printing\fB\fR Example: \fBlpq command = /usr/bin/lpq -P%p\fR .TP -\fB>lpresume command (S)\fR +\fBlpresume command (S)\fR This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job. @@ -3928,7 +3955,7 @@ is SOFTQ, then the default is: Example for HPUX: \fBlpresume command = /usr/bin/lpalt %p-%j -p2\fR .TP -\fB>lprm command (S)\fR +\fBlprm command (S)\fR This parameter specifies the command to be executed on the server host in order to delete a print job. @@ -3955,7 +3982,7 @@ Example 1: \fBlprm command = /usr/bin/lprm -P%p %j Example 2: \fBlprm command = /usr/bin/cancel %p-%j \fR .TP -\fB>machine password timeout (G)\fR +\fBmachine password timeout (G)\fR If a Samba server is a member of a Windows NT Domain (see the security = domain) parameter) then periodically a running smbd(8) process will try and change the MACHINE ACCOUNT @@ -3964,11 +3991,12 @@ PASSWORD stored in the TDB called \fIprivate/secrets.tdb will be changed, in seconds. The default is one week (expressed in seconds), the same as a Windows NT Domain member server. -See also \fBsmbpasswd\fR(8), and the security = domain) parameter. +See also \fBsmbpasswd(8) +\fR and the security = domain) parameter. Default: \fBmachine password timeout = 604800\fR .TP -\fB>magic output (S)\fR +\fBmagic output (S)\fR This parameter specifies the name of a file which will contain output created by a magic script (see the \fImagic script\fR @@ -3983,7 +4011,7 @@ Default: \fBmagic output = <magic script name>.out Example: \fBmagic output = myfile.txt\fR .TP -\fB>magic script (S)\fR +\fBmagic script (S)\fR This parameter specifies the name of a file which, if opened, will be executed by the server when the file is closed. This allows a UNIX script to be sent to the Samba host and @@ -4009,12 +4037,12 @@ Default: \fBNone. Magic scripts disabled.\fR Example: \fBmagic script = user.csh\fR .TP -\fB>mangle case (S)\fR +\fBmangle case (S)\fR See the section on NAME MANGLING Default: \fBmangle case = no\fR .TP -\fB>mangled map (S)\fR +\fBmangled map (S)\fR This is for those who want to directly map UNIX file names which cannot be represented on Windows/DOS. The mangling of names is not always what is needed. In particular you may have @@ -4036,7 +4064,7 @@ Default: \fBno mangled map\fR Example: \fBmangled map = (*;1 *;)\fR .TP -\fB>mangled names (S)\fR +\fBmangled names (S)\fR This controls whether non-DOS names under UNIX should be mapped to DOS-compatible names ("mangled") and made visible, or whether non-DOS names should simply be ignored. @@ -4095,7 +4123,7 @@ do not change between sessions. Default: \fBmangled names = yes\fR .TP -\fB>mangling method (G)\fR +\fBmangling method (G)\fR controls the algorithm used for the generating the mangled names. Can take two different values, "hash" and "hash2". "hash" is the default and is the algorithm that has been @@ -4109,7 +4137,7 @@ Default: \fBmangling method = hash2\fR Example: \fBmangling method = hash\fR .TP -\fB>mangle prefix (G)\fR +\fBmangle prefix (G)\fR controls the number of prefix characters from the original name used when generating the mangled names. A larger value will give a weaker @@ -4120,9 +4148,9 @@ Default: \fBmangle prefix = 1\fR Example: \fBmangle prefix = 4\fR .TP -\fB>mangled stack (G)\fR +\fBmangled stack (G)\fR This parameter controls the number of mangled names -that should be cached in the Samba server \fBsmbd\fR(8). +that should be cached in the Samba server smbd(8) This stack is a list of recently mangled base names (extensions are only maintained if they are longer than 3 characters @@ -4140,7 +4168,7 @@ Default: \fBmangled stack = 50\fR Example: \fBmangled stack = 100\fR .TP -\fB>mangling char (S)\fR +\fBmangling char (S)\fR This controls what character is used as the \fBmagic\fR character in name mangling. The default is a '~' but this may interfere with some software. Use this option to set @@ -4150,7 +4178,7 @@ Default: \fBmangling char = ~\fR Example: \fBmangling char = ^\fR .TP -\fB>map archive (S)\fR +\fBmap archive (S)\fR This controls whether the DOS archive attribute should be mapped to the UNIX owner execute bit. The DOS archive bit is set when a file has been modified since its last backup. One @@ -4164,7 +4192,7 @@ parameter to be set such that owner execute bit is not masked out Default: \fBmap archive = yes\fR .TP -\fB>map hidden (S)\fR +\fBmap hidden (S)\fR This controls whether DOS style hidden files should be mapped to the UNIX world execute bit. @@ -4174,7 +4202,7 @@ it must include 001). See the parameter \fIcreate mask\fR for details. Default: \fBmap hidden = no\fR .TP -\fB>map system (S)\fR +\fBmap system (S)\fR This controls whether DOS style system files should be mapped to the UNIX group execute bit. @@ -4184,13 +4212,13 @@ it must include 010). See the parameter \fIcreate mask\fR for details. Default: \fBmap system = no\fR .TP -\fB>map to guest (G)\fR +\fBmap to guest (G)\fR This parameter is only useful in security modes other than \fIsecurity = share\fR - i.e. user, server, and domain. This parameter can take three different values, which tell -\fBsmbd\fR(8) what to do with user +smbd(8) what to do with user login requests that don't match a valid UNIX user in some way. The three settings are : @@ -4235,7 +4263,7 @@ Default: \fBmap to guest = Never\fR Example: \fBmap to guest = Bad User\fR .TP -\fB>max connections (S)\fR +\fBmax connections (S)\fR This option allows the number of simultaneous connections to a service to be limited. If \fImax connections \fR is greater than 0 then connections will be refused if @@ -4250,7 +4278,7 @@ Default: \fBmax connections = 0\fR Example: \fBmax connections = 10\fR .TP -\fB>max disk size (G)\fR +\fBmax disk size (G)\fR This option allows you to put an upper limit on the apparent size of disks. If you set this option to 100 then all shares will appear to be not larger than 100 MB in @@ -4273,7 +4301,7 @@ Default: \fBmax disk size = 0\fR Example: \fBmax disk size = 1000\fR .TP -\fB>max log size (G)\fR +\fBmax log size (G)\fR This option (an integer in kilobytes) specifies the max size the log file should grow to. Samba periodically checks the size and if it is exceeded it will rename the file, adding @@ -4285,16 +4313,16 @@ Default: \fBmax log size = 5000\fR Example: \fBmax log size = 1000\fR .TP -\fB>max mux (G)\fR +\fBmax mux (G)\fR This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow. You should never need to set this parameter. Default: \fBmax mux = 50\fR .TP -\fB>max open files (G)\fR +\fBmax open files (G)\fR This parameter limits the maximum number of -open files that one \fBsmbd\fR(8) file +open files that one smbd(8) file serving process may have open for a client at any one time. The default for this parameter is set very high (10,000) as Samba uses only one bit per unopened file. @@ -4305,10 +4333,10 @@ this parameter so you should never need to touch this parameter. Default: \fBmax open files = 10000\fR .TP -\fB>max print jobs (S)\fR +\fBmax print jobs (S)\fR This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment. -If this number is exceeded, \fBsmbd\fR(8) will remote "Out of Space" to the client. +If this number is exceeded, \fB smbd(8)\fR will remote "Out of Space" to the client. See all \fItotal print jobs\fR. @@ -4316,7 +4344,7 @@ Default: \fBmax print jobs = 1000\fR Example: \fBmax print jobs = 5000\fR .TP -\fB>max protocol (G)\fR +\fBmax protocol (G)\fR The value of the parameter (a string) is the highest protocol level that will be supported by the server. @@ -4354,22 +4382,22 @@ Default: \fBmax protocol = NT1\fR Example: \fBmax protocol = LANMAN1\fR .TP -\fB>max smbd processes (G)\fR +\fBmax smbd processes (G)\fR This parameter limits the maximum number of \fBsmbd(8)\fR processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections. Remember that under normal operating -conditions, each user will have an \fBsmbd\fR(8) associated with him or her +conditions, each user will have an smbd associated with him or her to handle connections to all shares from a given host. Default: \fBmax smbd processes = 0\fR ## no limit Example: \fBmax smbd processes = 1000\fR .TP -\fB>max ttl (G)\fR -This option tells \fBnmbd\fR(8) +\fBmax ttl (G)\fR +This option tells nmbd(8) what the default 'time to live' of NetBIOS names should be (in seconds) when \fBnmbd\fR is requesting a name using either a broadcast packet or from a WINS server. You should never need to @@ -4377,8 +4405,9 @@ change this parameter. The default is 3 days. Default: \fBmax ttl = 259200\fR .TP -\fB>max wins ttl (G)\fR -This option tells \fBsmbd\fR(8) when acting as a WINS server ( \fIwins support = yes\fR) what the maximum +\fBmax wins ttl (G)\fR +This option tells nmbd(8) + when acting as a WINS server ( \fIwins support = yes\fR) what the maximum \&'time to live' of NetBIOS names that \fBnmbd\fR will grant will be (in seconds). You should never need to change this parameter. The default is 6 days (518400 seconds). @@ -4388,7 +4417,7 @@ wins ttl\fR parameter. Default: \fBmax wins ttl = 518400\fR .TP -\fB>max xmit (G)\fR +\fBmax xmit (G)\fR This option controls the maximum packet size that will be negotiated by Samba. The default is 65535, which is the maximum. In some cases you may find you get better performance @@ -4398,7 +4427,7 @@ Default: \fBmax xmit = 65535\fR Example: \fBmax xmit = 8192\fR .TP -\fB>message command (G)\fR +\fBmessage command (G)\fR This specifies what command to run when the server receives a WinPopup style message. @@ -4461,10 +4490,10 @@ Default: \fBno message command\fR Example: \fBmessage command = csh -c 'xedit %s; rm %s' &\fR .TP -\fB>min passwd length (G)\fR +\fBmin passwd length (G)\fR Synonym for \fImin password length\fR. .TP -\fB>min password length (G)\fR +\fBmin password length (G)\fR This option sets the minimum length in characters of a plaintext password that \fBsmbd\fR will accept when performing UNIX password changing. @@ -4475,7 +4504,7 @@ password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR Default: \fBmin password length = 5\fR .TP -\fB>min print space (S)\fR +\fBmin print space (S)\fR This sets the minimum amount of free disk space that must be available before a user will be able to spool a print job. It is specified in kilobytes. The default is 0, which @@ -4488,7 +4517,7 @@ Default: \fBmin print space = 0\fR Example: \fBmin print space = 2000\fR .TP -\fB>min protocol (G)\fR +\fBmin protocol (G)\fR The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support. Please refer to the \fImax protocol\fR @@ -4507,8 +4536,8 @@ Default : \fBmin protocol = CORE\fR Example : \fBmin protocol = NT1\fR # disable DOS clients .TP -\fB>min wins ttl (G)\fR -This option tells \fBnmbd\fR(8) +\fBmin wins ttl (G)\fR +This option tells nmbd(8) when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live' of NetBIOS names that \fBnmbd\fR will grant will be (in seconds). You should never need to change this parameter. The default @@ -4516,7 +4545,7 @@ is 6 hours (21600 seconds). Default: \fBmin wins ttl = 21600\fR .TP -\fB>msdfs proxy (S)\fR +\fBmsdfs proxy (S)\fR This parameter indicates that the share is a stand-in for another CIFS share whose location is specified by the value of the parameter. When clients attempt to connect to @@ -4529,25 +4558,25 @@ and \fIhost msdfs\fR options to find out how to set up a Dfs root share. -Example: \fBmsdfs proxy = \\\\\\\\otherserver\\\\someshare\fR +Example: \fBmsdfs proxy = \\otherserver\\someshare\fR .TP -\fB>msdfs root (S)\fR +\fBmsdfs root (S)\fR This boolean parameter is only available if Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes, Samba treats the share as a Dfs root and allows clients to browse the distributed file system tree rooted at the share directory. Dfs links are specified in the share directory by symbolic -links of the form \fImsdfs:serverA\\\\shareA,serverB\\\\shareB\fR +links of the form \fImsdfs:serverA\\shareA,serverB\\shareB\fR and so on. For more information on setting up a Dfs tree -on Samba, refer to "Hosting a Microsoft -Distributed File System tree on Samba" document. +on Samba, refer to msdfs_setup.html + See also \fIhost msdfs \fR Default: \fBmsdfs root = no\fR .TP -\fB>name cache timeout (G)\fR +\fBname cache timeout (G)\fR Specifies the number of seconds it takes before entries in samba's hostname resolve cache time out. If the timeout is set to 0. the caching is disabled. @@ -4556,7 +4585,7 @@ Default: \fBname cache timeout = 660\fR Example: \fBname cache timeout = 0\fR .TP -\fB>name resolve order (G)\fR +\fBname resolve order (G)\fR This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses. The option takes a space @@ -4605,7 +4634,7 @@ This will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup. .TP -\fB>netbios aliases (G)\fR +\fBnetbios aliases (G)\fR This is a list of NetBIOS names that nmbd(8) will advertise as additional names by which the Samba server is known. This allows one machine to appear in browse lists under multiple names. If a machine is @@ -4621,7 +4650,7 @@ Default: \fBempty string (no additional names)\fR Example: \fBnetbios aliases = TEST TEST1 TEST2\fR .TP -\fB>netbios name (G)\fR +\fBnetbios name (G)\fR This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component of the host's DNS name. If a machine is a browse server or @@ -4636,12 +4665,12 @@ Default: \fBmachine DNS name\fR Example: \fBnetbios name = MYNAME\fR .TP -\fB>netbios scope (G)\fR +\fBnetbios scope (G)\fR This sets the NetBIOS scope that Samba will operate under. This should not be set unless every machine on your LAN also sets this value. .TP -\fB>nis homedir (G)\fR +\fBnis homedir (G)\fR Get the home share server from a NIS map. For UNIX systems that use an automounter, the user's home directory will often be mounted on a workstation on demand from a remote @@ -4668,7 +4697,7 @@ be a logon server. Default: \fBnis homedir = no\fR .TP -\fB>non unix account range (G)\fR +\fBnon unix account range (G)\fR The non unix account range parameter specifies the range of 'user ids' that are allocated by the various 'non unix account' passdb backends. These backends allow @@ -4676,20 +4705,17 @@ the storage of passwords for users who don't exist in /etc/passwd. This is most often used for machine account creation. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise. -.sp -.RS -.B "Note:" -These userids never appear on the system and Samba will never + +NOTE: These userids never appear on the system and Samba will never \&'become' these users. They are used only to ensure that the algorithmic RID mapping does not conflict with normal users. -.RE Default: \fBnon unix account range = <empty string> \fR Example: \fBnon unix account range = 10000-20000\fR .TP -\fB>nt acl support (S)\fR +\fBnt acl support (S)\fR This boolean parameter controls whether smbd(8) will attempt to map UNIX permissions into Windows NT access control lists. @@ -4698,16 +4724,16 @@ prior to 2.2.2. Default: \fBnt acl support = yes\fR .TP -\fB>nt pipe support (G)\fR +\fBnt pipe support (G)\fR This boolean parameter controls whether -\fBsmbd\fR(8) will allow Windows NT +smbd(8) will allow Windows NT clients to connect to the NT SMB specific IPC$ pipes. This is a developer debugging option and can be left alone. Default: \fBnt pipe support = yes\fR .TP -\fB>nt status support (G)\fR +\fBnt status support (G)\fR This boolean parameter controls whether smbd(8) will negotiate NT specific status support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone. @@ -4719,15 +4745,15 @@ You should not need to ever disable this parameter. Default: \fBnt status support = yes\fR .TP -\fB>null passwords (G)\fR +\fBnull passwords (G)\fR Allow or disallow client access to accounts that have null passwords. -See also \fBsmbpasswd\fR(5). +See also smbpasswd (5) Default: \fBnull passwords = no\fR .TP -\fB>obey pam restrictions (G)\fR +\fBobey pam restrictions (G)\fR When Samba 2.2 is configured to enable PAM support (i.e. --with-pam), this parameter will control whether or not Samba should obey PAM's account and session management directives. The @@ -4739,7 +4765,7 @@ authentication mechanism needed in the presence of SMB password encryption. Default: \fBobey pam restrictions = no\fR .TP -\fB>only user (S)\fR +\fBonly user (S)\fR This is a boolean option that controls whether connections with usernames not in the \fIuser\fR list will be allowed. By default this option is disabled so that a @@ -4761,10 +4787,10 @@ parameter. Default: \fBonly user = no\fR .TP -\fB>only guest (S)\fR +\fBonly guest (S)\fR A synonym for \fI guest only\fR. .TP -\fB>oplock break wait time (G)\fR +\fBoplock break wait time (G)\fR This is a tuning parameter added due to bugs in both Windows 9x and WinNT. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock @@ -4778,14 +4804,15 @@ AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR. Default: \fBoplock break wait time = 0\fR .TP -\fB>oplock contention limit (S)\fR +\fBoplock contention limit (S)\fR This is a \fBvery\fR advanced smbd(8) tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file. -In brief it specifies a number, which causes \fBsmbd\fR(8)not to grant an oplock even when requested -if the approximate number of clients contending for an oplock on the same file goes over this +In brief it specifies a number, which causes smbd not to +grant an oplock even when requested if the approximate number of +clients contending for an oplock on the same file goes over this limit. This causes \fBsmbd\fR to behave in a similar way to Windows NT. @@ -4794,7 +4821,7 @@ AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR. Default: \fBoplock contention limit = 2\fR .TP -\fB>oplocks (S)\fR +\fBoplocks (S)\fR This boolean option tells \fBsmbd\fR whether to issue oplocks (opportunistic locks) to file open requests on this share. The oplock code can dramatically (approx. 30% or more) improve @@ -4817,21 +4844,19 @@ oplocks\fR and \fI level2 oplocks\fR parameters. Default: \fBoplocks = yes\fR .TP -\fB>ntlm auth (G)\fR -This parameter determines -whether or not \fBsmbd\fR(8) will +\fBntlm auth (G)\fR +This parameter determines whether or not smbd will attempt to authenticate users using the NTLM password hash. If disabled, only the lanman password hashes will be used. -Please note that at least this option or \fBlanman auth\fR should -be enabled in order to be able to log in. +Please note that at least this option or \fBlanman auth\fR should be enabled in order to be able to log in. Default : \fBntlm auth = yes\fR .TP -\fB>os level (G)\fR +\fBos level (G)\fR This integer value controls what level Samba advertises itself as for browse elections. The value of this -parameter determines whether \fBnmbd\fR(8) +parameter determines whether nmbd(8) has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area. \fBNote :\fRBy default, Samba will win @@ -4846,7 +4871,7 @@ Default: \fBos level = 20\fR Example: \fBos level = 65 \fR .TP -\fB>os2 driver map (G)\fR +\fBos2 driver map (G)\fR The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names. The format is: @@ -4861,12 +4886,13 @@ LaserJet 5L\fR. The need for the file is due to the printer driver namespace problem described in the Samba Printing HOWTO For more details on OS/2 clients, please -refer to the OS2-Client-HOWTO containing in the Samba documentation. +refer to the OS2-Client-HOWTO + containing in the Samba documentation. Default: \fBos2 driver map = <empty string> \fR .TP -\fB>pam password change (G)\fR +\fBpam password change (G)\fR With the addition of better PAM support in Samba 2.2, this parameter, it is possible to use PAM's password change control flag for Samba. If enabled, then PAM will be used for password @@ -4878,28 +4904,25 @@ parameter for most setups. Default: \fBpam password change = no\fR .TP -\fB>panic action (G)\fR +\fBpanic action (G)\fR This is a Samba developer option that allows a -system command to be called when either \fBsmbd\fR(8) or \fBsmbd\fR(8) crashes. This is usually used to -draw attention to the fact that a problem occurred. +system command to be called when either smbd(8) +crashes. This is usually used to draw attention to the fact that +a problem occurred. Default: \fBpanic action = <empty string>\fR Example: \fBpanic action = "/bin/sleep 90000"\fR .TP -\fB>paranoid server security (G)\fR +\fBparanoid server security (G)\fR Some version of NT 4.x allow non-guest users with a bad passowrd. When this option is enabled, samba will not use a broken NT 4.x server as password server, but instead complain -to the logs and exit. - -Disabling this option prevents Samba from making -this check, which involves deliberatly attempting a -bad logon to the remote server. +to the logs and exit. Default: \fBparanoid server security = yes\fR .TP -\fB>passdb backend (G)\fR +\fBpassdb backend (G)\fR This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both smbpasswd and tdbsam to be used without a recompile. Multiple backends can be specified, separated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified. @@ -4969,7 +4992,7 @@ Any characters after the (optional) second : are passed to the plugin for its own processing .TP 0.2i \(bu -\fBunixsam\fR - Allows samba to map all (other) available unix users +\fBunixsam\fR - (EXPERIMENTAL) Allows samba to map all (other) available unix users This backend uses the standard unix database for retrieving users. Users included in this pdb are NOT listed in samba user listings and users included in this pdb won't be @@ -4982,19 +5005,19 @@ the unix passdb and might 'override' mappings if specified earlier. It's meant t accounts for users that aren't covered by the previous backends. .RE -Default: \fBpassdb backend = smbpasswd unixsam\fR +Default: \fBpassdb backend = smbpasswd guest\fR -Example: \fBpassdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd unixsam\fR +Example: \fBpassdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd \fR -Example: \fBpassdb backend = ldapsam_nua:ldaps://ldap.example.com unixsam\fR +Example: \fBpassdb backend = ldapsam_nua:ldaps://ldap.example.com \fR Example: \fBpassdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb\fR .TP -\fB>passwd chat (G)\fR +\fBpasswd chat (G)\fR This string controls the \fB"chat"\fR -conversation that takes places between \fBsmbd\fR(8) and the local password changing +conversation that takes places between smbd and the local password changing program to change the user's password. The string describes a -sequence of response-receive pairs that \fBsmbd\fR(8) uses to determine what to send to the +sequence of response-receive pairs that smbd(8) uses to determine what to send to the \fIpasswd program\fR and what to expect back. If the expected output is not received then the password is not changed. @@ -5014,7 +5037,7 @@ executed on the NIS master. The string can contain the macro \fI%n\fR which is substituted for the new password. The chat sequence can also contain the standard -macros \\\\n, \\\\r, \\\\t and \\\\s to give line-feed, +macros \\n, \\r, \\t and \\s to give line-feed, carriage-return, tab and space. The chat sequence string can also contain a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces @@ -5032,18 +5055,18 @@ not any particular output. The \\n macro is ignored for PAM conversions. See also \fIunix password sync\fR, \fI passwd program\fR , \fIpasswd chat debug\fR and \fIpam password change\fR. -Default: \fBpasswd chat = *new*password* %n\\\\n -*new*password* %n\\\\n *changed*\fR +Default: \fBpasswd chat = *new*password* %n\\n +*new*password* %n\\n *changed*\fR -Example: \fBpasswd chat = "*Enter OLD password*" %o\\\\n -"*Enter NEW password*" %n\\\\n "*Reenter NEW password*" %n\\\\n "*Password +Example: \fBpasswd chat = "*Enter OLD password*" %o\\n +"*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password changed*"\fR .TP -\fB>passwd chat debug (G)\fR +\fBpasswd chat debug (G)\fR This boolean specifies if the passwd chat script parameter is run in \fBdebug\fR mode. In this mode the strings passed to and received from the passwd chat are printed -in the \fBsmbd\fR(8) log with a +in the smbd(8) log with a \fIdebug level\fR of 100. This is a dangerous option as it will allow plaintext passwords to be seen in the \fBsmbd\fR log. It is available to help @@ -5060,7 +5083,7 @@ See also \fIpasswd chat\fR Default: \fBpasswd chat debug = no\fR .TP -\fB>passwd program (G)\fR +\fBpasswd program (G)\fR The name of a program that can be used to set UNIX user passwords. Any occurrences of \fI%u\fR will be replaced with the user name. The user name is checked for @@ -5093,7 +5116,7 @@ Default: \fBpasswd program = /bin/passwd\fR Example: \fBpasswd program = /sbin/npasswd %u\fR .TP -\fB>password level (G)\fR +\fBpassword level (G)\fR Some client/server combinations have difficulty with mixed-case passwords. One offending client is Windows for Workgroups, which for some reason forces passwords to upper @@ -5131,7 +5154,7 @@ Default: \fBpassword level = 0\fR Example: \fBpassword level = 4\fR .TP -\fB>password server (G)\fR +\fBpassword server (G)\fR By specifying the name of another SMB server (such as a WinNT box) with this option, and using \fBsecurity = domain \fR or \fBsecurity = server\fR you can get Samba @@ -5151,14 +5174,11 @@ by any method and order described in that parameter. The password server must be a machine capable of using the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in user level security mode. -.sp -.RS -.B "Note:" -Using a password server + +\fBNOTE:\fR Using a password server means your UNIX box (running Samba) is only as secure as your password server. \fBDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON'T COMPLETELY TRUST\fR. -.RE Never point a Samba server at itself for password serving. This will cause a loop and could lock up your Samba @@ -5225,7 +5245,7 @@ Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2, * Example: \fBpassword server = *\fR .TP -\fB>path (S)\fR +\fBpath (S)\fR This parameter specifies a directory to which the user of the service is to be given access. In the case of printable services, this is where print data will spool prior to @@ -5250,7 +5270,7 @@ Default: \fBnone\fR Example: \fBpath = /home/fred\fR .TP -\fB>pid directory (G)\fR +\fBpid directory (G)\fR This option specifies the directory where pid files will be placed. @@ -5258,8 +5278,8 @@ Default: \fBpid directory = ${prefix}/var/locks\fR Example: \fBpid directory = /var/run/\fR .TP -\fB>posix locking (S)\fR -The \fBsmbd\fR(8) +\fBposix locking (S)\fR +The \fBsmbd(8)\fR daemon maintains an database of file locks obtained by SMB clients. The default behavior is to map this internal database to POSIX locks. This means that file locks obtained by SMB clients are @@ -5269,7 +5289,7 @@ You should never need to disable this parameter. Default: \fBposix locking = yes\fR .TP -\fB>postexec (S)\fR +\fBpostexec (S)\fR This option specifies a command to be run whenever the service is disconnected. It takes the usual substitutions. The command may be run as the root on some @@ -5288,7 +5308,18 @@ Default: \fBnone (no command executed)\fR Example: \fBpostexec = echo \\"%u disconnected from %S from %m (%I)\\" >> /tmp/log\fR .TP -\fB>preexec (S)\fR +\fBpostscript (S)\fR +This parameter forces a printer to interpret +the print files as PostScript. This is done by adding a %! +to the start of print output. + +This is most useful when you have lots of PCs that persist +in putting a control-D at the start of print jobs, which then +confuses your printer. + +Default: \fBpostscript = no\fR +.TP +\fBpreexec (S)\fR This option specifies a command to be run whenever the service is connected to. It takes the usual substitutions. @@ -5310,14 +5341,14 @@ Default: \fBnone (no command executed)\fR Example: \fBpreexec = echo \\"%u connected to %S from %m (%I)\\" >> /tmp/log\fR .TP -\fB>preexec close (S)\fR +\fBpreexec close (S)\fR This boolean option controls whether a non-zero return code from \fIpreexec \fR should close the service being connected to. Default: \fBpreexec close = no\fR .TP -\fB>preferred master (G)\fR +\fBpreferred master (G)\fR This boolean parameter controls if nmbd(8) is a preferred master browser for its workgroup. @@ -5338,10 +5369,10 @@ See also \fIos level\fR Default: \fBpreferred master = auto\fR .TP -\fB>prefered master (G)\fR +\fBprefered master (G)\fR Synonym for \fI preferred master\fR for people who cannot spell :-). .TP -\fB>preload (G)\fR +\fBpreload (G)\fR This is a list of services that you want to be automatically added to the browse lists. This is most useful for homes and printers services that would otherwise not be @@ -5354,19 +5385,7 @@ Default: \fBno preloaded services\fR Example: \fBpreload = fred lp colorlp\fR .TP -\fB>preload modules (G)\fR -This is a list of paths to modules that should -be loaded into smbd before a client connects. This improves -the speed of smbd when reacting to new connections somewhat. - -It is recommended to only use this option on heavy-performance -servers. - -Default: \fBpreload modules = \fR - -Example: \fBpreload modules = /usr/lib/samba/passdb/mysql.so\fR -.TP -\fB>preserve case (S)\fR +\fBpreserve case (S)\fR This controls if new filenames are created with the case that the client passes, or if they are forced to be the \fIdefault case @@ -5377,7 +5396,7 @@ Default: \fBpreserve case = yes\fR See the section on NAME MANGLING for a fuller discussion. .TP -\fB>print command (S)\fR +\fBprint command (S)\fR After a print job has finished spooling to a service, this command will be used via a \fBsystem()\fR call to process the spool file. Typically the command specified will @@ -5462,10 +5481,10 @@ set print command will be ignored. Example: \fBprint command = /usr/local/samba/bin/myprintscript %p %s\fR .TP -\fB>print ok (S)\fR +\fBprint ok (S)\fR Synonym for \fIprintable\fR. .TP -\fB>printable (S)\fR +\fBprintable (S)\fR If this parameter is yes, then clients may open, write to and submit spool files on the directory specified for the service. @@ -5478,10 +5497,10 @@ the resource. Default: \fBprintable = no\fR .TP -\fB>printcap (G)\fR +\fBprintcap (G)\fR Synonym for \fI printcap name\fR. .TP -\fB>printcap name (G)\fR +\fBprintcap name (G)\fR This parameter may be used to override the compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons why you might want to do this. @@ -5505,30 +5524,28 @@ A minimal printcap file would look something like this: .nf -print1|My Printer 1 -print2|My Printer 2 -print3|My Printer 3 -print4|My Printer 4 -print5|My Printer 5 + print1|My Printer 1 + print2|My Printer 2 + print3|My Printer 3 + print4|My Printer 4 + print5|My Printer 5 + .fi where the '|' separates aliases of a printer. The fact that the second alias has a space in it gives a hint to Samba that it's a comment. -.sp -.RS -.B "Note:" -Under AIX the default printcap + +\fBNOTE\fR: Under AIX the default printcap name is \fI/etc/qconfig\fR. Samba will assume the file is in AIX \fIqconfig\fR format if the string \fIqconfig\fR appears in the printcap filename. -.RE Default: \fBprintcap name = /etc/printcap\fR Example: \fBprintcap name = /etc/myprintcap\fR .TP -\fB>printer admin (S)\fR +\fBprinter admin (S)\fR This is a list of users that can do anything to printers via the remote administration interfaces offered by MS-RPC (usually using a NT workstation). Note that the root user always @@ -5538,7 +5555,88 @@ Default: \fBprinter admin = <empty string>\fR Example: \fBprinter admin = admin, @staff\fR .TP -\fB>printer name (S)\fR +\fBprinter driver (S)\fR +\fBNote :\fRThis is a deprecated +parameter and will be removed in the next major release +following version 2.2. Please see the instructions in +the Samba 2.2. Printing +HOWTO for more information +on the new method of loading printer drivers onto a Samba server. + +This option allows you to control the string +that clients receive when they ask the server for the printer driver +associated with a printer. If you are using Windows95 or Windows NT +then you can use this to automate the setup of printers on your +system. + +You need to set this parameter to the exact string (case +sensitive) that describes the appropriate printer driver for your +system. If you don't know the exact string to use then you should +first try with no \fI printer driver\fR option set and the client will +give you a list of printer drivers. The appropriate strings are +shown in a scroll box after you have chosen the printer manufacturer. + +See also \fIprinter +driver file\fR. + +Example: \fBprinter driver = HP LaserJet 4L\fR +.TP +\fBprinter driver file (G)\fR +\fBNote :\fRThis is a deprecated +parameter and will be removed in the next major release +following version 2.2. Please see the instructions in +the Samba 2.2. Printing +HOWTO for more information +on the new method of loading printer drivers onto a Samba server. + +This parameter tells Samba where the printer driver +definition file, used when serving drivers to Windows 95 clients, is +to be found. If this is not set, the default is : + +\fISAMBA_INSTALL_DIRECTORY +/lib/printers.def\fR + +This file is created from Windows 95 \fImsprint.inf +\fR files found on the Windows 95 client system. For more +details on setting up serving of printer drivers to Windows 95 +clients, see the outdated documentation file in the \fIdocs/\fR +directory, \fIPRINTER_DRIVER.txt\fR. + +See also \fI printer driver location\fR. + +Default: \fBNone (set in compile).\fR + +Example: \fBprinter driver file = +/usr/local/samba/printers/drivers.def\fR +.TP +\fBprinter driver location (S)\fR +\fBNote :\fRThis is a deprecated +parameter and will be removed in the next major release +following version 2.2. Please see the instructions in +the Samba 2.2. Printing +HOWTO for more information +on the new method of loading printer drivers onto a Samba server. + +This parameter tells clients of a particular printer +share where to find the printer driver files for the automatic +installation of drivers for Windows 95 machines. If Samba is set up +to serve printer drivers to Windows 95 machines, this should be set to + +\fB\\\\MACHINE\\PRINTER$\fR + +Where MACHINE is the NetBIOS name of your Samba server, +and PRINTER$ is a share you set up for serving printer driver +files. For more details on setting this up see the outdated documentation +file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR. + +See also \fI printer driver file\fR. + +Default: \fBnone\fR + +Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$ +\fR +.TP +\fBprinter name (S)\fR This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent. @@ -5551,10 +5649,10 @@ on many systems)\fR Example: \fBprinter name = laserwriter\fR .TP -\fB>printer (S)\fR +\fBprinter (S)\fR Synonym for \fI printer name\fR. .TP -\fB>printing (S)\fR +\fBprinting (S)\fR This parameters controls how printer status information is interpreted on your system. It also affects the default values for the \fIprint command\fR, @@ -5577,21 +5675,21 @@ This option can be set on a per printer basis See also the discussion in the [printers] section. .TP -\fB>private dir (G)\fR +\fBprivate dir (G)\fR This parameters defines the directory smbd will use for storing such files as \fIsmbpasswd\fR and \fIsecrets.tdb\fR. Default :\fBprivate dir = ${prefix}/private\fR .TP -\fB>protocol (G)\fR +\fBprotocol (G)\fR Synonym for \fImax protocol\fR. .TP -\fB>public (S)\fR +\fBpublic (S)\fR Synonym for \fIguest ok\fR. .TP -\fB>queuepause command (S)\fR +\fBqueuepause command (S)\fR This parameter specifies the command to be executed on the server host in order to pause the printer queue. @@ -5615,7 +5713,7 @@ Default: \fBdepends on the setting of \fIprinting Example: \fBqueuepause command = disable %p\fR .TP -\fB>queueresume command (S)\fR +\fBqueueresume command (S)\fR This parameter specifies the command to be executed on the server host in order to resume the printer queue. It is the command to undo the behavior that is caused by the @@ -5642,7 +5740,7 @@ Default: \fBdepends on the setting of \fIprinting\fB\fR Example: \fBqueuepause command = enable %p \fR .TP -\fB>read bmpx (G)\fR +\fBread bmpx (G)\fR This boolean parameter controls whether smbd(8) will support the "Read Block Multiplex" SMB. This is now rarely used and defaults to no. You should never need to set this @@ -5650,7 +5748,7 @@ parameter. Default: \fBread bmpx = no\fR .TP -\fB>read list (S)\fR +\fBread list (S)\fR This is a list of users that are given read-only access to a service. If the connecting user is in this list then they will not be given write access, no matter what the \fIread only\fR @@ -5664,7 +5762,7 @@ Default: \fBread list = <empty string>\fR Example: \fBread list = mary, @students\fR .TP -\fB>read only (S)\fR +\fBread only (S)\fR An inverted synonym is \fIwriteable\fR. If this parameter is yes, then users @@ -5677,7 +5775,7 @@ will \fBALWAYS\fR allow writing to the directory Default: \fBread only = yes\fR .TP -\fB>read raw (G)\fR +\fBread raw (G)\fR This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients. @@ -5694,7 +5792,7 @@ tool and left severely alone. See also \fIwrite raw\fR. Default: \fBread raw = yes\fR .TP -\fB>read size (G)\fR +\fBread size (G)\fR The option \fIread size\fR affects the overlap of disk reads/writes with network reads/writes. If the amount of data being transferred in several of the SMB @@ -5718,7 +5816,7 @@ Default: \fBread size = 16384\fR Example: \fBread size = 8192\fR .TP -\fB>realm (G)\fR +\fBrealm (G)\fR This option specifies the kerberos realm to use. The realm is used as the ADS equivalent of the NT4\fBdomain\fR. It is usually set to the DNS name of the kerberos server. @@ -5727,7 +5825,7 @@ Default: \fBrealm = \fR Example: \fBrealm = mysambabox.mycompany.com\fR .TP -\fB>remote announce (G)\fR +\fBremote announce (G)\fR This option allows you to setup nmbd(8) to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name. @@ -5751,13 +5849,13 @@ The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable. -See the documentation file BROWSING +See the documentation file \fIBROWSING.txt\fR in the \fIdocs/\fR directory. Default: \fBremote announce = <empty string> \fR .TP -\fB>remote browse sync (G)\fR +\fBremote browse sync (G)\fR This option allows you to setup nmbd(8) to periodically request synchronization of browse lists with the master browser of a Samba server that is on a remote segment. This option will allow you to @@ -5788,7 +5886,7 @@ is in fact the browse master on its segment. Default: \fBremote browse sync = <empty string> \fR .TP -\fB>restrict anonymous (G)\fR +\fBrestrict anonymous (G)\fR This is a integer parameter, and mirrors as much as possible the functinality the RestrictAnonymous @@ -5796,13 +5894,13 @@ registry key does on NT/Win2k. Default: \fBrestrict anonymous = 0\fR .TP -\fB>root (G)\fR +\fBroot (G)\fR Synonym for \fIroot directory"\fR. .TP -\fB>root dir (G)\fR +\fBroot dir (G)\fR Synonym for \fIroot directory"\fR. .TP -\fB>root directory (G)\fR +\fBroot directory (G)\fR The server will \fBchroot()\fR (i.e. Change its root directory) to this directory on startup. This is not strictly necessary for secure operation. Even without it the @@ -5829,7 +5927,7 @@ Default: \fBroot directory = /\fR Example: \fBroot directory = /homes/smb\fR .TP -\fB>root postexec (S)\fR +\fBroot postexec (S)\fR This is the same as the \fIpostexec\fR parameter except that the command is run as root. This is useful for unmounting filesystems @@ -5840,7 +5938,7 @@ See also \fI postexec\fR. Default: \fBroot postexec = <empty string> \fR .TP -\fB>root preexec (S)\fR +\fBroot preexec (S)\fR This is the same as the \fIpreexec\fR parameter except that the command is run as root. This is useful for mounting filesystems (such as CDROMs) when a @@ -5851,7 +5949,7 @@ See also \fI preexec\fR and \fIpreexec close\fR. Default: \fBroot preexec = <empty string> \fR .TP -\fB>root preexec close (S)\fR +\fBroot preexec close (S)\fR This is the same as the \fIpreexec close \fR parameter except that the command is run as root. @@ -5859,12 +5957,13 @@ See also \fI preexec\fR and \fIpreexec close\fR. Default: \fBroot preexec close = no\fR .TP -\fB>security (G)\fR +\fBsecurity (G)\fR This option affects how clients respond to Samba and is one of the most important settings in the \fI smb.conf\fR file. The option sets the "security mode bit" in replies to -protocol negotiations with \fBsmbd\fR(8) to turn share level security on or off. Clients decide +protocol negotiations with smbd(8) + to turn share level security on or off. Clients decide based on this bit whether (and how) to transfer user and password information to the server. @@ -5905,7 +6004,7 @@ level security under different \fINetBIOS aliases\fR. The different settings will now be explained. ->\fBSECURITY = SHARE +\fBSECURITY = SHARE \fR When clients connect to a share level security server they @@ -5973,10 +6072,10 @@ be used in granting access. See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. ->\fBSECURITY = USER +\fBSECURITY = USER \fR -This is the default security setting in Samba 3.0. +This is the default security setting in Samba 2.2. With user-level security a client must first "log-on" with a valid username and password (which can be mapped using the \fIusername map\fR parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also @@ -5994,24 +6093,23 @@ parameter for details on doing this. See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. ->\fBSECURITY = DOMAIN +\fBSECURITY = SERVER \fR -This mode will only work correctly if \fBnet\fR(8) has been used to add this -machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR -parameter to be set to yes. In this -mode Samba will try to validate the username/password by passing -it to a Windows NT Primary or Backup Domain Controller, in exactly -the same way that a Windows NT Server would do. - -\fBNote\fR that a valid UNIX user must still -exist as well as the account on the Domain Controller to allow -Samba to have a valid UNIX account to map file access to. +In this mode Samba will try to validate the username/password +by passing it to another SMB server, such as an NT box. If this +fails it will revert to \fBsecurity = user\fR, but note +that if encrypted passwords have been negotiated then Samba cannot +revert back to checking the UNIX password file, it must have a valid +\fIsmbpasswd\fR file to check users against. See the +documentation file in the \fIdocs/\fR directory +\fIENCRYPTION.txt\fR for details on how to set this +up. -\fBNote\fR that from the client's point -of view \fBsecurity = domain\fR is the same as \fBsecurity = user -\fR. It only affects how the server deals with the authentication, -it does not in any way affect what the client sees. +\fBNote\fR that from the client's point of +view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals +with the authentication, it does not in any way affect what the +client sees. \fBNote\fR that the name of the resource being requested is \fBnot\fR sent to the server until after @@ -6027,39 +6125,24 @@ See also the \fIpassword server\fR parameter and the \fIencrypted passwords\fR parameter. ->\fBSECURITY = SERVER +\fBSECURITY = DOMAIN \fR -In this mode Samba will try to validate the username/password -by passing it to another SMB server, such as an NT box. If this -fails it will revert to \fBsecurity = -user\fR. It expects the \fIencrypted passwords\fR -parameter to be set to -yes, unless the remote server -does not support them. However note -that if encrypted passwords have been negotiated then Samba cannot -revert back to checking the UNIX password file, it must have a valid -\fIsmbpasswd\fR file to check users against. See the -documentation file in the \fIdocs/\fR directory -\fIENCRYPTION.txt\fR for details on how to set this -up. +This mode will only work correctly if smbpasswd(8) has been used to add this +machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR +parameter to be set to yes. In this +mode Samba will try to validate the username/password by passing +it to a Windows NT Primary or Backup Domain Controller, in exactly +the same way that a Windows NT Server would do. -\fBNote\fR this mode of operation -has significant pitfalls, due to the fact that is -activly initiates a man-in-the-middle attack on the -remote SMB server. In particular, this mode of -operation can cause significant resource consuption on -the PDC, as it must maintain an active connection for -the duration of the user's session. Furthermore, if -this connection is lost, there is no way to -reestablish it, and futher authenticaions to the Samba -server may fail. (From a single client, till it -disconnects). +\fBNote\fR that a valid UNIX user must still +exist as well as the account on the Domain Controller to allow +Samba to have a valid UNIX account to map file access to. -\fBNote\fR that from the client's point of -view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals -with the authentication, it does not in any way affect what the -client sees. +\fBNote\fR that from the client's point +of view \fBsecurity = domain\fR is the same as \fBsecurity = user +\fR. It only affects how the server deals with the authentication, +it does not in any way affect what the client sees. \fBNote\fR that the name of the resource being requested is \fBnot\fR sent to the server until after @@ -6069,6 +6152,14 @@ the server to automatically map unknown users into the \fIguest account\fR. See the \fImap to guest\fR parameter for details on doing this. +\fBBUG:\fR There is currently a bug in the +implementation of \fBsecurity = domain\fR with respect +to multi-byte character set usernames. The communication with a +Domain Controller must be done in UNICODE and Samba currently +does not widen multi-byte user names to UNICODE correctly, thus +a multi-byte username will not be recognized correctly at the +Domain Controller. This issue will be addressed in a future release. + See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. See also the \fIpassword @@ -6079,7 +6170,7 @@ Default: \fBsecurity = USER\fR Example: \fBsecurity = DOMAIN\fR .TP -\fB>security mask (S)\fR +\fBsecurity mask (S)\fR This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security @@ -6108,27 +6199,7 @@ Default: \fBsecurity mask = 0777\fR Example: \fBsecurity mask = 0770\fR .TP -\fB>server schannel (G)\fR -This controls whether the server offers or even -demands the use of the netlogon schannel. -\fIserver schannel = no\fR does not -offer the schannel, \fIserver schannel = -auto\fR offers the schannel but does not -enforce it, and \fIserver schannel = -yes\fR denies access if the client is not -able to speak netlogon schannel. This is only the case -for Windows NT4 before SP4. - -Please note that with this set to -\fIno\fR you will have to apply the -WindowsXP requireSignOrSeal-Registry patch found in -the docs/Registry subdirectory. - -Default: \fBserver schannel = auto\fR - -Example: \fBserver schannel = yes\fR/para> -.TP -\fB>server string (G)\fR +\fBserver string (G)\fR This controls what string will show up in the printer comment box in print manager and next to the IPC connection in \fBnet view\fR. It can be any string that you wish @@ -6148,23 +6219,7 @@ Default: \fBserver string = Samba %v\fR Example: \fBserver string = University of GNUs Samba Server\fR .TP -\fB>set primary group script (G)\fR -Thanks to the Posix subsystem in NT a -Windows User has a primary group in addition to the -auxiliary groups. This script sets the primary group -in the unix userdatase when an administrator sets the -primary group from the windows user manager or when -fetching a SAM with \fBnet rpc -vampire\fR. \fI%u\fR will be -replaced with the user whose primary group is to be -set. \fI%g\fR will be replaced with -the group to set. - -Default: \fBNo default value\fR - -Example: \fBset primary group script = /usr/sbin/usermod -g '%g' '%u'\fR -.TP -\fB>set directory (S)\fR +\fBset directory (S)\fR If \fBset directory = no\fR, then users of the service may not use the setdir command to change directory. @@ -6175,7 +6230,7 @@ for details. Default: \fBset directory = no\fR .TP -\fB>share modes (S)\fR +\fBshare modes (S)\fR This enables or disables the honoring of the \fIshare modes\fR during a file open. These modes are used by clients to gain exclusive read or write access @@ -6198,7 +6253,7 @@ off as many Windows applications will break if you do so. Default: \fBshare modes = yes\fR .TP -\fB>short preserve case (S)\fR +\fBshort preserve case (S)\fR This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced @@ -6211,7 +6266,7 @@ See the section on NAME MANGLING. Default: \fBshort preserve case = yes\fR .TP -\fB>show add printer wizard (G)\fR +\fBshow add printer wizard (G)\fR With the introduction of MS-RPC based printing support for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will appear on Samba hosts in the share listing. Normally this folder will @@ -6238,7 +6293,7 @@ command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR Default :\fBshow add printer wizard = yes\fR .TP -\fB>shutdown script (G)\fR +\fBshutdown script (G)\fR \fBThis parameter only exists in the HEAD cvs branch\fR This a full path name to a script called by \fBsmbd(8)\fR that @@ -6271,19 +6326,20 @@ Example: \fBabort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f\f Shutdown script example: .nf -#!/bin/bash + #!/bin/bash -$time=0 -let "time/60" -let "time++" + $time=0 + let "time/60" + let "time++" -/sbin/shutdown $3 $4 +$time $1 & + /sbin/shutdown $3 $4 +$time $1 & + .fi Shutdown does not return so we need to launch it in background. See also \fIabort shutdown script\fR. .TP -\fB>smb passwd file (G)\fR +\fBsmb passwd file (G)\fR This option sets the path to the encrypted smbpasswd file. By default the path to the smbpasswd file is compiled into Samba. @@ -6294,13 +6350,13 @@ Default: \fBsmb passwd file = ${prefix}/private/smbpasswd Example: \fBsmb passwd file = /etc/samba/smbpasswd \fR .TP -\fB>smb ports (G)\fR +\fBsmb ports (G)\fR Specifies which ports the server should listen on for SMB traffic. Default: \fBsmb ports = 445 139\fR .TP -\fB>socket address (G)\fR +\fBsocket address (G)\fR This option allows you to control what address Samba will listen for connections on. This is used to support multiple virtual interfaces on the one server, each @@ -6311,7 +6367,7 @@ address. Example: \fBsocket address = 192.168.2.20\fR .TP -\fB>socket options (G)\fR +\fBsocket options (G)\fR This option allows you to set socket options to be used when talking with the client. @@ -6399,7 +6455,7 @@ Default: \fBsocket options = TCP_NODELAY\fR Example: \fBsocket options = IPTOS_LOWDELAY\fR .TP -\fB>source environment (G)\fR +\fBsource environment (G)\fR This parameter causes Samba to set environment variables as per the content of the file named. @@ -6423,31 +6479,26 @@ Examples: \fBsource environment = |/etc/smb.conf.sh Example: \fBsource environment = /usr/local/smb_env_vars\fR .TP -\fB>use spnego (G)\fR -This variable controls controls whether samba will try -to use Simple and Protected NEGOciation (as specified by rfc2478) with -WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. -Unless further issues are discovered with our SPNEGO -implementation, there is no reason this should ever be -disabled. +\fBuse spnego (G)\fR +This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. As of samba 3.0alpha it must be set to "no" for these clients to join a samba domain controller. It can be set to "yes" to allow samba to participate in an AD domain controlled by a Windows2000 domain controller. Default: \fBuse spnego = yes\fR .TP -\fB>stat cache (G)\fR -This parameter determines if \fBsmbd\fR(8) will use a cache in order to +\fBstat cache (G)\fR +This parameter determines if smbd(8) will use a cache in order to speed up case insensitive name mappings. You should never need to change this parameter. Default: \fBstat cache = yes\fR .TP -\fB>stat cache size (G)\fR +\fBstat cache size (G)\fR This parameter determines the number of entries in the \fIstat cache\fR. You should never need to change this parameter. Default: \fBstat cache size = 50\fR .TP -\fB>strict allocate (S)\fR +\fBstrict allocate (S)\fR This is a boolean that controls the handling of disk space allocation in the server. When this is set to yes the server will change from UNIX behaviour of not committing real @@ -6466,7 +6517,7 @@ of users. Default: \fBstrict allocate = no\fR .TP -\fB>strict locking (S)\fR +\fBstrict locking (S)\fR This is a boolean that controls the handling of file locking in the server. When this is set to yes the server will check every read and write access for file locks, and @@ -6481,7 +6532,7 @@ locking = no\fR is preferable. Default: \fBstrict locking = no\fR .TP -\fB>strict sync (S)\fR +\fBstrict sync (S)\fR Many Windows applications (including the Windows 98 explorer shell) seem to confuse flushing buffer contents to disk with doing a sync to disk. Under UNIX, a sync call forces @@ -6489,7 +6540,7 @@ the process to be suspended until the kernel has ensured that all outstanding data in kernel disk buffers has been safely stored onto stable storage. This is very slow and should only be done rarely. Setting this parameter to no (the -default) means that \fBsmbd\fR(8) ignores the Windows applications requests for +default) means that smbd ignores the Windows applications requests for a sync call. There is only a possibility of losing data if the operating system itself that Samba is running on crashes, so there is little danger in this default setting. In addition, this fixes many @@ -6501,14 +6552,14 @@ always>\fR parameter. Default: \fBstrict sync = no\fR .TP -\fB>strip dot (G)\fR +\fBstrip dot (G)\fR This is a boolean that controls whether to strip trailing dots off UNIX filenames. This helps with some CDROMs that have filenames ending in a single dot. Default: \fBstrip dot = no\fR .TP -\fB>sync always (S)\fR +\fBsync always (S)\fR This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns. If this is no then the server will be @@ -6525,7 +6576,7 @@ sync\fR parameter. Default: \fBsync always = no\fR .TP -\fB>syslog (G)\fR +\fBsyslog (G)\fR This parameter maps how Samba debug messages are logged onto the system syslog logging levels. Samba debug level zero maps onto syslog LOG_ERR, debug @@ -6539,14 +6590,14 @@ will be sent to syslog. Default: \fBsyslog = 1\fR .TP -\fB>syslog only (G)\fR +\fBsyslog only (G)\fR If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files. Default: \fBsyslog only = no\fR .TP -\fB>template homedir (G)\fR +\fBtemplate homedir (G)\fR When filling out the user information for a Windows NT user, the winbindd(8) daemon uses this parameter to fill in the home directory for that user. @@ -6557,14 +6608,14 @@ NT user name. Default: \fBtemplate homedir = /home/%D/%U\fR .TP -\fB>template shell (G)\fR +\fBtemplate shell (G)\fR When filling out the user information for a Windows NT -user, the \fBwinbindd\fR(8) daemon +user, the winbindd(8) daemon uses this parameter to fill in the login shell for that user. Default: \fBtemplate shell = /bin/false\fR .TP -\fB>time offset (G)\fR +\fBtime offset (G)\fR This parameter is a setting in minutes to add to the normal GMT to local time conversion. This is useful if you are serving a lot of PCs that have incorrect daylight @@ -6574,20 +6625,21 @@ Default: \fBtime offset = 0\fR Example: \fBtime offset = 60\fR .TP -\fB>time server (G)\fR -This parameter determines if \fBnmbd\fR(8) advertises itself as a time server to Windows +\fBtime server (G)\fR +This parameter determines if +nmbd(8) advertises itself as a time server to Windows clients. Default: \fBtime server = no\fR .TP -\fB>timestamp logs (G)\fR +\fBtimestamp logs (G)\fR Synonym for \fI debug timestamp\fR. .TP -\fB>total print jobs (G)\fR +\fBtotal print jobs (G)\fR This parameter accepts an integer value which defines a limit on the maximum number of print jobs that will be accepted system wide at any given time. If a print job is submitted -by a client which will exceed this number, then \fBsmbd\fR(8) will return an +by a client which will exceed this number, then smbd will return an error indicating that no space is available on the server. The default value of 0 means that no such limit exists. This parameter can be used to prevent a server from exceeding its capacity and is @@ -6598,23 +6650,23 @@ Default: \fBtotal print jobs = 0\fR Example: \fBtotal print jobs = 5000\fR .TP -\fB>unicode (G)\fR +\fBunicode (G)\fR Specifies whether Samba should try to use unicode on the wire by default. Note: This does NOT mean that samba will assume that the unix machine uses unicode! Default: \fBunicode = yes\fR .TP -\fB>unix charset (G)\fR +\fBunix charset (G)\fR Specifies the charset the unix machine Samba runs on uses. Samba needs to know this in order to be able to convert text to the charsets other SMB clients use. -Default: \fBunix charset = UTF8\fR +Default: \fBunix charset = ASCII\fR -Example: \fBunix charset = ASCII\fR +Example: \fBunix charset = UTF8\fR .TP -\fB>unix extensions(G)\fR +\fBunix extensions(G)\fR This boolean parameter controls whether Samba implments the CIFS UNIX extensions, as defined by HP. These extensions enable Samba to better serve UNIX CIFS clients @@ -6624,7 +6676,7 @@ no current use to Windows clients. Default: \fBunix extensions = no\fR .TP -\fB>unix password sync (G)\fR +\fBunix password sync (G)\fR This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed. @@ -6639,7 +6691,7 @@ program\fR, \fI passwd chat\fR. Default: \fBunix password sync = no\fR .TP -\fB>update encrypted (G)\fR +\fBupdate encrypted (G)\fR This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed) password in the smbpasswd file to be updated automatically as @@ -6665,7 +6717,7 @@ password in order to connect correctly, and to update their hashed Default: \fBupdate encrypted = no\fR .TP -\fB>use client driver (S)\fR +\fBuse client driver (S)\fR This parameter applies only to Windows NT/2000 clients. It has no affect on Windows 95/98/ME clients. When serving a printer to Windows NT/2000 clients without first installing @@ -6697,7 +6749,7 @@ See also disable spoolss Default: \fBuse client driver = no\fR .TP -\fB>use mmap (G)\fR +\fBuse mmap (G)\fR This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system. Samba requires a coherent mmap/read-write system memory cache. Currently only HPUX does not have such a @@ -6708,13 +6760,27 @@ the tdb internal code. Default: \fBuse mmap = yes\fR .TP -\fB>user (S)\fR +\fBuse rhosts (G)\fR +If this global parameter is yes, it specifies +that the UNIX user's \fI.rhosts\fR file in their home directory +will be read to find the names of hosts and users who will be allowed +access without specifying a password. + +\fBNOTE:\fR The use of \fIuse rhosts +\fR can be a major security hole. This is because you are +trusting the PC to supply the correct username. It is very easy to +get a PC to supply a false username. I recommend that the \fI use rhosts\fR option be only used if you really know what +you are doing. + +Default: \fBuse rhosts = no\fR +.TP +\fBuser (S)\fR Synonym for \fI username\fR. .TP -\fB>users (S)\fR +\fBusers (S)\fR Synonym for \fI username\fR. .TP -\fB>username (S)\fR +\fBusername (S)\fR Multiple users may be specified in a comma-delimited list, in which case the supplied password will be tested against each username in turn (left to right). @@ -6755,7 +6821,7 @@ If any of the usernames begin with a '+' then the name will be looked up only in the UNIX groups database and will expand to a list of all users in the group of that name. -If any of the usernames begin with a '&' then the name +If any of the usernames begin with a '&'then the name will be looked up only in the NIS netgroups database (if Samba is compiled with netgroup support) and will expand to a list of all users in the netgroup group of that name. @@ -6774,7 +6840,7 @@ else <empty string>.\fR Examples:\fBusername = fred, mary, jack, jane, @users, @pcgroup\fR .TP -\fB>username level (G)\fR +\fBusername level (G)\fR This option helps Samba to try and 'guess' at the real UNIX username, as many DOS clients send an all-uppercase username. By default Samba tries all lowercase, followed by the @@ -6793,7 +6859,7 @@ Default: \fBusername level = 0\fR Example: \fBusername level = 5\fR .TP -\fB>username map (G)\fR +\fBusername map (G)\fR This option allows you to specify a file containing a mapping of usernames from the clients to the server. This can be used for several purposes. The most common is to map usernames @@ -6856,8 +6922,9 @@ that line. .nf -!sys = mary fred -guest = * + !sys = mary fred + guest = * + .fi Note that the remapping is applied to all occurrences @@ -6879,7 +6946,7 @@ Default: \fBno username map\fR Example: \fBusername map = /usr/local/samba/lib/users.map \fR .TP -\fB>use sendfile (S)\fR +\fBuse sendfile (S)\fR If this parameter is yes, and Samba was built with the --with-sendfile-support option, and the underlying operating system supports sendfile system call, then some SMB read calls (mainly ReadAndX @@ -6890,7 +6957,7 @@ as yet. Default: \fBuse sendfile = no\fR .TP -\fB>utmp (G)\fR +\fButmp (G)\fR This boolean parameter is only available if Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to yes then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a @@ -6907,7 +6974,7 @@ See also the \fI utmp directory\fR parameter. Default: \fButmp = no\fR .TP -\fB>utmp directory(G)\fR +\fButmp directory(G)\fR This parameter is only available if Samba has been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is used to store the utmp or utmpx files (depending on the UNIX system) that @@ -6920,7 +6987,7 @@ Default: \fBno utmp directory\fR Example: \fButmp directory = /var/run/utmp\fR .TP -\fB>wtmp directory(G)\fR +\fBwtmp directory(G)\fR This parameter is only available if Samba has been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on the UNIX system) that @@ -6936,7 +7003,7 @@ Default: \fBno wtmp directory\fR Example: \fBwtmp directory = /var/log/wtmp\fR .TP -\fB>valid users (S)\fR +\fBvalid users (S)\fR This is a list of users that should be allowed to login to this service. Names starting with '@', '+' and '&' are interpreted using the same rules as described in the @@ -6957,7 +7024,7 @@ Default: \fBNo valid users list (anyone can login) Example: \fBvalid users = greg, @pcusers\fR .TP -\fB>veto files(S)\fR +\fBveto files(S)\fR This is a list of files and directories that are neither visible nor accessible. Each entry in the list must be separated by a '/', which allows spaces to be included @@ -7002,7 +7069,7 @@ veto files = /*Security*/*.tmp/*root*/ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ .fi .TP -\fB>veto oplock files (S)\fR +\fBveto oplock files (S)\fR This parameter is only valid when the \fIoplocks\fR parameter is turned on for a share. It allows the Samba administrator to selectively turn off the granting of oplocks on selected files that @@ -7024,7 +7091,7 @@ the particular NetBench share : Example: \fBveto oplock files = /*.SEM/ \fR .TP -\fB>vfs path (S)\fR +\fBvfs path (S)\fR This parameter specifies the directory to look in for vfs modules. The name of every \fBvfs object \fR will be prepended by this directory @@ -7033,7 +7100,7 @@ Default: \fBvfs path = \fR Example: \fBvfs path = /usr/lib/samba/vfs\fR .TP -\fB>vfs object (S)\fR +\fBvfs object (S)\fR This parameter specifies a shared object files that are used for Samba VFS I/O operations. By default, normal disk I/O operations are used but these can be overloaded @@ -7041,21 +7108,21 @@ with one or more VFS objects. Default : \fBno value\fR .TP -\fB>vfs options (S)\fR +\fBvfs options (S)\fR This parameter allows parameters to be passed to the vfs layer at initialization time. See also \fI vfs object\fR. Default : \fBno value\fR .TP -\fB>volume (S)\fR +\fBvolume (S)\fR This allows you to override the volume label returned for a share. Useful for CDROMs with installation programs that insist on a particular volume label. Default: \fBthe name of the share\fR .TP -\fB>wide links (S)\fR +\fBwide links (S)\fR This parameter controls whether or not links in the UNIX file system may be followed by the server. Links that point to areas within the directory tree exported by the @@ -7068,17 +7135,19 @@ that Samba has to do in order to perform the link checks. Default: \fBwide links = yes\fR .TP -\fB>winbind cache time (G)\fR -This parameter specifies the number of -seconds the \fBwinbindd\fR(8) daemon will cache +\fBwinbind cache time (G)\fR +This parameter specifies the number of seconds the +winbindd(8) daemon will cache user and group information before querying a Windows NT server again. Default: \fBwinbind cache type = 15\fR .TP -\fB>winbind enum users (G)\fR -On large installations using \fBwinbindd\fR(8) it may be -necessary to suppress the enumeration of users through the \fBsetpwent()\fR, +\fBwinbind enum users (G)\fR +On large installations using +winbindd(8) 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 @@ -7093,9 +7162,11 @@ usernames. Default: \fBwinbind enum users = yes \fR .TP -\fB>winbind enum groups (G)\fR -On large installations using \fBwinbindd\fR(8) it may be necessary to suppress -the enumeration of groups through the \fBsetgrent()\fR, +\fBwinbind enum groups (G)\fR +On large installations using +winbindd(8) 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 @@ -7107,9 +7178,9 @@ enumeration may cause some programs to behave oddly. Default: \fBwinbind enum groups = yes \fR .TP -\fB>winbind gid (G)\fR +\fBwinbind gid (G)\fR The winbind gid parameter specifies the range of group -ids that are allocated by the \fBwinbindd\fR(8) daemon. This range of group ids should have no +ids that are allocated by the winbindd(8) daemon. This range of group ids should have no existing local or NIS groups within it as strange conflicts can occur otherwise. @@ -7118,7 +7189,7 @@ Default: \fBwinbind gid = <empty string> Example: \fBwinbind gid = 10000-20000\fR .TP -\fB>winbind separator (G)\fR +\fBwinbind separator (G)\fR This parameter allows an admin to define the character used when listing a username of the form of \fIDOMAIN \fR\\\fIuser\fR. This parameter @@ -7133,9 +7204,9 @@ Default: \fBwinbind separator = '\\'\fR Example: \fBwinbind separator = +\fR .TP -\fB>winbind uid (G)\fR +\fBwinbind uid (G)\fR The winbind gid parameter specifies the range of group -ids that are allocated by the \fBwinbindd\fR(8) daemon. This range of ids should have no +ids that are allocated by the winbindd(8) daemon. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise. @@ -7144,9 +7215,11 @@ Default: \fBwinbind uid = <empty string> Example: \fBwinbind uid = 10000-20000\fR .TP -\fB>winbind use default domain (G)\fR -This parameter specifies whether the \fBwinbindd\fR(8) daemon should operate on users -without domain component in their username. +\fBwinbind use default domain\fR +.TP +\fBwinbind use default domain (G)\fR +This parameter specifies whether the winbindd(8) +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. @@ -7156,7 +7229,7 @@ Default: \fBwinbind use default domain = <no> Example: \fBwinbind use default domain = yes\fR .TP -\fB>wins hook (G)\fR +\fBwins hook (G)\fR When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database. The primary use for this option is to allow the @@ -7202,47 +7275,35 @@ An example script that calls the BIND dynamic DNS update program \fBnsupdate\fR is provided in the examples directory of the Samba source code. .TP -\fB>wins proxy (G)\fR +\fBwins proxy (G)\fR This is a boolean that controls if nmbd(8) will respond to broadcast name queries on behalf of other hosts. You may need to set this to yes for some older clients. Default: \fBwins proxy = no\fR .TP -\fB>wins server (G)\fR +\fBwins server (G)\fR This specifies the IP address (or DNS name: IP -address for preference) of the WINS server that \fBnmbd\fR(8) should register with. If you have a WINS server on +address for preference) of the WINS server that nmbd(8) should register with. If you have a WINS server on your network then you should set this to the WINS server's IP. You should point this at your WINS server if you have a multi-subnetted network. -If you want to work in multiple namespaces, you can -give every wins server a 'tag'. For each tag, only one -(working) server will be queried for a name. The tag should be -seperated from the ip address by a colon. -.sp -.RS -.B "Note:" -You need to set up Samba to point +\fBNOTE\fR. You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross-subnet browsing to work correctly. -.RE -See the documentation file Browsing in the samba howto collection. +See the documentation file \fIBROWSING.txt\fR +in the docs/ directory of your Samba source distribution. Default: \fBnot enabled\fR -Example: \fBwins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61\fR - -For this example when querying a certain name, 192.19.200.1 will -be asked first and if that doesn't respond 192.168.2.61. If either -of those doesn't know the name 192.168.3.199 will be queried. - -Example: \fBwins server = 192.9.200.1 192.168.2.61\fR +Example: \fBwins server = 192.9.200.1\fR .TP -\fB>wins support (G)\fR -This boolean controls if the \fBnmbd\fR(8) process in Samba will act as a WINS server. You should +\fBwins support (G)\fR +This boolean controls if the +nmbd(8) process in Samba will act as a WINS server. You should not set this to yes unless you have a multi-subnetted network and you wish a particular \fBnmbd\fR to be your WINS server. Note that you should \fBNEVER\fR set this to yes @@ -7250,7 +7311,7 @@ on more than one machine in your network. Default: \fBwins support = no\fR .TP -\fB>workgroup (G)\fR +\fBworkgroup (G)\fR This controls what workgroup your server will appear to be in when queried by clients. Note that this parameter also controls the Domain name used with the \fBsecurity = domain\fR @@ -7260,10 +7321,10 @@ Default: \fBset at compile time to WORKGROUP\fR Example: \fBworkgroup = MYGROUP\fR .TP -\fB>writable (S)\fR +\fBwritable (S)\fR Synonym for \fI writeable\fR for people who can't spell :-). .TP -\fB>write cache size (S)\fR +\fBwrite cache size (S)\fR If this integer parameter is set to non-zero value, Samba will create an in-memory cache for each oplocked file (it does \fBnot\fR do this for @@ -7289,7 +7350,7 @@ Example: \fBwrite cache size = 262144\fR for a 256k cache size per file. .TP -\fB>write list (S)\fR +\fBwrite list (S)\fR This is a list of users that are given read-write access to a service. If the connecting user is in this list then they will be given write access, no matter what the \fIread only\fR @@ -7308,7 +7369,7 @@ Default: \fBwrite list = <empty string> Example: \fBwrite list = admin, root, @staff \fR .TP -\fB>wins partners (G)\fR +\fBwins partners (G)\fR A space separated list of partners' IP addresses for WINS replication. WINS partners are always defined as push/pull partners as defining only one way WINS replication is unreliable. @@ -7319,17 +7380,17 @@ Default: \fBwins partners = \fR Example: \fBwins partners = 192.168.0.1 172.16.1.2\fR .TP -\fB>write ok (S)\fR +\fBwrite ok (S)\fR Inverted synonym for \fI read only\fR. .TP -\fB>write raw (G)\fR +\fBwrite raw (G)\fR This parameter controls whether or not the server will support raw write SMB's when transferring data from clients. You should never need to change this parameter. Default: \fBwrite raw = yes\fR .TP -\fB>writeable (S)\fR +\fBwriteable (S)\fR Inverted synonym for \fI read only\fR. .SH "WARNINGS" .PP @@ -7339,7 +7400,8 @@ be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility. .PP On a similar note, many clients - especially DOS clients - -limit service names to eight characters. \fBsmbd\fR(8) has no such limitation, but attempts to connect from such +limit service names to eight characters. smbd(8) + has no such limitation, but attempts to connect from such clients will fail if they truncate the service names. For this reason you should probably keep your service names down to eight characters in length. @@ -7351,10 +7413,19 @@ sections. In particular, ensure that the permissions on spool directories are correct. .SH "VERSION" .PP -This man page is correct for version 3.0 of the Samba suite. +This man page is correct for version 3.0 of +the Samba suite. .SH "SEE ALSO" .PP -\fBsamba\fR(7), \fBsmbpasswd\fR(8), \fBswat\fR(8), \fBsmbd\fR(8), \fBnmbd\fR(8), \fBsmbclient\fR(1), \fBnmblookup\fR(1), \fBtestparm\fR(1), \fBtestprns\fR(1). +samba(7) +\fBsmbpasswd(8)\fR +\fBswat(8)\fR +\fBsmbd(8)\fR +\fBnmbd(8)\fR +\fBsmbclient(1)\fR +\fBnmblookup(1)\fR +\fBtestparm(1)\fR +\fBtestprns(1)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -7364,7 +7435,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbcacls.1 b/docs/manpages/smbcacls.1 index b82871cd7f..aaed1ba8f5 100644 --- a/docs/manpages/smbcacls.1 +++ b/docs/manpages/smbcacls.1 @@ -3,17 +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 "SMBCACLS" "1" "07 april 2003" "" "" - +.TH "SMBCACLS" "1" "04 March 2003" "" "" .SH NAME smbcacls \- Set or get ACLs on an NT file or directory names .SH SYNOPSIS -\fBsmbcacls\fR \fB//server/share\fR \fBfilename\fR [ \fB-D acls\fR ] [ \fB-M acls\fR ] [ \fB-A acls\fR ] [ \fB-S acls\fR ] [ \fB-C name\fR ] [ \fB-G name\fR ] [ \fB-n\fR ] [ \fB-t\fR ] [ \fB-U username\fR ] [ \fB-h\fR ] [ \fB-d\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 \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP The \fBsmbcacls\fR program manipulates NT Access Control Lists (ACLs) on SMB file shares. @@ -46,7 +45,7 @@ type, owner and group for the call to succeed. Specifies a username used to connect to the specified service. The username may be of the form "username" in which case the user is prompted to enter in a password and the -workgroup specified in the \fBsmb.conf\fR(5) file is +workgroup specified in the \fIsmb.conf\fR file is used, or "username%password" or "DOMAIN\\username%password" and the password and workgroup names are used as provided. .TP @@ -71,53 +70,9 @@ 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. .TP -\fB-t\fR -Don't actually do anything, only validate the correctness of -the arguments. -.TP -\fB-h|--help\fR -Print a summary of command line options. -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer -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 log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day to day running - it generates a small amount of -information about operations carried out. - -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. - -Note that specifying this parameter here will -override the log -level file. -.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. +\fB-h\fR +Print usage information on the \fBsmbcacls +\fR program. .SH "ACL FORMAT" .PP The format of an ACL is one or more ACL entries separated by @@ -130,6 +85,7 @@ REVISION:<revision number> OWNER:<sid or name> GROUP:<sid or name> ACL:<sid or name>:<type>/<flags>/<mask> + .fi .PP The revision of the ACL specifies the internal Windows @@ -160,7 +116,7 @@ common flags are: #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 @@ -216,7 +172,8 @@ of 1 is returned. If there was an error parsing any command line arguments, an exit status of 2 is returned. .SH "VERSION" .PP -This man page is correct for version 3.0 of the Samba suite. +This man page is correct for version 2.2 of +the Samba suite. .SH "AUTHOR" .PP The original Samba software and related utilities @@ -228,5 +185,4 @@ to the way the Linux kernel is developed. and Tim Potter. .PP The conversion to DocBook for Samba 2.2 was done -by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done -by Alexander Bokovoy. +by Gerald Carter diff --git a/docs/manpages/smbclient.1 b/docs/manpages/smbclient.1 index 0b6a5a4679..e5785acaf5 100644 --- a/docs/manpages/smbclient.1 +++ b/docs/manpages/smbclient.1 @@ -3,21 +3,20 @@ .\" <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" "07 april 2003" "" "" - +.TH "SMBCLIENT" "1" "04 March 2003" "" "" .SH NAME smbclient \- ftp-like client to access SMB/CIFS resources on servers .SH SYNOPSIS -\fBsmbclient\fR \fBservicename\fR [ \fBpassword\fR ] [ \fB-b <buffer size>\fR ] [ \fB-d debuglevel\fR ] [ \fB-D Directory\fR ] [ \fB-U username\fR ] [ \fB-W workgroup\fR ] [ \fB-M <netbios name>\fR ] [ \fB-m maxprotocol\fR ] [ \fB-A authfile\fR ] [ \fB-N\fR ] [ \fB-l logfile\fR ] [ \fB-L <netbios name>\fR ] [ \fB-I destinationIP\fR ] [ \fB-E\fR ] [ \fB-c <command string>\fR ] [ \fB-i scope\fR ] [ \fB-O <socket options>\fR ] [ \fB-p port\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-T<c|x>IXFqgbNan\fR ] [ \fB-k\fR ] +\fBsmbclient\fR \fBservicename\fR [ \fBpassword\fR ] [ \fB-b <buffer size>\fR ] [ \fB-d debuglevel\fR ] [ \fB-D Directory\fR ] [ \fB-U username\fR ] [ \fB-W workgroup\fR ] [ \fB-M <netbios name>\fR ] [ \fB-m maxprotocol\fR ] [ \fB-A authfile\fR ] [ \fB-N\fR ] [ \fB-l logfile\fR ] [ \fB-L <netbios name>\fR ] [ \fB-I destinationIP\fR ] [ \fB-E\fR ] [ \fB-c <command string>\fR ] [ \fB-i scope\fR ] [ \fB-O <socket options>\fR ] [ \fB-p port\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-T<c|x>IXFqgbNan\fR ] .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) 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 -similar to that of the ftp program (see \fBftp\fR(1)). +similar to that of the ftp program (see \fBftp(1)\fR). Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server @@ -42,8 +41,7 @@ same as the IP hostname of the machine running the server. The server name is looked up according to either the \fI-R\fR parameter to \fBsmbclient\fR or -using the name resolve order parameter in -the \fBsmb.conf\fR(5) file, +using the name resolve order parameter in the \fIsmb.conf\fR file, allowing an administrator to change the order and methods by which server names are looked up. .TP @@ -67,6 +65,15 @@ or mixed case passwords may be rejected by these servers. Be cautious about including passwords in scripts. .TP +\fB-s smb.conf\fR +Specifies the location of the all important +\fIsmb.conf\fR file. +.TP +\fB-O socket options\fR +TCP socket options to set on the client +socket. See the socket options parameter in the \fI smb.conf (5)\fR manpage for the list of valid +options. +.TP \fB-R <name resolve order>\fR This option is used by the programs in the Samba suite to determine what naming services and in what order to resolve @@ -74,18 +81,17 @@ host names to IP addresses. The option takes a space-separated string of different name resolution options. The options are :"lmhosts", "host", "wins" and "bcast". They -cause names to be resolved as follows: +cause names to be resolved as follows : .RS .TP 0.2i \(bu -lmhosts: Lookup an IP +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 \fBlmhosts\fR(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 -host: Do a standard host +host : Do a standard host name to IP address resolution, using 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 @@ -95,13 +101,13 @@ type being queried is the 0x20 (server) name type, otherwise it is ignored. .TP 0.2i \(bu -wins: Query a name with +wins : Query a name with the IP address listed in the \fIwins server\fR parameter. If no WINS server has been specified this method will be ignored. .TP 0.2i \(bu -bcast: Do a broadcast on +bcast : Do a broadcast on each of the known local interfaces listed in the \fIinterfaces\fR parameter. This is the least reliable of the name resolution @@ -110,12 +116,12 @@ connected subnet. .RE If this parameter is not set then the name resolve order -defined in the \fBsmb.conf\fR(5) file parameter +defined in the \fIsmb.conf\fR file parameter (name resolve order) will be used. The default order is lmhosts, host, wins, bcast and without this parameter or any entry in the \fIname resolve order -\fR parameter of the \fBsmb.conf\fR(5) file the name resolution +\fR parameter of the \fIsmb.conf\fR file the name resolution methods will be attempted in this order. .TP \fB-M NetBIOS name\fR @@ -141,13 +147,64 @@ You may also find the \fI-U\fR and \fI-I\fR options useful, as they allow you to control the FROM and TO parts of the message. -See the \fImessage command\fR parameter in the \fBsmb.conf\fR(5) for a description of how to handle incoming +See the message command parameter in the \fI smb.conf(5)\fR for a description of how to handle incoming WinPopup messages in Samba. \fBNote\fR: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive messages. .TP +\fB-i scope\fR +This specifies a NetBIOS scope that smbclient will +use to communicate with when generating NetBIOS names. For details +on the use of NetBIOS scopes, see \fIrfc1001.txt\fR +and \fIrfc1002.txt\fR. +NetBIOS scopes are \fBvery\fR rarely used, only set +this parameter if you are the system administrator in charge of all +the NetBIOS systems you communicate with. +.TP +\fB-N\fR +If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. + +Unless a password is specified on the command line or +this parameter is specified, the client will request a +password. +.TP +\fB-n NetBIOS name\fR +By default, the client will use the local +machine's hostname (in uppercase) as its NetBIOS name. This parameter +allows you to override the host name and use whatever NetBIOS +name you wish. +.TP +\fB-d debuglevel\fR +\fIdebuglevel\fR is an integer from 0 to 10, or +the letter 'A'. + +The default value if this parameter is not specified +is zero. + +The higher this value, the more detail will be logged to +the log files about the activities of the +client. At level 0, only critical errors and serious warnings will +be logged. Level 1 is a reasonable level for day to day running - +it generates a small amount of information about operations +carried out. + +Levels above 1 will generate considerable amounts of log +data, and should only be used when investigating a problem. +Levels above 3 are designed for use only by developers and +generate HUGE amounts of log data, most of which is extremely +cryptic. If \fIdebuglevel\fR is set to the letter 'A', then \fBall +\fR debug messages will be printed. This setting +is for developers only (and people who \fBreally\fR want +to know how the code works internally). + +Note that specifying this parameter here will override +the log level parameter in the \fIsmb.conf (5)\fR +file. +.TP \fB-p port\fR This number is the TCP port number that will be used when making connections to the server. The standard (well-known) @@ -167,8 +224,8 @@ would be \fIlog.client\fR. The log file generated is never removed by the client. .TP -\fB-h|--help\fR -Print a summary of command line options. +\fB-h\fR +Print the usage message for the client. .TP \fB-I IP-address\fR \fIIP address\fR is the address of the server to connect to. @@ -194,6 +251,53 @@ output stream. By default, the client writes messages to standard output - typically the user's tty. .TP +\fB-U username[%pass]\fR +Sets the SMB username or username and password. +If %pass is not specified, The user will be prompted. The client +will first check the \fBUSER\fR environment variable, then the +\fBLOGNAME\fR variable and if either exists, the +string is uppercased. Anything in these variables following a '%' +sign will be treated as the password. If these environment +variables are not found, the username GUEST +is used. + +If the password is not included in these environment +variables (using the %pass syntax), \fBsmbclient\fR will look for +a \fBPASSWD\fR environment variable from which +to read the password. + +A third option is to use a credentials file which +contains the plaintext of the domain name, username and password. This +option is mainly provided for scripts where the admin doesn't +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 +\fI-A\fR for more details. + +Be cautious about including passwords in scripts or in +the \fBPASSWD\fR environment variable. Also, on +many systems the command line of a running process may be seen +via the \fBps\fR command to be safe always allow +\fBsmbclient\fR to prompt for a password and type +it in directly. +.TP +\fB-A filename\fR +This option allows +you to specify a file from which to read the username, domain name, and +password used in the connection. The format of the file is + + +.nf +username = <value> +password = <value> +domain = <value> + +.fi + +If the domain parameter is missing the current workgroup name +is used instead. Make certain that the permissions on the file restrict +access from unwanted users. +.TP \fB-L\fR This option allows you to look at what services are available on a server. You use it as \fBsmbclient -L @@ -221,127 +325,11 @@ size when getting or putting a file from/to the server. The default is 65520 bytes. Setting this value smaller (to 1200 bytes) has been observed to speed up file transfers to and from a Win9x server. .TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer -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 log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day to day running - it generates a small amount of -information about operations carried out. - -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. - -Note that specifying this parameter here will -override the log -level file. -.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. -.TP -\fB-N\fR -If specified, this parameter suppresses the normal -password prompt from the client to the user. This is useful when -accessing a service that does not require a password. - -Unless a password is specified on the command line or -this parameter is specified, the client will request a -password. -.TP -\fB-k\fR -Try to authenticate with kerberos. Only useful in -an Active Directory environment. -.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 - - -.nf -username = <value> -password = <value> -domain = <value> -.fi - -Make certain that the permissions on the file restrict -access from unwanted users. -.TP -\fB-U|--user=username[%password]\fR -Sets the SMB username or username and password. - -If %password is not specified, the user will be prompted. The -client will first check the \fBUSER\fR environment variable, then the -\fBLOGNAME\fR variable and if either exists, the -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 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 -\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 -\fBrpcclient\fR to prompt for a password and type -it in directly. -.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 \fINetBIOS -name\fR parameter in the \fBsmb.conf\fR(5) file. However, a command -line setting will take precedence over settings in -\fBsmb.conf\fR(5). -.TP -\fB-i <scope>\fR -This specifies a NetBIOS scope that -\fBnmblookup\fR will use to communicate with when -generating NetBIOS names. For details on the use of NetBIOS -scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are -\fBvery\fR rarely used, only set this parameter -if you are the system administrator in charge of all the -NetBIOS systems you communicate with. -.TP -\fB-W|--workgroup=domain\fR -Set the SMB domain of the username. This -overrides the default domain which is the domain defined in -smb.conf. If the domain specified is the same as the servers -NetBIOS name, it causes the client to log on using the servers local -SAM (as opposed to the Domain SAM). -.TP -\fB-O socket options\fR -TCP socket options to set on the client -socket. See the socket options parameter in -the \fBsmb.conf\fR(5) manual page for the list of valid -options. +\fB-W WORKGROUP\fR +Override the default workgroup (domain) specified +in the workgroup parameter of the \fIsmb.conf\fR +file for this connection. This may be needed to connect to some +servers. .TP \fB-T tar options\fR smbclient may be used to create \fBtar(1) @@ -425,7 +413,7 @@ files in the archive with relative names, not absolute names. \fBTar Filenames\fR -All file names can be given as DOS path names (with '\\\\' +All file names can be given as DOS path names (with '\\' as the component separator) or as UNIX path names (with '/' as the component separator). @@ -476,7 +464,7 @@ a prompt : .PP smb:\\> .PP -The backslash ("\\\\") indicates the current working directory +The backslash ("\\") indicates the current working directory on the server, and will change if the current working directory is changed. .PP @@ -778,7 +766,8 @@ The client log files should be put in a directory readable and writeable only by the user. .PP To test the client, you will need to know the name of a -running SMB/CIFS server. It is possible to run \fBsmbd\fR(8) as an ordinary user - running that server as a daemon +running SMB/CIFS server. It is possible to run \fBsmbd(8) +\fR as an ordinary user - running that server as a daemon on a user-accessible port (typically any port number over 1024) would provide a suitable test server. .SH "DIAGNOSTICS" @@ -792,7 +781,8 @@ on the debug level used by the client. If you have problems, set the debug level to 3 and peruse the log files. .SH "VERSION" .PP -This man page is correct for version 2.2 of the Samba suite. +This man page is correct for version 2.2 of +the Samba suite. .SH "AUTHOR" .PP The original Samba software and related utilities @@ -802,7 +792,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 -was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbcontrol.1 b/docs/manpages/smbcontrol.1 index 14ce9f5812..d69e0978a4 100644 --- a/docs/manpages/smbcontrol.1 +++ b/docs/manpages/smbcontrol.1 @@ -3,38 +3,27 @@ .\" <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" "07 april 2003" "" "" - +.TH "SMBCONTROL" "1" "04 March 2003" "" "" .SH NAME smbcontrol \- send messages to smbd, nmbd or winbindd processes .SH SYNOPSIS -\fBsmbcontrol\fR [ \fB-i\fR ] [ \fB-s\fR ] +\fBsmbcontrol\fR [ \fB-i\fR ] \fBsmbcontrol\fR [ \fBdestination\fR ] [ \fBmessage-type\fR ] [ \fBparameter\fR ] .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP \fBsmbcontrol\fR is a very small program, which -sends messages to a \fBsmbd\fR(8), a \fBnmbd\fR(8), or a \fBwinbindd\fR(8) daemon running on the system. +sends messages to an smbd(8) +an nmbd(8) +or a winbindd(8) +daemon running on the system. .SH "OPTIONS" .TP -\fB-h|--help\fR -Print a summary of command line options. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP \fB-i\fR Run interactively. Individual commands of the form destination message-type parameters can be entered @@ -42,7 +31,8 @@ on STDIN. An empty command line or a "q" will quit the program. .TP \fBdestination\fR -One of \fInmbd\fR, \fIsmbd\fR or a process ID. +One of \fInmbd\fR +\fIsmbd\fR or a process ID. The \fIsmbd\fR destination causes the message to "broadcast" to all smbd daemons. @@ -55,56 +45,57 @@ If a single process ID is given, the message is sent to only that process. .TP \fBmessage-type\fR -Type of message to send. See -the section MESSAGE-TYPES for details. -.TP -\fBparameters\fR -any parameters required for the message-type -.SH "MESSAGE-TYPES" -.PP -Available message types are: -.TP -\fBclose-share\fR -Order smbd to close the client -connections to the named share. Note that this doesn't affect client -connections to any other shares. This message-type takes an argument of the +One of: close-share, +debug, +force-election, ping +, profile, debuglevel, profilelevel, +or printnotify. + +The close-share message-type sends a +message to smbd which will then close the client connections to +the named share. Note that this doesn't affect client connections +to any other shares. This message-type takes an argument of the share name for which client connections will be closed, or the "*" character which will close all currently open shares. This may be useful if you made changes to the access controls on the share. This message can only be sent to smbd. -.TP -\fBdebug\fR -Set debug level to the value specified by the + +The debug message-type allows +the debug level to be set to the value specified by the parameter. This can be sent to any of the destinations. -.TP -\fBforce-election\fR -This message causes the \fBnmbd\fR daemon to -force a new browse master election. -.TP -\fBping\fR -Send specified number of "ping" messages and -wait for the same number of reply "pong" messages. This can be sent to + +The force-election message-type can only be +sent to the nmbd destination. This message +causes the \fBnmbd\fR daemon to force a new browse +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 any of the destinations. -.TP -\fBprofile\fR -Change profile settings of a daemon, based on the + +The profile message-type sends a +message to an smbd to change the profile settings based on the parameter. The parameter can be "on" to turn on profile stats collection, "off" to turn off profile stats collection, "count" to enable only collection of count stats (time stats are disabled), and "flush" to zero the current profile stats. This can be sent to any smbd or nmbd destinations. -.TP -\fBdebuglevel\fR -Request debuglevel of a certain daemon and write it to stdout. This -can be sent to any of the destinations. -.TP -\fBprofilelevel\fR -Request profilelevel of a certain daemon and write it to stdout. -This can be sent to any smbd or nmbd destinations. -.TP -\fBprintnotify\fR -Order smbd to send a printer notify message to any Windows NT clients -connected to a printer. This message-type takes the following arguments: + +The debuglevel message-type sends +a "request debug level" message. The current debug level setting +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 +to any smbd or nmbd destinations. + +The printnotify message-type sends a +message to smbd which in turn sends a printer notify message to +any Windows NT clients connected to a printer. This message-type +takes the following arguments: .RS .TP \fBqueuepause printername\fR @@ -130,50 +121,21 @@ Send a job delete change notify message for the printer and unix jobid specified. .RE - Note that this message only sends notification that an event has occured. It doesn't actually cause the event to happen. - This message can only be sent to smbd. .TP -\fBsamsync\fR -Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to smbd. -.sp -.RS -.B "Note:" -Not working at the moment -.RE -.TP -\fBsamrepl\fR -Send sam replication message, with specified serial. Can only be sent to smbd. Should not be used manually. -.TP -\fBdmalloc-mark\fR -Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. -.TP -\fBdmalloc-log-changed\fR -Dump the pointers that have changed since the mark set by dmalloc-mark. -Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. -.TP -\fBshutdown\fR -Shut down specified daemon. Can be sent to both smbd and nmbd. -.TP -\fBpool-usage\fR -Print a human-readable description of all -talloc(pool) memory usage by the specified daemon/process. Available -for both smbd and nmbd. -.TP -\fBdrvupgrade\fR -Force clients of printers using specified driver -to update their local version of the driver. Can only be -sent to smbd. +\fBparameters\fR +any parameters required for the message-type .SH "VERSION" .PP -This man page is correct for version 3.0 of +This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP -\fBnmbd\fR(8) and \fBsmbd\fR(8). +\fBnmbd(8)\fR +and \fBsmbd(8)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -183,7 +145,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for -Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbd.8 b/docs/manpages/smbd.8 index e5139967e8..106c0a98e3 100644 --- a/docs/manpages/smbd.8 +++ b/docs/manpages/smbd.8 @@ -3,8 +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 "SMBD" "8" "07 april 2003" "" "" - +.TH "SMBD" "8" "04 March 2003" "" "" .SH NAME smbd \- server to provide SMB/CIFS services to clients .SH SYNOPSIS @@ -13,7 +12,7 @@ smbd \- server to provide SMB/CIFS services to clients .SH "DESCRIPTION" .PP -This program is part of the \fBSamba\fR(7) suite. +This program is part of the Samba suite. .PP \fBsmbd\fR is the server daemon that provides filesharing and printing services to Windows clients. @@ -27,12 +26,14 @@ OS/2, DAVE for Macintosh, and smbfs for Linux. 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 \fBsmb.conf\fR(5). This man page will not describe the +services (see \fIsmb.conf(5) +\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 \fBsmb.conf\fR(5) manual page should be regarded as mandatory reading before +implications to running this server, and the \fIsmb.conf(5)\fR +manpage should be regarded as mandatory reading before proceeding with installation. .PP A session is created whenever a client requests one. @@ -85,21 +86,19 @@ command line. \fBsmbd\fR also logs to standard output, as if the \fB-S\fR parameter had been given. .TP +\fB-h\fR +Prints the help information (usage) +for \fBsmbd\fR. +.TP \fB-V\fR Prints the version number for \fBsmbd\fR. .TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. +\fB-b\fR +Prints information about how +Samba was built. .TP -\fB-d|--debug=debuglevel\fR +\fB-d <debug level>\fR \fIdebuglevel\fR is an integer from 0 to 10. The default value if this parameter is not specified is zero. @@ -121,18 +120,6 @@ Note that specifying this parameter here will override the log level file. .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. -.TP -\fB-h|--help\fR -Print a summary of command line options. -.TP -\fB-b\fR -Prints information about how -Samba was built. -.TP \fB-l <log directory>\fR If specified, \fIlog directory\fR @@ -140,14 +127,19 @@ specifies a log directory into which the "log.smbd" log 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 \fImax log size\fR -option in the \fBsmb.conf\fR(5) file. \fBBeware:\fR +its size may be controlled by the max log size +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. The default log directory is specified at compile time. .TP +\fB-O <socket options>\fR +See the socket options +parameter in the \fIsmb.conf(5) +\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 @@ -170,13 +162,23 @@ section 4.3.5. This parameter is not normally specified except in the above situation. +.TP +\fB-s <configuration file>\fR +The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See \fI smb.conf(5)\fR for more information. +The default configuration file name is determined at +compile time. .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 "How to Install and Test SAMBA" +meta-daemon. See the UNIX_INSTALL.html document for details. .TP \fB\fI/etc/rc\fB\fR @@ -185,7 +187,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 "How to Install and Test SAMBA" +sequence for the server. See the UNIX_INSTALL.html document for details. .TP \fB\fI/etc/services\fB\fR @@ -193,16 +195,18 @@ If running the server via the meta-daemon \fBinetd\fR, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). -See the "How to Install and Test SAMBA" +See the UNIX_INSTALL.html document for details. .TP \fB\fI/usr/local/samba/lib/smb.conf\fB\fR -This is the default location of the \fBsmb.conf\fR(5) server configuration file. Other common places that systems +This is the default location of the +\fIsmb.conf\fR +server configuration file. Other common places that systems install this file are \fI/usr/samba/lib/smb.conf\fR -and \fI/etc/samba/smb.conf\fR. +and \fI/etc/smb.conf\fR. This file describes all the services the server -is to make available to clients. See \fBsmb.conf\fR(5) for 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 @@ -225,8 +229,9 @@ is not specific to the server, however. Samba uses PAM for authentication (when presented with a plaintext password), for account checking (is this account disabled?) and for session management. The degree too which samba supports PAM is restricted -by the limitations of the SMB protocol and the \fIobey -pam restricions\fR \fBsmb.conf\fR(5) paramater. When this is set, the following restrictions apply: +by the limitations of the SMB protocol and the +obey pam restricions +smb.conf paramater. When this is set, the following restrictions apply: .TP 0.2i \(bu \fBAccount Validation\fR: All accesses to a @@ -274,8 +279,9 @@ an \fBsmbd\fR is to send it a SIGTERM (-15) signal and wait for it to die on its own. .PP The debug log level of \fBsmbd\fR may be raised -or lowered using \fBsmbcontrol\fR(1) program (SIGUSR[1|2] signals are no longer -used since Samba 2.2). This is to allow transient problems to be diagnosed, +or lowered using \fBsmbcontrol(1) +\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 Note that as the signal handlers send a debug write, @@ -286,8 +292,12 @@ by un-blocking the signals before the select call and re-blocking them after, however this would affect performance. .SH "SEE ALSO" .PP -\fBhosts_access\fR(5), \fBinetd\fR(8), \fBnmbd\fR(8), \fBsmb.conf\fR(5), \fBsmbclient\fR(1), \fBtestparm\fR(1), \fBtestprns\fR(1), and the -Internet RFC's \fIrfc1001.txt\fR, \fIrfc1002.txt\fR. +hosts_access(5), \fBinetd(8)\fR, +\fBnmbd(8)\fR +\fIsmb.conf(5)\fR + \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 http://samba.org/cifs/ <URL:http://samba.org/cifs/>. @@ -300,7 +310,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for -Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbgroupedit.8 b/docs/manpages/smbgroupedit.8 index cb3ce954c9..41b4872798 100644 --- a/docs/manpages/smbgroupedit.8 +++ b/docs/manpages/smbgroupedit.8 @@ -3,8 +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 "SMBGROUPEDIT" "8" "07 april 2003" "" "" - +.TH "SMBGROUPEDIT" "8" "04 March 2003" "" "" .SH NAME smbgroupedit \- Query/set/change UNIX - Windows NT group mapping .SH SYNOPSIS @@ -13,7 +12,8 @@ smbgroupedit \- Query/set/change UNIX - Windows NT group mapping .SH "DESCRIPTION" .PP -This program is part of the \fBSamba\fR(7) suite. +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 @@ -39,7 +39,8 @@ give a long listing, of the format: Privilege : .fi -For example: +For examples, + .nf Users @@ -58,7 +59,8 @@ display a short listing of the format: NTGroupName(SID) -> UnixGroupName .fi -For example: +For example, + .nf Users (S-1-5-32-545) -> -1 @@ -92,7 +94,8 @@ map this domadm group to the 'domain admins' group: .RS .TP 3 1. -Get the SID for the Windows NT "Domain Admins" group: +Get the SID for the Windows NT "Domain Admins" +group: .nf @@ -104,6 +107,7 @@ Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> -1 map the unix domadm group to the Windows NT "Domain Admins" group, by running the command: + .nf root# \fBsmbgroupedit \\ -c S-1-5-21-1108995562-3116817432-1375597819-512 \\ @@ -115,6 +119,7 @@ Domain Admins SID (the S-1-5-21-...-512) is different for every PDC. .RE .PP To verify that your mapping has taken effect: +.PP .nf root# \fBsmbgroupedit -vs|grep "Domain Admins"\fR @@ -124,6 +129,7 @@ Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> domadm 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 .nf root# \fBsmbgroupedit -a unixgroup -td\fR @@ -134,7 +140,7 @@ This man page is correct for the 3.0alpha releases of the Samba suite. .SH "SEE ALSO" .PP -\fBsmb.conf\fR(5) +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -144,5 +150,4 @@ to the way the Linux kernel is developed. .PP \fBsmbgroupedit\fR was written by Jean Francois Micouleau. The current set of manpages and documentation is maintained -by the Samba Team in the same fashion as the Samba source code. The conversion -to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. +by the Samba Team in the same fashion as the Samba source code. diff --git a/docs/manpages/smbmnt.8 b/docs/manpages/smbmnt.8 index c81428e3d7..e8e8562a12 100644 --- a/docs/manpages/smbmnt.8 +++ b/docs/manpages/smbmnt.8 @@ -3,13 +3,12 @@ .\" <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" "07 april 2003" "" "" - +.TH "SMBMNT" "8" "04 March 2003" "" "" .SH NAME smbmnt \- helper utility for mounting SMB filesystems .SH SYNOPSIS -\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 ] [ \fB-h\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 @@ -22,7 +21,8 @@ A setuid smbmnt will only allow mounts on directories owned by the user, and that the user has write permission on. .PP The \fBsmbmnt\fR program is normally invoked -by \fBsmbmount\fR(8). It should not be invoked directly by users. +by \fBsmbmount(8)\fR + 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. @@ -49,9 +49,6 @@ applied \fB-o options\fR list of options that are passed as-is to smbfs, if this command is run on a 2.4 or higher Linux kernel. -.TP -\fB-h|--help\fR -Print a summary of command line options. .SH "AUTHOR" .PP Volker Lendecke, Andrew Tridgell, Michael H. Warfield @@ -64,5 +61,4 @@ The SAMBA Mailing list <URL:mailto:samba@samba.org> is the preferred place to ask questions regarding these programs. .PP The conversion of this manpage for Samba 2.2 was performed -by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 -was done by Alexander Bokovoy. +by Gerald Carter diff --git a/docs/manpages/smbmount.8 b/docs/manpages/smbmount.8 index 2f158c3074..8d7dfd8d22 100644 --- a/docs/manpages/smbmount.8 +++ b/docs/manpages/smbmount.8 @@ -3,8 +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 "SMBMOUNT" "8" "07 april 2003" "" "" - +.TH "SMBMOUNT" "8" "04 March 2003" "" "" .SH NAME smbmount \- mount an smbfs filesystem .SH SYNOPSIS @@ -15,7 +14,7 @@ smbmount \- mount an smbfs filesystem .PP \fBsmbmount\fR mounts a Linux SMB filesystem. It is usually invoked as \fBmount.smbfs\fR by -the \fBmount\fR(8) command when using the +the \fBmount(8)\fR command when using the "-t smbfs" option. This command only works in Linux, and the kernel must support the smbfs filesystem. .PP @@ -28,10 +27,11 @@ unknown options. \fBsmbmount\fR is a daemon. After mounting it keeps running until the mounted smbfs is umounted. It will log things that happen when in daemon mode using the "machine name" smbmount, so -typically this output will end up in \fIlog.smbmount\fR. The \fB smbmount\fR process may also be called mount.smbfs. +typically this output will end up in \fIlog.smbmount\fR. The +\fBsmbmount\fR process may also be called mount.smbfs. .PP \fBNOTE:\fR \fBsmbmount\fR -calls \fBsmbmnt\fR(8) to do the actual mount. You +calls \fBsmbmnt(8)\fR to do the actual mount. You must make sure that \fBsmbmnt\fR is in the path so that it can be found. .SH "OPTIONS" @@ -58,21 +58,20 @@ in the PASSWD environment variable or a credentials file (see below) will be read correctly. .TP \fBcredentials=<filename>\fR -specifies a file that contains a username and/or password. -The format of the file is: +specifies a file that contains a username +and/or password. The format of the file is: + .nf -username = <value> -password = <value> + username = <value> + password = <value> + .fi This is preferred over having passwords in plaintext in a shared file, such as \fI/etc/fstab\fR. Be sure to protect any credentials file properly. .TP -\fBkrb\fR -Use kerberos (Active Directory). -.TP \fBnetbiosname=<arg>\fR sets the source NetBIOS name. It defaults to the local hostname. @@ -98,30 +97,31 @@ permissions that remote files have in the local filesystem. The default is based on the current umask. .TP \fBdmask=<arg>\fR -Sets the directory mask. This determines the +sets the directory mask. This determines the permissions that remote directories have in the local filesystem. The default is based on the current umask. .TP \fBdebug=<arg>\fR -Sets the debug level. This is useful for +sets the debug level. This is useful for tracking down SMB connection problems. A suggested value to start with is 4. If set too high there will be a lot of output, possibly hiding the useful output. .TP \fBip=<arg>\fR -Sets the destination host or IP address. +sets the destination host or IP address. .TP \fBworkgroup=<arg>\fR -Sets the workgroup on the destination +sets the workgroup on the destination .TP \fBsockopt=<arg>\fR -Sets the TCP socket options. See the \fBsmb.conf\fR(5) \fIsocket options\fR option. +sets the TCP socket options. See the \fIsmb.conf +\fR \fIsocket options\fR option. .TP \fBscope=<arg>\fR -Sets the NetBIOS scope +sets the NetBIOS scope .TP \fBguest\fR -Don't prompt for a password +don't prompt for a password .TP \fBro\fR mount read-only @@ -196,8 +196,10 @@ source tree may contain additional options and information. .PP 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\fR(1) or at other solutions, such as -Sharity or perhaps replacing the SMB server with a NFS server. +For Solaris, HP-UX and others you may want to look at +\fBsmbsh(1)\fR or at other +solutions, such as sharity or perhaps replacing the SMB server with +a NFS server. .SH "AUTHOR" .PP Volker Lendecke, Andrew Tridgell, Michael H. Warfield @@ -210,5 +212,4 @@ The SAMBA Mailing list <URL:mailto:samba@samba.org> is the preferred place to ask questions regarding these programs. .PP The conversion of this manpage for Samba 2.2 was performed -by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 -was done by Alexander Bokovoy. +by Gerald Carter diff --git a/docs/manpages/smbpasswd.5 b/docs/manpages/smbpasswd.5 index 9d1ee8e275..07b04530c3 100644 --- a/docs/manpages/smbpasswd.5 +++ b/docs/manpages/smbpasswd.5 @@ -3,8 +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 "SMBPASSWD" "5" "07 april 2003" "" "" - +.TH "SMBPASSWD" "5" "04 March 2003" "" "" .SH NAME smbpasswd \- The Samba encrypted password file .SH SYNOPSIS @@ -12,7 +11,7 @@ smbpasswd \- The Samba encrypted password file \fIsmbpasswd\fR .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +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 @@ -96,7 +95,7 @@ This section contains flags that describe the attributes of the users account. In the Samba 2.2 release this field is bracketed by '[' and ']' characters and is always 13 characters in length (including the '[' and ']' characters). -The contents of this field may be any of the following characters: +The contents of this field may be any of the characters. .RS .TP 0.2i \(bu @@ -109,11 +108,13 @@ 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 \fBsmb.conf\fR(5) config 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 this user. +is disabled and no SMB/CIFS logins will be allowed for +this user. .TP 0.2i \(bu \fBW\fR - This means this account @@ -138,7 +139,8 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbpasswd\fR(8), \fBSamba\fR(7), and +\fBsmbpasswd(8)\fR +samba(7) and the Internet RFC1321 for details on the MD4 algorithm. .SH "AUTHOR" .PP @@ -149,7 +151,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbpasswd.8 b/docs/manpages/smbpasswd.8 index 500c3b37da..5c7b16c2e9 100644 --- a/docs/manpages/smbpasswd.8 +++ b/docs/manpages/smbpasswd.8 @@ -3,8 +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 "SMBPASSWD" "8" "07 april 2003" "" "" - +.TH "SMBPASSWD" "8" "04 March 2003" "" "" .SH NAME smbpasswd \- change a user's SMB password .SH SYNOPSIS @@ -13,23 +12,24 @@ smbpasswd \- change a user's SMB password .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +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 user -or not. When run as a normal user it allows the user to change +functions, depending on whether it is run by the \fBroot\fR +user or not. When run as a normal user it allows the user to change the password used for their SMB sessions on any machines that store SMB passwords. .PP By default (when run with no arguments) it will attempt to change the current user's SMB password on the local machine. This is -similar to the way the \fBpasswd(1)\fR program works. \fB smbpasswd\fR differs from how the passwd program works +similar to the way the \fBpasswd(1)\fR program works. +\fBsmbpasswd\fR differs from how the passwd program works however in that it is not \fBsetuid root\fR but works in -a client-server mode and communicates with a -locally running \fBsmbd\fR(8). As a consequence in order for this to +a client-server mode and communicates with a locally running +\fBsmbd(8)\fR. As a consequence in order for this to succeed the smbd daemon must be running on the local machine. On a UNIX machine the encrypted SMB passwords are usually stored in -the \fBsmbpasswd\fR(5) file. +the \fIsmbpasswd(5)\fR file. .PP When run by an ordinary user with no options, smbpasswd will prompt them for their old SMB password and then ask them @@ -41,12 +41,12 @@ 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 (\fI-r\fR) and \fI-U\fR 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 -the attributes of the user in this file to be made. When run by root, \fB smbpasswd\fR accesses the local smbpasswd file +the attributes of the user in this file to be made. When run by root, +\fBsmbpasswd\fR accesses the local smbpasswd file directly, thus enabling changes to be made even if smbd is not running. .SH "OPTIONS" @@ -82,7 +82,8 @@ 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\fR(5) for details on the 'old' and new password file formats. +this information and the command will FAIL. See \fBsmbpasswd(5) +\fR for details on the 'old' and new password file formats. This option is only available when running smbpasswd as root. @@ -95,7 +96,7 @@ 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. -See \fBsmbpasswd\fR(5) for +See \fBsmbpasswd (5)\fR for details on the 'old' and new password file formats. This option is only available when running smbpasswd as root. @@ -163,17 +164,17 @@ 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: +cause names to be resolved as follows : .RS .TP 0.2i \(bu -lmhosts: Lookup an IP +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 \fBlmhosts\fR(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 -host: Do a standard host +host : Do a standard host 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 @@ -183,13 +184,13 @@ type being queried is the 0x20 (server) name type, otherwise it is ignored. .TP 0.2i \(bu -wins: Query a name with +wins : Query a name with the IP address listed in the \fIwins server\fR parameter. If no WINS server has been specified this method will be ignored. .TP 0.2i \(bu -bcast: Do a broadcast on +bcast : Do a broadcast on each of the known local interfaces listed in the \fIinterfaces\fR parameter. This is the least reliable of the name resolution methods as it depends on the @@ -197,7 +198,8 @@ target host being on a locally connected subnet. .RE The default order is \fBlmhosts, host, wins, bcast\fR -and without this parameter or any entry in the \fBsmb.conf\fR(5) file the name resolution methods will +and without this parameter or any entry in the +\fIsmb.conf\fR file the name resolution methods will be attempted in this order. .TP \fB-m\fR @@ -233,7 +235,7 @@ has been configured to use the experimental switch is used to specify the password to be used with the \fIldap admin dn\fR Note that the password is stored in -the \fIsecrets.tdb\fR and is keyed off +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 need to be manually updated as well. @@ -259,20 +261,23 @@ to modify attributes directly in the local smbpasswd file. Since \fBsmbpasswd\fR works in client-server mode communicating with a local smbd for a non-root user then the smbd daemon must be running for this to work. A common problem -is to add a restriction to the hosts that may access the \fB smbd\fR running on the local machine by specifying either \fIallow -hosts\fR or \fIdeny hosts\fR entry in -the \fBsmb.conf\fR(5) file and neglecting to +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 +entry in the \fIsmb.conf\fR file and neglecting to allow "localhost" access to the smbd. .PP In addition, the smbpasswd command is only useful if Samba -has been set up to use encrypted passwords. See the document "LanMan and NT Password Encryption in Samba" in the docs directory for details +has been set up to use encrypted passwords. See the file +\fIENCRYPTION.txt\fR in the docs directory for details on how to do this. .SH "VERSION" .PP -This man page is correct for version 3.0 of the Samba suite. +This man page is correct for version 3.0 of +the Samba suite. .SH "SEE ALSO" .PP -\fBsmbpasswd\fR(5), \fBSamba\fR(7). +\fIsmbpasswd(5)\fR +samba(7) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -282,7 +287,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbsh.1 b/docs/manpages/smbsh.1 index fb7d7e2495..06d27090db 100644 --- a/docs/manpages/smbsh.1 +++ b/docs/manpages/smbsh.1 @@ -3,8 +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 "SMBSH" "1" "07 april 2003" "" "" - +.TH "SMBSH" "1" "04 March 2003" "" "" .SH NAME smbsh \- Allows access to Windows NT filesystem using UNIX commands .SH SYNOPSIS @@ -13,7 +12,7 @@ smbsh \- Allows access to Windows NT filesystem using UNIX commands .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +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 @@ -23,7 +22,7 @@ to work correctly. .TP \fB-W WORKGROUP\fR Override the default workgroup specified in the -workgroup parameter of the \fBsmb.conf\fR(5) file +workgroup parameter of the \fIsmb.conf\fR file for this session. This may be needed to connect to some servers. .TP @@ -39,75 +38,44 @@ the user to set the directory prefix for SMB access. The default value if this option is not specified is \fBsmb\fR. .TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer -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 log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day to day running - it generates a small amount of -information about operations carried out. - -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. - -Note that specifying this parameter here will -override the log -level file. -.TP \fB-R <name resolve order>\fR This option is used to determine what naming services and in what order to resolve host names to IP addresses. The option takes a space-separated string of different name resolution options. -The options are: "lmhosts", "host", "wins" and "bcast". +The options are :"lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows : .RS .TP 0.2i \(bu -lmhosts: +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 \fBlmhosts\fR(5) for details) -then any name type matches for lookup. +(see the lmhosts(5) +for details) then any name type matches for lookup. .TP 0.2i \(bu -host: +host : Do a standard host name to IP address resolution, using 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\fR file). Note that this method is only used +may be controlled by the \fI/etc/nsswitch.conf +\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: +wins : Query a name with the IP address listed in the \fIwins server\fR parameter. If no WINS server has been specified this method will be ignored. .TP 0.2i \(bu -bcast: +bcast : Do a broadcast on each of the known local interfaces listed in the \fIinterfaces\fR parameter. This is the least reliable of the name @@ -116,12 +84,30 @@ being on a locally connected subnet. .RE If this parameter is not set then the name resolve order -defined in the \fBsmb.conf\fR(5) file parameter -(\fIname resolve order\fR) will be used. +defined in the \fIsmb.conf\fR file parameter +(name resolve order) will be used. The default order is lmhosts, host, wins, bcast. Without -this parameter or any entry in the \fIname resolve order\fR parameter of the \fBsmb.conf\fR(5) file, the name resolution methods -will be attempted in this order. +this parameter or any entry in the \fIname resolve order +\fR parameter of the \fIsmb.conf\fR +file, the name resolution methods will be attempted in this +order. +.TP +\fB-d <debug level>\fR +debug level is an integer 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 +about the activities of \fBnmblookup\fR. At level +0, only critical errors and serious warnings will be logged. +.TP +\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 +written to\fIstderr\fR. .TP \fB-L libdir\fR This parameter specifies the location of the @@ -132,11 +118,13 @@ value is specified at compile time. To use the \fBsmbsh\fR command, execute \fB smbsh\fR from the prompt and enter the username and password that authenticates you to the machine running the Windows NT operating system. +.PP .nf -system% \fBsmbsh\fR -Username: \fBuser\fR -Password: \fBXXXXXXX\fR + system% \fBsmbsh\fR + Username: \fBuser\fR + Password: \fBXXXXXXX\fR + .fi .PP Any dynamically linked command you execute from @@ -150,7 +138,8 @@ names for that machine. You could then, for example, use the \fB cd\fR command t edit files, and \fBrcp\fR to copy files. .SH "VERSION" .PP -This man page is correct for version 3.0 of the Samba suite. +This man page is correct for version 3.0 of +the Samba suite. .SH "BUGS" .PP \fBsmbsh\fR works by intercepting the standard @@ -164,7 +153,8 @@ of UNIX have a \fBfile\fR command that will describe how a program was linked. .SH "SEE ALSO" .PP -\fBsmbd\fR(8), \fBsmb.conf\fR(5) +\fBsmbd(8)\fR +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -174,7 +164,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbspool.8 b/docs/manpages/smbspool.8 index 3932d696be..835494b534 100644 --- a/docs/manpages/smbspool.8 +++ b/docs/manpages/smbspool.8 @@ -3,17 +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 "SMBSPOOL" "8" "07 april 2003" "" "" - +.TH "SMBSPOOL" "8" "04 March 2003" "" "" .SH NAME smbspool \- send a print file to an SMB printer .SH SYNOPSIS -\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 \fBSamba\fR(7) suite. +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 @@ -78,10 +77,12 @@ name of the file to print. If this argument is not specified then the print file is read from the standard input. .SH "VERSION" .PP -This man page is correct for version 3.0 of the Samba suite. +This man page is correct for version 2.2 of +the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd\fR(8) and \fBSamba\fR(7). +\fBsmbd(8)\fR +and samba(7) .SH "AUTHOR" .PP \fBsmbspool\fR was written by Michael Sweet @@ -94,7 +95,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbstatus.1 b/docs/manpages/smbstatus.1 index a27efef629..9fb96f1c43 100644 --- a/docs/manpages/smbstatus.1 +++ b/docs/manpages/smbstatus.1 @@ -3,8 +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 "SMBSTATUS" "1" "07 april 2003" "" "" - +.TH "SMBSTATUS" "1" "04 March 2003" "" "" .SH NAME smbstatus \- report on current Samba connections .SH SYNOPSIS @@ -13,7 +12,7 @@ smbstatus \- report on current Samba connections .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP \fBsmbstatus\fR is a very simple program to list the current Samba connections. @@ -27,46 +26,8 @@ shared memory area. \fB-b|--brief\fR gives brief output. .TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer -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 log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day to day running - it generates a small amount of -information about operations carried out. - -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. - -Note that specifying this parameter here will -override the log -level file. -.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. +\fB-d|--debug=<debuglevel>\fR +sets debugging to specified level .TP \fB-v|--verbose\fR gives verbose output. @@ -78,14 +39,17 @@ causes smbstatus to only list locks. causes smbstatus to include byte range locks. .TP \fB-p|--processes\fR -print a list of \fBsmbd\fR(8) processes and exit. +print a list of \fBsmbd(8)\fR processes and exit. Useful for scripting. .TP \fB-S|--shares\fR causes smbstatus to only list shares. .TP -\fB-h|--help\fR -Print a summary of command line options. +\fB-s|--conf=<configuration file>\fR +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. .TP \fB-u|--user=<username>\fR selects information relevant to @@ -96,7 +60,8 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd\fR(8) and \fBsmb.conf\fR(5). +\fBsmbd(8)\fR and +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -106,7 +71,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbtar.1 b/docs/manpages/smbtar.1 index e270cc4b5f..4ed25bbc75 100644 --- a/docs/manpages/smbtar.1 +++ b/docs/manpages/smbtar.1 @@ -3,20 +3,20 @@ .\" <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" "07 april 2003" "" "" - +.TH "SMBTAR" "1" "04 March 2003" "" "" .SH NAME smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives .SH SYNOPSIS -\fBsmbtar\fR [ \fB-r\fR ] [ \fB-i\fR ] [ \fB-a\fR ] [ \fB-v\fR ] \fB-s server\fR [ \fB-p password\fR ] [ \fB-x services\fR ] [ \fB-X\fR ] [ \fB-N filename\fR ] [ \fB-b blocksize\fR ] [ \fB-d directory\fR ] [ \fB-l loglevel\fR ] [ \fB-u user\fR ] [ \fB-t tape\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 \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP \fBsmbtar\fR is a very small shell script on top -of \fBsmbclient\fR(1) which dumps SMB shares directly to tape. +of \fBsmbclient(1)\fR +which dumps SMB shares directly to tape. .SH "OPTIONS" .TP \fB-s server\fR @@ -46,10 +46,6 @@ Default: none The user id to connect as. Default: UNIX login name. .TP -\fB-a\fR -Reset DOS archive bit mode to -indicate file has been archived. -.TP \fB-t tape\fR Tape device. May be regular file or tape device. Default: \fI$TAPE\fR environmental @@ -76,7 +72,8 @@ from the tar file. .TP \fB-l log level\fR Log (debug) level. Corresponds to the -\fI-d\fR flag of \fBsmbclient\fR(1). +\fI-d\fR flag of \fBsmbclient(1) +\fR. .SH "ENVIRONMENT VARIABLES" .PP The \fI$TAPE\fR variable specifies the @@ -94,14 +91,18 @@ 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\fR(1) command. +See the \fBDIAGNOSTICS\fR section for the +\fBsmbclient(1)\fR + command. .SH "VERSION" .PP This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmbd\fR(8), \fBsmbclient\fR(1), \fBsmb.conf\fR(5). +\fBsmbd(8)\fR +\fBsmbclient(1)\fR +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -114,7 +115,7 @@ 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for -Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter. diff --git a/docs/manpages/smbumount.8 b/docs/manpages/smbumount.8 index 9e8daa81be..4c3688d63f 100644 --- a/docs/manpages/smbumount.8 +++ b/docs/manpages/smbumount.8 @@ -3,8 +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 "SMBUMOUNT" "8" "07 april 2003" "" "" - +.TH "SMBUMOUNT" "8" "04 March 2003" "" "" .SH NAME smbumount \- smbfs umount for normal users .SH SYNOPSIS @@ -27,7 +26,8 @@ to make umount setuid root. The directory to unmount. .SH "SEE ALSO" .PP -\fBsmbmount\fR(8) +\fBsmbmount(8)\fR + .SH "AUTHOR" .PP Volker Lendecke, Andrew Tridgell, Michael H. Warfield @@ -40,5 +40,4 @@ The SAMBA Mailing list <URL:mailto:samba@samba.org> is the preferred place to ask questions regarding these programs. .PP The conversion of this manpage for Samba 2.2 was performed -by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 -was done by Alexander Bokovoy. +by Gerald Carter diff --git a/docs/manpages/swat.8 b/docs/manpages/swat.8 index b773bb8fa2..6466a0a79d 100644 --- a/docs/manpages/swat.8 +++ b/docs/manpages/swat.8 @@ -3,8 +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 "SWAT" "8" "07 april 2003" "" "" - +.TH "SWAT" "8" "04 March 2003" "" "" .SH NAME swat \- Samba Web Administration Tool .SH SYNOPSIS @@ -13,10 +12,10 @@ swat \- Samba Web Administration Tool .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP \fBswat\fR allows a Samba administrator to -configure the complex \fBsmb.conf\fR(5) file 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. @@ -27,8 +26,8 @@ administrator to easily look up the effects of any change. \fB-s smb configuration file\fR The default configuration file path is determined at compile time. The file specified contains -the configuration details required by the \fBsmbd\fR(8) server. This is the file -that \fBswat\fR will modify. +the configuration details required by the \fBsmbd +\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. @@ -41,57 +40,8 @@ the \fIsmb.conf\fR file. \fBWARNING: Do NOT enable this option on a production server. \fR -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer -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 log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day to day running - it generates a small amount of -information about operations carried out. - -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. - -Note that specifying this parameter here will -override the log -level file. -.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. -.TP -\fB-h|--help\fR -Print a summary of command line options. .SH "INSTALLATION" .PP -Swat is included as binary package with most distributions. The -package manager in this case takes care of the installation and -configuration. This section is only for those who have compiled -swat from scratch. -.PP After you compile SWAT you need to run \fBmake install \fR to install the \fBswat\fR binary and the various help files and images. A default install would put @@ -116,7 +66,7 @@ add a line like this: .PP \fBswat 901/tcp\fR .PP -Note for NIS/YP and LDAP users - you may need to rebuild the +Note for NIS/YP users - you may need to rebuild the NIS service maps rather than alter your local \fI /etc/services\fR file. .PP the choice of port number isn't really important @@ -135,7 +85,7 @@ 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 \fR where PID is the process ID of the inetd daemon. -.SH "LAUNCHING" +.SS "LAUNCHING" .PP To launch SWAT just run your favorite web browser and point it at "http://localhost:901/". @@ -156,21 +106,26 @@ This file must contain a mapping of service name (e.g., tcp). .TP \fB\fI/usr/local/samba/lib/smb.conf\fB\fR -This is the default location of the \fBsmb.conf\fR(5) server configuration file that swat edits. Other +This is the default location of the \fIsmb.conf(5) +\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 \fBsmb.conf\fR(5) file. It will rearrange the entries and delete all +\fBswat\fR will rewrite your \fIsmb.conf +\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 3.0 of the Samba suite. +This man page is correct for version 2.2 of +the Samba suite. .SH "SEE ALSO" .PP -\fBinetd(5)\fR, \fBsmbd\fR(8), \fBsmb.conf\fR(5) +\fBinetd(5)\fR, +\fBsmbd(8)\fR +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -180,7 +135,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for -Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/testparm.1 b/docs/manpages/testparm.1 index 7646fedde7..c459eeea70 100644 --- a/docs/manpages/testparm.1 +++ b/docs/manpages/testparm.1 @@ -3,8 +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" "07 april 2003" "" "" - +.TH "TESTPARM" "1" "04 March 2003" "" "" .SH NAME testparm \- check an smb.conf configuration file for internal correctness .SH SYNOPSIS @@ -13,10 +12,10 @@ testparm \- check an smb.conf configuration file for internal correctness .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP \fBtestparm\fR is a very simple test program -to check an \fBsmbd\fR(8) configuration file for +to check an \fBsmbd\fR configuration file for internal correctness. If this program reports no problems, you can use the configuration file with confidence that \fBsmbd \fR will successfully load the configuration file. @@ -40,12 +39,8 @@ Without this option, \fBtestparm\fR will prompt for a carriage return after printing the service names and before dumping the service definitions. .TP -\fB-h|--help\fR -Print a summary of command line options. -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. +\fB-h\fR +Print usage message .TP \fB-L servername\fR Sets the value of the %L macro to \fIservername\fR. @@ -54,7 +49,9 @@ This is useful for testing include files specified with the .TP \fB-v\fR If this option is specified, testparm -will also output all options that were not used in \fBsmb.conf\fR(5) and are thus set to their defaults. +will also output all options that were not used in +\fIsmb.conf\fR and are thus set to +their defaults. .TP \fB-t encoding\fR Output data in specified encoding. @@ -62,13 +59,13 @@ Output data in specified encoding. \fBconfigfilename\fR This is the name of the configuration file to check. If this parameter is not present then the -default \fBsmb.conf\fR(5) file will be checked. +default \fIsmb.conf\fR file will be checked. .TP \fBhostname\fR If this parameter and the following are specified, then \fBtestparm\fR will examine the \fIhosts allow\fR and \fIhosts deny\fR -parameters in the \fBsmb.conf\fR(5) file to +parameters in the \fIsmb.conf\fR file to determine if the hostname with this IP address would be allowed access to the \fBsmbd\fR server. If this parameter is supplied, the hostIP parameter must also @@ -80,9 +77,9 @@ in the previous parameter. This address must be supplied if the hostname parameter is supplied. .SH "FILES" .TP -\fBsmb.conf(5)\fR +\fB\fIsmb.conf\fB\fR This is usually the name of the configuration -file used by \fBsmbd\fR(8). +file used by \fBsmbd\fR. .SH "DIAGNOSTICS" .PP The program will issue a message saying whether the @@ -96,7 +93,8 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBsmb.conf\fR(5), \fBsmbd\fR(8) +\fIsmb.conf(5)\fR +\fBsmbd(8)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -106,7 +104,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/testprns.1 b/docs/manpages/testprns.1 index dccd997fc5..f70b383f9d 100644 --- a/docs/manpages/testprns.1 +++ b/docs/manpages/testprns.1 @@ -3,8 +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 "TESTPRNS" "1" "07 april 2003" "" "" - +.TH "TESTPRNS" "1" "04 March 2003" "" "" .SH NAME testprns \- check printer name for validity with smbd .SH SYNOPSIS @@ -13,11 +12,11 @@ testprns \- check printer name for validity with smbd .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +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 \fBsmbd\fR(8). +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 @@ -35,7 +34,8 @@ Note that no validation or checking of the printcap syntax is done beyond that required to extract the printer name. It may be that the print spooling system is more forgiving or less forgiving than \fBtestprns\fR. However, if -\fBtestprns\fR finds the printer then \fBsmbd\fR(8) should do so as well. +\fBtestprns\fR finds the printer then +\fBsmbd\fR should do so as well. .TP \fBprintcapname\fR This is the name of the printcap file within @@ -69,12 +69,13 @@ for errors and warnings. Other messages are self-explanatory. .SH "VERSION" .PP -This man page is correct for version 3.0 of +This man page is correct for version 2.2 of the Samba suite. .SH "SEE ALSO" .PP \fIprintcap(5)\fR, -\fBsmbd\fR(8), \fBsmbclient\fR(1) +\fBsmbd(8)\fR +\fBsmbclient(1)\fR .SH "AUTHOR" .PP The original Samba software and related utilities @@ -84,7 +85,7 @@ to the way the Linux kernel is developed. .PP 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 +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 -Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 -for Samba 3.0 was done by Alexander Bokovoy. +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1 index bb378142dd..9877e2e461 100644 --- a/docs/manpages/vfstest.1 +++ b/docs/manpages/vfstest.1 @@ -3,8 +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" "07 april 2003" "" "" - +.TH "VFSTEST" "1" "04 March 2003" "" "" .SH NAME vfstest \- tool for testing samba VFS modules .SH SYNOPSIS @@ -13,7 +12,7 @@ vfstest \- tool for testing samba VFS modules .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP \fBvfstest\fR is a small command line utility that has the ability to test dso samba VFS modules. It gives the @@ -25,28 +24,6 @@ supports cascaded VFS modules. Execute the specified (colon-separated) commands. See below for the commands that are available. .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 -by the client. -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP \fB-d|--debug=debuglevel\fR \fIdebuglevel\fR is an integer from 0 to 10. The default value if this parameter is @@ -69,10 +46,13 @@ Note that specifying this parameter here will override the log level file. .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 by the client. +\&'.client' will be appended. The log file is never removed +by the client. .SH "COMMANDS" .PP \fBVFS COMMANDS\fR diff --git a/docs/manpages/wbinfo.1 b/docs/manpages/wbinfo.1 index 9e11e47133..3cc35e494d 100644 --- a/docs/manpages/wbinfo.1 +++ b/docs/manpages/wbinfo.1 @@ -3,61 +3,62 @@ .\" <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" "07 april 2003" "" "" - +.TH "WBINFO" "1" "04 March 2003" "" "" .SH NAME wbinfo \- Query information from winbind daemon .SH SYNOPSIS -\fBwbinfo\fR [ \fB-u\fR ] [ \fB-g\fR ] [ \fB-N netbios-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--sequence\fR ] [ \fB-r user\fR ] [ \fB-a user%password\fR ] [ \fB-A user%password\fR ] [ \fB--get-auth-user\fR ] [ \fB-p\fR ] +\fBwbinfo\fR [ \fB-u\fR ] [ \fB-g\fR ] [ \fB-i ip\fR ] [ \fB-N netbios-name\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 ] [ \fB-p\fR ] .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP The \fBwbinfo\fR program queries and returns information -created and used by the \fBwinbindd\fR(8) daemon. +created and used by the \fB winbindd(8)\fR daemon. .PP -The \fBwinbindd\fR(8) daemon must be configured +The \fBwinbindd(8)\fR daemon must be configured and running for the \fBwbinfo\fR program to be able to return information. .SH "OPTIONS" .TP \fB-u\fR This option will list all users available -in the Windows NT domain for which the \fBwinbindd\fR(8) daemon is operating in. Users in all trusted domains +in the Windows NT domain for which the \fBwinbindd(8) +\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\fR(8) -\&. +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 \fBSamba\fR(7) daemon is operating in. Groups in all trusted domains +in the Windows NT domain for which the \fBwinbindd(8) +\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\fR(8). +group ids to any groups that have not already been seen by +\fBwinbindd(8)\fR. .TP \fB-N name\fR The \fI-N\fR option -queries \fBwinbindd\fR(8) to query the WINS +queries \fBwinbindd(8)\fR to query the WINS server for the IP address associated with the NetBIOS name specified by the \fIname\fR parameter. .TP \fB-I ip\fR The \fI-I\fR option -queries \fBwinbindd\fR(8) to send a node status +queries \fBwinbindd(8)\fR to send a node status request to get the NetBIOS name associated with the IP address specified by the \fIip\fR parameter. .TP \fB-n name\fR The \fI-n\fR option -queries \fBwinbindd\fR(8) 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. For example CWDOM1/Administrator refers to the Administrator user in the domain CWDOM1. If no domain is specified then the -domain used is the one specified in the \fBsmb.conf\fR(5) \fIworkgroup -\fR parameter. +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 @@ -78,12 +79,11 @@ 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 \fBwinbindd\fR(8) then the operation will fail. +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 \fBwinbindd\fR(8) then -the operation will fail. +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,14 +92,10 @@ domain is working. .TP \fB-m\fR Produce a list of domains trusted by the -Windows NT server \fBwinbindd\fR(8) contacts +Windows NT server \fBwinbindd(8)\fR contacts when resolving names. This list does not include the Windows NT domain the server is a Primary Domain Controller for. .TP -\fB--sequence\fR -Show sequence numbers of -all known domains -.TP \fB-r username\fR Try to obtain the list of UNIX group ids to which the user belongs. This only works for users @@ -115,27 +111,11 @@ 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). -.TP -\fB--get-auth-user\fR -Print username and password used by winbindd -during session setup to a domain controller. Username -and password can be set using '-A'. Only available for -root. -.TP -\fB-p\fR -Check whether winbindd is still alive. -Prints out either 'succeeded' or 'failed'. -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-h|--help\fR -Print a summary of command line options. .SH "EXIT STATUS" .PP The wbinfo program returns 0 if the operation -succeeded, or 1 if the operation failed. If the \fBwinbindd\fR(8) daemon 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 @@ -143,7 +123,8 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fBwinbindd\fR(8) +\fBwinbindd(8)\fR + .SH "AUTHOR" .PP The original Samba software and related utilities @@ -155,5 +136,4 @@ to the way the Linux kernel is developed. were written by Tim Potter. .PP The conversion to DocBook for Samba 2.2 was done -by Gerald Carter. The conversion to DocBook XML 4.2 for Samba -3.0 was done by Alexander Bokovoy. +by Gerald Carter diff --git a/docs/manpages/winbindd.8 b/docs/manpages/winbindd.8 index a1e39fa172..696de8537b 100644 --- a/docs/manpages/winbindd.8 +++ b/docs/manpages/winbindd.8 @@ -3,8 +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 "WINBINDD" "8" "07 april 2003" "" "" - +.TH "WINBINDD" "8" "04 March 2003" "" "" .SH NAME winbindd \- Name Service Switch daemon for resolving names from NT servers .SH SYNOPSIS @@ -13,7 +12,7 @@ winbindd \- Name Service Switch daemon for resolving names from NT servers .SH "DESCRIPTION" .PP -This program is part of the \fBSamba\fR(7) suite. +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 @@ -60,11 +59,13 @@ 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 \fR and \fI/etc/group\fR and then from the -Windows NT server. +Windows NT server. +.PP .nf passwd: files winbind group: files winbind + .fi .PP The following simple configuration in the @@ -90,49 +91,11 @@ If specified, this parameter causes \fBwinbindd\fR to log to standard output rather than a file. .TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. -.TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. -.TP -\fB-d|--debug=debuglevel\fR -\fIdebuglevel\fR is an integer -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 log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day to day running - it generates a small amount of -information about operations carried out. - -Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic. - -Note that specifying this parameter here will -override the log -level file. -.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. -.TP -\fB-h|--help\fR -Print a summary of command line options. +\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). .TP \fB-i\fR Tells \fBwinbindd\fR to not @@ -155,7 +118,11 @@ Dual daemon mode. This means winbindd will run as 2 threads. The first will answer all requests from the cache, thus making responses to clients faster. The other will update the cache for the query that the first has just responded. -Advantage of this is that responses stay accurate and are faster. +Advantage of this is that responses are accurate and fast. +.TP +\fB-s|--conf=smb.conf\fR +Specifies the location of the all-important +\fIsmb.conf\fR file. .SH "NAME AND ID RESOLUTION" .PP Users and groups on a Windows NT server are assigned @@ -180,7 +147,8 @@ and group rids. .SH "CONFIGURATION" .PP Configuration of the \fBwinbindd\fR daemon -is done through configuration parameters in the \fBsmb.conf\fR(5) file. All parameters should be specified in the +is done through configuration parameters in the \fIsmb.conf(5) +\fR file. All parameters should be specified in the [global] section of smb.conf. .TP 0.2i \(bu @@ -217,23 +185,28 @@ following setup. This was tested on a RedHat 6.2 Linux box. .PP In \fI/etc/nsswitch.conf\fR put the following: +.PP .nf passwd: files winbind group: files winbind + .fi .PP -In \fI/etc/pam.d/*\fR replace the \fI auth\fR lines with something like this: +In \fI/etc/pam.d/*\fR replace the +\fIauth\fR lines with something like this: +.PP .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 + .fi .PP -Note in particular the use of the \fIsufficient -\fR keyword and the \fIuse_first_pass\fR keyword. +Note in particular the use of the \fIsufficient\fR +keyword and the \fIuse_first_pass\fR keyword. .PP Now replace the account lines with this: .PP @@ -241,24 +214,27 @@ Now replace the account lines with this: \fR .PP The next step is to join the domain. To do that use the -\fBnet\fR program like this: +\fBsmbpasswd\fR program like this: .PP -\fBnet join -S PDC -U Administrator\fR +\fBsmbpasswd -j DOMAIN -r PDC -U +Administrator\fR .PP The username after the \fI-U\fR can be any Domain user that has administrator privileges on the machine. -Substitute the name or IP of your PDC for "PDC". +Substitute your domain name for "DOMAIN" and the name of your PDC +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 +\fI/lib\fR and \fIpam_winbind.so\fR +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 older version of glibc then the target of the link should be \fI/lib/libnss_winbind.so.1\fR. .PP -Finally, setup a \fBsmb.conf\fR(5) containing directives like the -following: +Finally, setup a \fIsmb.conf\fR containing directives like the +following: +.PP .nf [global] @@ -271,6 +247,7 @@ following: workgroup = DOMAIN security = domain password server = * + .fi .PP Now start winbindd and you should find that your user and @@ -284,12 +261,17 @@ commands \fBgetent passwd\fR and \fBgetent group The following notes are useful when configuring and running \fBwinbindd\fR: .PP -\fBnmbd\fR(8) 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 +\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 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 +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 to set up PAM such that you can no longer log into your system. @@ -307,8 +289,8 @@ The following signals can be used to manipulate the \fBwinbindd\fR daemon. .TP \fBSIGHUP\fR -Reload the \fBsmb.conf\fR(5) file and -apply any parameter changes to the running +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. @@ -333,19 +315,6 @@ if both the \fI/tmp/.winbindd\fR directory and \fI/tmp/.winbindd/pipe\fR file are owned by root. .TP -\fB$LOCKDIR/winbindd_privilaged/pipe\fR -The UNIX pipe over which 'privilaged' clients -communicate with the \fBwinbindd\fR program. For security -reasons, access to some winbindd functions - like those needed by -the \fBntlm_auth\fR utility - is restricted. By default, -only users in the 'root' group will get this access, however the administrator -may change the group permissions on $LOCKDIR/winbindd_privilaged to allow -programs like 'squid' to use ntlm_auth. -Note that the winbind client will only attempt to connect to the winbindd daemon -if both the \fI$LOCKDIR/winbindd_privilaged\fR directory -and \fI$LOCKDIR/winbindd_privilaged/pipe\fR file are owned by -root. -.TP \fB/lib/libnss_winbind.so.X\fR Implementation of name service switch library. .TP @@ -364,7 +333,10 @@ This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP -\fInsswitch.conf(5)\fR, \fBSamba\fR(7), \fBwbinfo\fR(8), \fBsmb.conf\fR(5) +\fInsswitch.conf(5)\fR, +samba(7) +wbinfo(1) +smb.conf(5) .SH "AUTHOR" .PP The original Samba software and related utilities @@ -372,9 +344,8 @@ 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 -\fBwbinfo\fR and \fBwinbindd\fR were -written by Tim Potter. +\fBwbinfo\fR and \fBwinbindd\fR +were written by Tim Potter. .PP The conversion to DocBook for Samba 2.2 was done -by Gerald Carter. The conversion to DocBook XML 4.2 for -Samba 3.0 was done by Alexander Bokovoy. +by Gerald Carter |