From cc0af58dc2dee7860621c75866c1104c8bc24b1d Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Tue, 28 Jan 2003 14:39:01 +0000 Subject: First step towards XML: Use correct syntax (This used to be commit 06f641bcb59f932c994e6023d400df18b54c2067) --- docs/docbook/manpages/findsmb.1.sgml | 56 +- docs/docbook/manpages/lmhosts.5.sgml | 37 +- docs/docbook/manpages/net.8.sgml | 21 +- docs/docbook/manpages/nmbd.8.sgml | 101 +-- docs/docbook/manpages/nmblookup.1.sgml | 33 +- docs/docbook/manpages/pdbedit.8.sgml | 104 ++- docs/docbook/manpages/rpcclient.1.sgml | 74 +- docs/docbook/manpages/samba.7.sgml | 67 +- docs/docbook/manpages/smb.conf.5.sgml | 1259 +++++++++++++++-------------- docs/docbook/manpages/smbcacls.1.sgml | 53 +- docs/docbook/manpages/smbclient.1.sgml | 93 ++- docs/docbook/manpages/smbcontrol.1.sgml | 29 +- docs/docbook/manpages/smbd.8.sgml | 88 +- docs/docbook/manpages/smbgroupedit.8.sgml | 78 +- docs/docbook/manpages/smbmnt.8.sgml | 9 +- docs/docbook/manpages/smbmount.8.sgml | 41 +- docs/docbook/manpages/smbpasswd.5.sgml | 26 +- docs/docbook/manpages/smbpasswd.8.sgml | 83 +- docs/docbook/manpages/smbsh.1.sgml | 69 +- docs/docbook/manpages/smbspool.8.sgml | 27 +- docs/docbook/manpages/smbstatus.1.sgml | 27 +- docs/docbook/manpages/smbtar.1.sgml | 36 +- docs/docbook/manpages/smbumount.8.sgml | 9 +- docs/docbook/manpages/swat.8.sgml | 42 +- docs/docbook/manpages/testparm.1.sgml | 42 +- docs/docbook/manpages/testprns.1.sgml | 27 +- docs/docbook/manpages/vfstest.1.sgml | 7 +- docs/docbook/manpages/wbinfo.1.sgml | 70 +- docs/docbook/manpages/winbindd.8.sgml | 86 +- 29 files changed, 1364 insertions(+), 1330 deletions(-) (limited to 'docs/docbook') diff --git a/docs/docbook/manpages/findsmb.1.sgml b/docs/docbook/manpages/findsmb.1.sgml index 0b3bbca017..090b1c8388 100644 --- a/docs/docbook/manpages/findsmb.1.sgml +++ b/docs/docbook/manpages/findsmb.1.sgml @@ -1,5 +1,5 @@ - + findsmb @@ -23,15 +23,16 @@ DESCRIPTION - This perl script is part of the - Samba suite. + This perl script is part of the + Samba7 + suite. findsmb 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 - nmblookup(1) and - smbclient(1) to obtain this information. + It uses nmblookup1 + and smbclient1 + to obtain this information. @@ -45,16 +46,17 @@ 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, nmblookup + If set, nmblookup1 will be called with -B option. subnet broadcast address Without this option, findsmb will probe the subnet of the machine where - findsmb is run. This value is passed - to nmblookup as part of the - -B option. + findsmb1 + is run. This value is passed to + nmblookup1 + as part of the -B option. @@ -76,19 +78,21 @@ version. The command with -r option - must be run on a system without nmbd running. + must be run on a system without + nmbd8 + running. + If nmbd 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 nmbd running. - For example, running findsmb without - -r option set would yield output similar + For example, running findsmb + without -r option set would yield output similar to the following - + IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION --------------------------------------------------------------------- 192.168.35.10 MINESET-TEST1 [DMVENGR] @@ -101,7 +105,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] - + @@ -115,10 +119,12 @@ IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION SEE ALSO - nmbd(8), - smbclient(1) - , and - nmblookup(1) + + nmbd8 + , + smbclient1 + , and nmblookup + 1 @@ -132,11 +138,11 @@ IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter + excellent piece of Open Source software, available at 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. diff --git a/docs/docbook/manpages/lmhosts.5.sgml b/docs/docbook/manpages/lmhosts.5.sgml index 7934c18e8e..a8a5f2c072 100644 --- a/docs/docbook/manpages/lmhosts.5.sgml +++ b/docs/docbook/manpages/lmhosts.5.sgml @@ -1,5 +1,5 @@ - + lmhosts @@ -13,15 +13,15 @@ - lmhosts is the - Samba NetBIOS name to IP address mapping file. + lmhosts is the Samba + 7 NetBIOS name to IP address mapping file. DESCRIPTION - This file is part of the - Samba suite. + This file is part of the Samba + 7 suite. lmhosts is the Samba NetBIOS name to IP address mapping file. It @@ -35,7 +35,7 @@ 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: IP Address - in dotted decimal format. @@ -52,16 +52,16 @@ - An example follows : + An example follows: - + # # Sample Samba lmhosts file. # 192.9.200.1 TESTPC 192.9.200.20 NTSERVER#20 192.9.200.21 SAMBASERVER - + Contains three IP to NetBIOS name mappings. The first and third will be returned for any queries for the names "TESTPC" @@ -73,24 +73,24 @@ be resolved. The default location of the lmhosts file - is in the same directory as the - smb.conf(5)> file. + is in the same directory as the smb.conf + 5 file. VERSION - This man page is correct for version 2.2 of - the Samba suite. + This man page is correct for version 3.0 of the Samba suite. SEE ALSO - smbclient(1) - , - smb.conf(5), and - smbpasswd(8) + + smbclient1 + , smb.conf5 + , and smbpasswd + 8 @@ -108,7 +108,8 @@ 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/net.8.sgml b/docs/docbook/manpages/net.8.sgml index aab9032f14..62cee8c1d7 100644 --- a/docs/docbook/manpages/net.8.sgml +++ b/docs/docbook/manpages/net.8.sgml @@ -1,5 +1,5 @@ - + net @@ -42,8 +42,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. The samba net utility is meant to work just like the net utility available for windows and DOS. @@ -65,7 +65,8 @@ -w target-workgroup - 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. @@ -86,7 +87,8 @@ -I ip-address - 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. @@ -114,7 +116,8 @@ -S server - 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. @@ -211,7 +214,7 @@ SYSTEM - Displays the time on the remote server in a format ready for /bin/date + Displays the time on the remote server in a format ready for /bin/date @@ -219,7 +222,7 @@ SET Tries to set the date and time of the local server to that on - the remote server using /bin/date. + the remote server using /bin/date. @@ -276,7 +279,7 @@ - USER ADD <name> [password] [-F user flags] [misc. options + USER ADD <name> [password] [-F user flags] [misc. options] Add specified user diff --git a/docs/docbook/manpages/nmbd.8.sgml b/docs/docbook/manpages/nmbd.8.sgml index db920c79a1..6c7ecce4e9 100644 --- a/docs/docbook/manpages/nmbd.8.sgml +++ b/docs/docbook/manpages/nmbd.8.sgml @@ -1,5 +1,5 @@ - + nmbd @@ -35,7 +35,8 @@ DESCRIPTION - This program is part of the Samba suite. + This program is part of the Samba + 7 suite. nmbd is a server that understands and can reply to NetBIOS over IP name service requests, like @@ -57,8 +58,8 @@ option (see OPTIONS below). Thus nmbd will reply to broadcast queries for its own name(s). Additional names for nmbd to respond on can be set - via parameters in the - smb.conf(5) configuration file. + via parameters in the smb.conf + 5 configuration file. nmbd can also be used as a WINS (Windows Internet Name Server) server. What this basically means @@ -124,7 +125,7 @@ server is executed on the command line of a shell. Setting this parameter negates the implicit daemon mode when run from the command line. nmbd also logs to standard - output, as if the -S parameter had been + output, as if the -S parameter had been given. @@ -147,10 +148,10 @@ NetBIOS lmhosts file. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name - resolution mechanism - name resolve order described in smb.conf(5) - to resolve any NetBIOS name queries needed by the server. Note + resolution mechanism name resolve + order described in smb.conf + 5 to resolve any + NetBIOS name queries needed by the server. Note that the contents of this file are NOT used by nmbd to answer any name queries. Adding a line to this file affects name NetBIOS resolution @@ -160,9 +161,8 @@ Samba as part of the build process. Common defaults are /usr/local/samba/lib/lmhosts, /usr/samba/lib/lmhosts or - /etc/lmhosts. See the - lmhosts(5) - man page for details on the contents of this file. + /etc/samba/lmhosts. See the lmhosts + 5 man page for details on the contents of this file. @@ -191,9 +191,9 @@ cryptic. Note that specifying this parameter here will override - the log level - parameter in the - smb.conf(5) file. + the log level + parameter in the smb.conf + 5 file. @@ -216,11 +216,12 @@ -n <primary NetBIOS name> 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 - smb.conf file. However, a command + to setting the NetBIOS + name parameter in the smb.conf + 5 file. However, a command line setting will take precedence over settings in - smb.conf. + smb.conf + 5. @@ -241,8 +242,8 @@ this may be changed when Samba is autoconfigured. The file specified contains the configuration details - required by the server. See - smb.conf(5) for more information. + required by the server. See smb.conf + 5 for more information. @@ -258,7 +259,7 @@ inetd meta-daemon, this file must contain suitable startup information for the meta-daemon. See the UNIX_INSTALL.html document + url="install.html">install document for details. @@ -271,7 +272,7 @@ If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server. See the UNIX_INSTALL.html document + url="install.html">"How to Install and Test SAMBA" document for details. @@ -281,21 +282,23 @@ meta-daemon inetd, 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 UNIX_INSTALL.html + See the "How to Install and Test SAMBA" document for details. /usr/local/samba/lib/smb.conf - This is the default location of the - smb.conf - server configuration file. Other common places that systems + This is the default location of + the smb.conf + 5 server + configuration file. Other common places that systems install this file are /usr/samba/lib/smb.conf - and /etc/smb.conf. + and /etc/samba/smb.conf. When run as a WINS server (see the - wins support - parameter in the smb.conf(5) man page), + wins support + parameter in the smb.conf + 5 man page), nmbd will store the WINS database in the file wins.dat in the var/locks directory configured under @@ -303,9 +306,9 @@ If nmbd is acting as a browse master (see the local master - parameter in the smb.conf(5) man page, - nmbd + url="smb.conf.5.html#LOCALMASTER">local master + parameter in the smb.conf + 5 man page, nmbd will store the browsing database in the file browse.dat in the var/locks directory configured under wherever Samba was configured to install itself. @@ -331,10 +334,11 @@ cause nmbd to dump out its server database in the log.nmb file. - The debug log level of nmbd may be raised or lowered using - smbcontrol(1) - (SIGUSR[1|2] signals are no longer used in 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 smbcontrol + 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 at a normally low log level. @@ -348,14 +352,15 @@ SEE ALSO - inetd(8), smbd(8), - smb.conf(5) - , smbclient(1) - , - testparm(1), - testprns(1), and the Internet RFC's - rfc1001.txt, rfc1002.txt. + + inetd + 8, smbd + 8, smb.conf + 5, smbclient + 1, testparm + 1, testprns + 1, and the Internet + RFC's rfc1001.txt, rfc1002.txt. In addition the CIFS (formerly SMB) specification is available as a link from the Web page http://samba.org/cifs/. @@ -371,11 +376,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/nmblookup.1.sgml b/docs/docbook/manpages/nmblookup.1.sgml index 33ae631ed9..7dd7f105d7 100644 --- a/docs/docbook/manpages/nmblookup.1.sgml +++ b/docs/docbook/manpages/nmblookup.1.sgml @@ -36,8 +36,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. nmblookup is used to query NetBIOS names and map them to IP addresses in a network using NetBIOS over TCP/IP @@ -66,7 +66,7 @@ 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. @@ -86,8 +86,8 @@ where it ignores the source port of the requesting packet and only replies to UDP port 137. Unfortunately, on most UNIX systems root privilege is needed to bind to this port, and - in addition, if the nmbd(8) - 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. @@ -115,7 +115,8 @@ query to the broadcast address of the network interfaces as either auto-detected or defined in the interfaces - parameter of the smb.conf (5) file. + parameter of the smb.conf + 5 file. @@ -198,7 +199,7 @@ This is the NetBIOS name being queried. Depending upon the previous options this may be a NetBIOS name or IP address. If a NetBIOS name then the different name types may be specified - by appending '#<type>' to the name. This name may also be + by appending '#<type>' to the name. This name may also be '*', which will return all registered names within a broadcast area. @@ -211,8 +212,8 @@ nmblookup can be used to query a WINS server (in the same way nslookup is - used to query DNS servers). To query a WINS server, - nmblookup must be called like this: + used to query DNS servers). To query a WINS server, nmblookup + must be called like this: nmblookup -U server -R 'name' @@ -233,10 +234,10 @@ SEE ALSO - nmbd(8), - samba(7), and smb.conf(5) - + nmbd + 8, samba + 7, and smb.conf + 5. @@ -249,11 +250,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/pdbedit.8.sgml b/docs/docbook/manpages/pdbedit.8.sgml index 1484bfec9a..e6231bfa8c 100644 --- a/docs/docbook/manpages/pdbedit.8.sgml +++ b/docs/docbook/manpages/pdbedit.8.sgml @@ -1,7 +1,7 @@ %globalentities; ]> - + pdbedit @@ -42,8 +42,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root. @@ -67,12 +67,11 @@ present in the users database. This option prints a list of user/uid pairs separated by the ':' character. - Example: pdbedit -l - - sorce:500:Simo Sorce - samba:45:Test User - + +sorce:500:Simo Sorce +samba:45:Test User + @@ -85,26 +84,26 @@ out the account fields in a descriptive format. Example: pdbedit -l -v - - --------------- - 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 + @@ -115,14 +114,15 @@ 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 - smbpasswd file format. (see the smbpasswd(5) for details) + smbpasswd file format. (see the + smbpasswd + 5 for details) Example: pdbedit -l -w - - 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: + @@ -136,8 +136,6 @@ operations. - - -f fullname @@ -162,7 +160,6 @@ - -D drive This option can be used while adding or @@ -207,9 +204,10 @@ ask for the password to be used. Example: pdbedit -a -u sorce - new password: - retype new password - +new password: +retype new password + + @@ -281,9 +279,9 @@ maximum password age and bad lockout attempt. Example: pdbedit -P "bad lockout attempt" - - account policy value for bad lockout attempt is 0 - + +account policy value for bad lockout attempt is 0 + @@ -296,10 +294,10 @@ Example: pdbedit -P "bad lockout attempt" -V 3 - - 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 + @@ -327,9 +325,9 @@ SEE ALSO - smbpasswd(8), - samba(7) - + smbpasswd + 5, samba + 7 @@ -342,11 +340,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml index 10e0ff438d..933938d438 100644 --- a/docs/docbook/manpages/rpcclient.1.sgml +++ b/docs/docbook/manpages/rpcclient.1.sgml @@ -1,7 +1,7 @@ %globalentities; ]> - + rpcclient @@ -36,8 +36,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. rpcclient is a utility initially developed to test MS-RPC functionality in Samba itself. It has undergone @@ -56,8 +56,8 @@ NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is resolved using the - name resolve order line from - smb.conf(5). + name resolve order line from smb.conf + 5. @@ -68,11 +68,11 @@ password used in the connection. The format of the file is - - username = <value> - password = <value> - domain = <value> - + +username = <value> +password = <value> +domain = <value> + Make certain that the permissions on the file restrict access from unwanted users. @@ -85,13 +85,10 @@ execute semicolon separated commands (listed below)) - - - - &stdarg.debuglevel; &stdarg.help; - + &stdarg.debuglevel; + -I IP-address IP address is the address of the server to connect to. @@ -163,9 +160,6 @@ it in directly. - - - -W|--workgroup=domain Set the SMB domain of the username. This @@ -175,7 +169,6 @@ opposed to the Domain SAM). - @@ -214,12 +207,10 @@ - - SPOOLSS - adddriver <arch> <config> + adddriver <arch> <config> - 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 @@ -229,16 +220,16 @@ The config parameter is defined as follows: - - 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 + Any empty fields should be enter as the string "NULL". @@ -248,10 +239,7 @@ 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. - - - - + addprinter <printername> <sharename> <drivername> <port> - Add a printer on the remote server. This printer @@ -387,7 +375,7 @@ From Luke Leighton's original rpcclient man page: - "WARNING! The MSRPC over SMB code has + WARNING! 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 @@ -395,12 +383,13 @@ to be... a bit flaky in places. 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 smbd(8) and rpcclient(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 smbd + 8 and rpcclient + 1 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. @@ -422,7 +411,8 @@ 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. + Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was + done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/samba.7.sgml b/docs/docbook/manpages/samba.7.sgml index 17865edd81..a352a6a7c6 100644 --- a/docs/docbook/manpages/samba.7.sgml +++ b/docs/docbook/manpages/samba.7.sgml @@ -1,5 +1,5 @@ - + samba @@ -8,7 +8,7 @@ - SAMBA + Samba A Windows SMB/CIFS fileserver for UNIX @@ -29,26 +29,30 @@ - smbd - The smbd - daemon provides the file and print services to + smbd + 8 + The smbd 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 smb.conf + for this daemon is described in smb.conf + 5 - nmbd + nmbd + 8 The nmbd daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon - is described in smb.conf + is described in smb.conf + 5 - smbclient + smbclient + 1 The smbclient program implements a simple ftp-like client. This is useful for accessing SMB shares on other compatible @@ -59,15 +63,17 @@ - testparm + testparm + 1 The testparm - utility is a simple syntax checker for Samba's - smb.confconfiguration file. + utility is a simple syntax checker for Samba's smb.conf + 5 configuration file. - testprns + testprns + 1 The testprns utility supports testing printer names defined in your printcap file used @@ -76,7 +82,8 @@ - smbstatus + smbstatus + 1 The smbstatus tool provides access to information about the current connections to smbd. @@ -84,7 +91,8 @@ - nmblookup + nmblookup + 1 The nmblookup tools allows NetBIOS name queries to be made from a UNIX host. @@ -92,15 +100,18 @@ - make_smbcodepage - The make_smbcodepage - utility provides a means of creating SMB code page - definition files for your smbd server. + smbgroupedit + 8 + The smbgroupedit + 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. - smbpasswd + smbpasswd + 8 The smbpasswd command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers. @@ -147,8 +158,8 @@ list. Details on how to join the mailing list are given in the README file that comes with Samba. - If you have access to a WWW viewer (such as Netscape - or Mosaic) then you will also find lots of useful information, + If you have access to a WWW viewer (such as Mozilla + or Konqueror) then you will also find lots of useful information, including back issues of the Samba mailing list, at http://lists.samba.org. @@ -156,7 +167,7 @@ VERSION - This man page is correct for version 2.2 of the + This man page is correct for version 3.0 of the Samba suite. @@ -170,8 +181,8 @@ If you have patches to submit, visit http://devel.samba.org/ - for information on how to do it properly. We prefer patches in - diff -u format. + for information on how to do it properly. We prefer patches + in diff -u format. @@ -206,11 +217,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML + 4.2 for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smb.conf.5.sgml b/docs/docbook/manpages/smb.conf.5.sgml index 01f767d256..9a2ea4fbde 100644 --- a/docs/docbook/manpages/smb.conf.5.sgml +++ b/docs/docbook/manpages/smb.conf.5.sgml @@ -1,5 +1,5 @@ - + smb.conf @@ -15,14 +15,13 @@ SYNOPSIS - The smb.conf file is a configuration - file for the Samba suite. smb.conf contains - runtime configuration information for the Samba programs. The - smb.conf file is designed to be configured and - administered by the swat(8) - program. The complete description of the file format and - possible parameters held within are here for reference purposes. - + The smb.conf file is a configuration + file for the Samba suite. smb.conf contains + runtime configuration information for the Samba programs. The smb.conf file + is designed to be configured and administered by the swat + 8 program. The complete + description of the file format and possible parameters held within + are here for reference purposes. FILE FORMAT @@ -105,13 +104,13 @@ The user has write access to the path /home/bar. The share is accessed via the share name "foo": - - - [foo] - path = /home/bar - read only = no - - + + +[foo] + path = /home/bar + read only = no + + The following sample section defines a printable share. The share is readonly, but printable. That is, the only write @@ -120,15 +119,15 @@ access will be permitted as the default guest user (specified elsewhere): - - - [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 + + @@ -192,12 +191,12 @@ than others. The following is a typical and suitable [homes] section: - - - [homes] - read only = no - - + + +[homes] + read only = no + + An important point is that if guest access is specified in the [homes] section, all home directories will be @@ -257,12 +256,12 @@ it. A typical [printers] entry would look like this: - - [printers] - path = /usr/spool/public - guest ok = yes - printable = yes - + +[printers] + path = /usr/spool/public + guest ok = yes + printable = yes + All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. @@ -270,11 +269,11 @@ to set up a pseudo-printcap. This is a file consisting of one or more lines like this: - - - alias|alias|alias|alias... - - + + +alias|alias|alias|alias... + + Each alias should be an acceptable printer name for your printing subsystem. In the [global] section, specify @@ -472,7 +471,7 @@ There are some quite creative things that can be done - with these substitutions and other smb.conf options. @@ -552,7 +551,7 @@ then steps 1 to 5 are skipped. - + If the client has passed a username/password pair and that username/password pair is validated by the UNIX system's password programs then the connection is made as that @@ -805,7 +804,7 @@ allow hosts available blocking locks -block size + block size browsable browseable case sensitive @@ -937,10 +936,10 @@ - abort shutdown script (G) + abort shutdown script (G) This parameter only exists in the HEAD cvs branch - This a full path name to a script called by - smbd(8) that + This a full path name to a script called by smbd + 8 that should stop a shutdown procedure issued by the shutdown script. @@ -952,7 +951,7 @@ - addprinter command (G) + addprinter command (G) 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 @@ -966,12 +965,12 @@ will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the smb.conf file in order that it can be - shared by smbd(8) - . + shared by smbd + 8. The addprinter command is automatically invoked with the following parameter (in - order: + order): printer name @@ -997,7 +996,7 @@ See also deleteprinter command, printing, + linkend="PRINTING">printing, show add printer wizard @@ -1010,7 +1009,7 @@ - add share command (G) + add share command (G) Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The add share command is used to define an @@ -1064,9 +1063,10 @@ - add machine script (G) + add machine script (G) This is the full pathname to a script that will - be run by smbd(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 @@ -1082,7 +1082,7 @@ - ads server (G) + ads server (G) 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 @@ -1095,10 +1095,10 @@ - add user script (G) + add user script (G) This is the full pathname to a script that will - be run AS ROOT by smbd(8) - under special circumstances described below. + be run AS ROOT 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 @@ -1108,16 +1108,16 @@ url="smbd.8.html">smbd to create the required UNIX users ON DEMAND when a user accesses the Samba server. - In order to use this option, smbd - must NOT be set to security = share + In order to use this option, smbd + 8 must NOT be set to security = share and add user script must be set to a full pathname for a script that will create a UNIX user given one argument of %u, 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, - smbd contacts the password server and + at login (session setup in the SMB protocol) time, smbd + 8 contacts the password server and attempts to authenticate the given user with the given password. If the authentication succeeds then smbd attempts to find a UNIX user in the UNIX password database to map the @@ -1145,10 +1145,10 @@ - add group script (G) + add group script (G) This is the full pathname to a script that will - be run AS ROOT by smbd(8) when a new group is + be run AS ROOT by smbd + 8 when a new group is requested. It will expand any %g to the group name passed. This script is only useful for installations using the @@ -1161,7 +1161,7 @@ - admin users (S) + admin users (S) 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). @@ -1177,13 +1177,13 @@ - add user to group script (G) + add user to group script (G) 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 smbd(8) - AS ROOT. Any %g will be - replaced with the group name and any %u will - be replaced with the user name. + tools. It will be run by smbd + 8 AS ROOT. + Any %g will be replaced with the group name and + any %u will be replaced with the user name. Default: add user to group script = @@ -1194,13 +1194,13 @@ - allow hosts (S) + allow hosts (S) Synonym for hosts allow. - algorithmic rid base (G) + algorithmic rid base (G) This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers. @@ -1223,7 +1223,7 @@ - allow trusted domains (G) + allow trusted domains (G) This option only takes effect when the security option is set to server or domain. @@ -1247,10 +1247,9 @@ - announce as (G) - This specifies what type of server - nmbd - will announce itself as, to a network neighborhood browse + announce as (G) + This specifies what type of server nmbd + 8 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, @@ -1269,7 +1268,7 @@ - announce version (G) + announce version (G) 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 @@ -1284,7 +1283,7 @@ - auto services (G) + auto services (G) This is a synonym for the preload. @@ -1293,7 +1292,7 @@ - auth methods (G) + auth methods (G) This option allows the administrator to chose what authentication methods smbd will use when authenticating a user. This option defaults to sensible values based on @@ -1311,7 +1310,7 @@ - available (S) + available (S) This parameter lets you "turn off" a service. If available = no, then ALL attempts to connect to the service will fail. Such failures are @@ -1325,12 +1324,12 @@ - bind interfaces only (G) + bind interfaces only (G) This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests. It - affects file service smbd(8) and - name service nmbd(8) in slightly - different ways. + affects file service smbd + 8 and name service nmbd + 8 in a slightly different ways. For name service it causes nmbd to bind to ports 137 and 138 on the interfaces listed in the nmbd. - For file service it causes smbd(8) - to bind only to the interface list given in the + For file service it causes smbd + 8 to bind only to the interface list + given in the interfaces parameter. This restricts the networks that smbd will serve to packets coming in those interfaces. Note that you should not use this parameter for machines @@ -1360,10 +1360,9 @@ If bind interfaces only is set then unless the network address 127.0.0.1 is added - to the interfaces parameter list smbpasswd(8) - and swat(8) may - not work as expected due to the reasons covered below. + to the interfaces parameter list smbpasswd + 8 and swat + 8 may not work as expected due to the reasons covered below. To change a users SMB password, the smbpasswd by default connects to the localhost - 127.0.0.1 @@ -1373,9 +1372,9 @@ interfaces parameter list then smbpasswd will fail to connect in it's default mode. smbpasswd can be forced to use the primary IP interface - of the local host by using its - -r remote machine - parameter, with remote machine set + of the local host by using its smbpasswd + 8 -r remote machine + parameter, with remote machine set to the IP name of the primary interface of the local host. The swat status page tries to connect with @@ -1395,9 +1394,10 @@ - blocking locks (S) - This parameter controls the behavior of smbd(8) when given a request by a client + blocking locks (S) + 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. @@ -1417,9 +1417,9 @@ - block size (S) - This parameter controls the behavior of - smbd(8) when reporting disk free + block size (S) + This parameter controls the behavior of smbd + 8 when reporting disk free sizes. By default, this reports a disk block size of 1024 bytes. @@ -1433,27 +1433,19 @@ Changing this option does not change the disk free reporting size, just the block size unit reported to the client. - - Default: block size = 1024 - Example: block size = 65536 - - - - - + + - browsable (S) + browsable (S) See the browseable. - - - browse list (G) - This controls whether - smbd(8) will serve a browse list to + browse list (G) + This controls whether smbd + 8 will serve a browse list to a client doing a NetServerEnum call. Normally set to yes. You should never need to change this. @@ -1464,7 +1456,7 @@ - browseable (S) + browseable (S) This controls whether this share is seen in the list of available shares in a net view and in the browse list. @@ -1475,7 +1467,7 @@ - case sensitive (S) + case sensitive (S) See the discussion in the section NAME MANGLING. @@ -1486,7 +1478,7 @@ - casesignames (S) + casesignames (S) Synonym for case sensitive. @@ -1494,12 +1486,12 @@ - change notify timeout (G) + change notify timeout (G) 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 - smbd(8) daemon only performs such a scan + a directory is expensive under UNIX, hence an smbd + 8 daemon only performs such a scan on each requested directory once every change notify timeout seconds. @@ -1512,7 +1504,7 @@ - change share command (G) + change share command (G) Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The change share command is used to define an @@ -1562,12 +1554,8 @@ - - - - - comment (S) + comment (S) 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 net view to list what shares @@ -1584,7 +1572,7 @@ - config file (G) + config file (G) This allows you to override the config file to use, instead of the default (usually smb.conf). There is a chicken and egg problem here as this option is set @@ -1608,7 +1596,7 @@ - copy (S) + copy (S) 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 @@ -1626,7 +1614,7 @@ - create mask (S) + create mask (S) A synonym for this parameter is create mode . @@ -1670,14 +1658,14 @@ - create mode (S) + create mode (S) This is a synonym for create mask. - csc policy (S) + csc policy (S) This stands for client-side caching policy, and specifies how clients capable of offline caching will cache the files in the share. The valid values @@ -1696,7 +1684,7 @@ - deadtime (G) + deadtime (G) 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 @@ -1722,7 +1710,7 @@ - debug hires timestamp (G) + debug hires timestamp (G) 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 @@ -1739,7 +1727,7 @@ - debug pid (G) + debug pid (G) When using only one log file for more then one forked smbd-process there may be hard to follow which process outputs which message. This boolean parameter is adds the process-id @@ -1754,7 +1742,7 @@ - debug timestamp (G) + debug timestamp (G) Samba debug log messages are timestamped by default. If you are running at a high debug level these timestamps @@ -1767,7 +1755,7 @@ - debug uid (G) + debug uid (G) 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 @@ -1783,7 +1771,7 @@ - debuglevel (G) + debuglevel (G) Synonym for log level. @@ -1792,7 +1780,7 @@ - default (G) + default (G) A synonym for default service. @@ -1800,7 +1788,7 @@ - default case (S) + default case (S) See the section on NAME MANGLING. Also note the short preserve case parameter. @@ -1812,7 +1800,7 @@ - default devmode (S) + default devmode (S) 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 @@ -1850,7 +1838,7 @@ - default service (G) + default service (G) 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 NOT @@ -1876,24 +1864,27 @@ Example: - + [global] default service = pub [pub] path = /%S - + - delete group script (G) + delete group script (G) This is the full pathname to a script that will - be run AS ROOT by smbd(8) when a group is requested to be deleted. It will expand any %g to the group name passed. This script is only useful for installations using the Windows NT domain administration tools. + be run AS ROOT smbd + 8 when a group is requested to be deleted. + It will expand any %g to the group name passed. + This script is only useful for installations using the Windows NT domain administration tools. - deleteprinter command (G) + deleteprinter command (G) 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 @@ -1919,7 +1910,7 @@ See also addprinter command, printing, + linkend="PRINTING">printing, show add printer wizard @@ -1935,7 +1926,7 @@ - delete readonly (S) + delete readonly (S) This parameter allows readonly files to be deleted. This is not normal DOS semantics, but is allowed by UNIX. @@ -1949,7 +1940,7 @@ - delete share command (G) + delete share command (G) Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The delete share command is used to define an @@ -1997,10 +1988,11 @@ - delete user script (G) + delete user script (G) This is the full pathname to a script that will - be run by smbd(8) - when managing user's with remote RPC (NT) tools. + be run by smbd + 8 when managing users + with remote RPC (NT) tools. This script is called when a remote client removes a user @@ -2018,13 +2010,13 @@ - delete user from group script (G) + delete user from group script (G) 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 smbd(8) - AS ROOT. Any %g will be - replaced with the group name and any %u will - be replaced with the user name. + tools. It will be run by smbd + 8 AS ROOT. + Any %g will be replaced with the group name and + any %u will be replaced with the user name. Default: delete user from group script = @@ -2035,7 +2027,7 @@ - delete veto files (S) + delete veto files (S) This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the veto files @@ -2064,7 +2056,7 @@ - deny hosts (S) + deny hosts (S) Synonym for hosts deny. @@ -2073,7 +2065,7 @@ - dfree command (G) + dfree command (G) The dfree command 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, @@ -2106,17 +2098,17 @@ Where the script dfree (which must be made executable) could be: - - #!/bin/sh - df $1 | tail -1 | awk '{print $2" "$4}' - + +#!/bin/sh +df $1 | tail -1 | awk '{print $2" "$4}' + or perhaps (on Sys V based systems): - - #!/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}' + Note that you may have to replace the command names with full path names on some systems. @@ -2127,7 +2119,7 @@ - directory (S) + directory (S) Synonym for path . @@ -2135,7 +2127,7 @@ - directory mask (S) + directory mask (S) This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories. @@ -2183,7 +2175,7 @@ - directory mode (S) + directory mode (S) Synonym for directory mask @@ -2191,7 +2183,7 @@ - directory security mask (S) + directory security mask (S) 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 @@ -2226,7 +2218,7 @@ - disable netbios (G) + disable netbios (G) 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. @@ -2241,7 +2233,7 @@ - disable spoolss (G) + disable spoolss (G) 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 @@ -2262,7 +2254,7 @@ - display charset (G) + display charset (G) 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 unix charset. @@ -2277,12 +2269,12 @@ - dns proxy (G) - 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. + dns proxy (G) + 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 @@ -2300,7 +2292,7 @@ - domain logons (G) + domain logons (G) If set to yes, the Samba server will serve Windows 95/98 Domain logons for the workgroup it is in. Samba 2.2 @@ -2315,20 +2307,20 @@ - domain master (G) - Tell - nmbd(8) to enable WAN-wide browse list + domain master (G) + Tell smbd + 8 to enable WAN-wide browse list collation. Setting this option causes nmbd to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given workgroup. Local master browsers in the same workgroup on broadcast-isolated subnets will give this nmbd their local browse lists, - and then ask smbd(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 smbd + 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. Note that Windows NT Primary Domain Controllers expect to be able to claim this workgroup specific special @@ -2353,7 +2345,7 @@ - dont descend (S) + dont descend (S) There are certain directories on some systems (e.g., the /proc tree under Linux) that are either not of interest to clients or are infinitely deep (recursive). This @@ -2372,7 +2364,7 @@ - dos charset (G) + dos charset (G) DOS SMB clients assume the server has the same charset as they do. This option specifies which charset Samba should talk to DOS clients. @@ -2380,14 +2372,14 @@ 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 testparm(1) - to check the default on your system. + case it is not available. Run testparm + 1 to check the default on your system. - dos filemode (S) + dos filemode (S) 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 @@ -2406,13 +2398,13 @@ - dos filetime resolution (S) + dos filetime resolution (S) 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 smbd(8) - . + resolution is made to smbd + 8. This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. If oplocks are enabled on a @@ -2432,14 +2424,15 @@ - dos filetimes (S) + dos filetimes (S) 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 smbd is acting on behalf of is not the file owner. Setting this option to - yes allows DOS semantics and smbd will change the file + yes allows DOS semantics and smbd + 8 will change the file timestamp as DOS requires. Default: dos filetimes = no @@ -2448,7 +2441,7 @@ - encrypt passwords (G) + encrypt passwords (G) 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 @@ -2457,10 +2450,11 @@ directory docs/ shipped with the source code. In order for encrypted passwords to work correctly - smbd(8) must either - have access to a local smbpasswd(5) - file (see the - smbpasswd(8) program for information on how to set up + smbd + 8 must either + have access to a local smbpasswd + 5 file (see the smbpasswd + 8 program for information on how to set up and maintain this file), or set the security = [server|domain|ads] parameter which causes smbd to authenticate against another @@ -2471,7 +2465,7 @@ - enhanced browsing (G) + enhanced browsing (G) 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. @@ -2497,7 +2491,7 @@ - enumports command (G) + enumports command (G) 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 @@ -2520,7 +2514,7 @@ - exec (S) + exec (S) This is a synonym for preexec. @@ -2528,7 +2522,7 @@ - fake directory create times (S) + fake directory create times (S) 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 @@ -2562,7 +2556,7 @@ - fake oplocks (S) + fake oplocks (S) 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 @@ -2594,10 +2588,11 @@ - follow symlinks (S) + follow symlinks (S) This parameter allows the Samba administrator - to stop smbd(8) - from following symbolic links in a particular share. Setting this + to stop smbd + 8 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 @@ -2614,7 +2609,7 @@ - force create mode (S) + force create mode (S) This parameter specifies a set of UNIX mode bit permissions that will always be set on a file created by Samba. This is done by bitwise 'OR'ing these bits onto @@ -2642,7 +2637,7 @@ - force directory mode (S) + force directory mode (S) This parameter specifies a set of UNIX mode bit permissions that will always be set on a directory created by Samba. This is done by bitwise 'OR'ing these bits onto the @@ -2671,7 +2666,7 @@ - force directory security mode (S) + force directory security mode (S) 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. @@ -2707,7 +2702,7 @@ - force group (S) + force group (S) 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 @@ -2743,7 +2738,7 @@ - force security mode (S) + force security mode (S) 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 @@ -2781,7 +2776,7 @@ - force user (S) + force user (S) 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 @@ -2809,11 +2804,11 @@ - fstype (S) + fstype (S) This parameter allows the administrator to configure the string that specifies the type of filesystem a share - is using that is reported by smbd(8) - when a client queries the filesystem type + is using that is reported by smbd + 8 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 @@ -2826,7 +2821,7 @@ - getwd cache (G) + getwd cache (G) 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 @@ -2840,7 +2835,7 @@ - group (S) + group (S) Synonym for force group. @@ -2848,7 +2843,7 @@ - guest account (S) + guest account (S) This is a username which will be used for access to services which are specified as guest ok (see below). Whatever privileges this @@ -2878,7 +2873,7 @@ - guest ok (S) + guest ok (S) If this parameter is yes for a service, then no password is required to connect to the service. Privileges will be those of the @@ -2894,7 +2889,7 @@ - guest only (S) + guest only (S) If this parameter is yes for a service, then only guest connections to the service are permitted. This parameter will have no effect if @@ -2910,7 +2905,7 @@ - hide dot files (S) + hide dot files (S) This is a boolean parameter that controls whether files starting with a dot appear as hidden files. @@ -2920,7 +2915,7 @@ - hide files(S) + hide files(S) 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. @@ -2958,7 +2953,7 @@ - hide local users(G) + hide local users(G) This parameter toggles the hiding of local UNIX users (root, wheel, floppy, etc) from remote clients. @@ -2968,7 +2963,7 @@ - hide unreadable (G) + hide unreadable (G) This parameter prevents clients from seeing the existance of files that cannot be read. Defaults to off. @@ -2977,7 +2972,7 @@ - hide unwriteable files (G) + hide unwriteable files (G) 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. @@ -2988,7 +2983,7 @@ - hide special files (G) + hide special files (G) This parameter prevents clients from seeing special files such as sockets, devices and fifo's in directory listings. @@ -2999,10 +2994,10 @@ - homedir map (G) + homedir map (G) Ifnis homedir - is yes, and smbd(8) is also acting + is yes, and smbd + 8 is also acting as a Win95/98 logon server 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 @@ -3032,7 +3027,7 @@ - host msdfs (G) + host msdfs (G) This boolean parameter is only available if Samba has been configured and compiled with the --with-msdfs option. If set to yes, @@ -3050,7 +3045,7 @@ - hostname lookups (G) + hostname lookups (G) 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 @@ -3066,7 +3061,7 @@ - hosts allow (S) + hosts allow (S) A synonym for this parameter is allow hosts. @@ -3115,9 +3110,9 @@ Note that access still requires suitable user-level passwords. - See testparm(1) - for a way of testing your host access to see if it does - what you expect. + See testparm + 1 for a way of testing your host access + to see if it does what you expect. Default: none (i.e., all hosts permitted access) @@ -3130,7 +3125,7 @@ - hosts deny (S) + hosts deny (S) The opposite of hosts allow - hosts listed here are NOT permitted access to services unless the specific services have their own lists to override @@ -3147,7 +3142,7 @@ - hosts equiv (G) + hosts equiv (G) 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. @@ -3176,7 +3171,7 @@ - include (G) + include (G) This allows you to include one config file inside another. The file is included literally, as though typed in place. @@ -3193,7 +3188,7 @@ - inherit acls (S) + inherit acls (S) This parameter can be used to ensure that if default acls exist on parent directories, they are always honored when creating a subdirectory. @@ -3211,7 +3206,7 @@ - inherit permissions (S) + inherit permissions (S) The permissions on new files and directories are normally governed by create mask, @@ -3252,7 +3247,7 @@ - interfaces (G) + interfaces (G) 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 @@ -3304,7 +3299,7 @@ - invalid users (S) + invalid users (S) This is a list of users that should not be allowed to login to this service. This is really a paranoid check to absolutely ensure an improper setting does not breach @@ -3316,12 +3311,12 @@ A name starting with '+' is interpreted only by looking in the UNIX group database. A name starting with - '&' is interpreted only by looking in the NIS netgroup database + '&' is interpreted only by looking in the NIS netgroup database (this requires NIS to be working on your system). The characters - '+' and '&' may be used at the start of the name in either order + '+' and '&' may be used at the start of the name in either order so the value +&group means check the UNIX group database, followed by the NIS netgroup database, and - the value &+group means check the NIS + the value &+group means check the NIS netgroup database, followed by the UNIX group database (the same as the '@' prefix). @@ -3340,7 +3335,7 @@ - keepalive (G) + keepalive (G) The value of the parameter (an integer) represents the number of seconds between keepalive packets. If this parameter is zero, no keepalive packets will be @@ -3360,7 +3355,7 @@ - kernel oplocks (G) + kernel oplocks (G) For UNIXes that support kernel based oplocks (currently only IRIX and the Linux 2.4 kernel), this parameter @@ -3368,10 +3363,10 @@ Kernel oplocks support allows Samba oplocks to be broken whenever a local UNIX process or NFS operation - accesses a file that smbd(8) - has oplocked. This allows complete data consistency between - SMB/CIFS, NFS and local file access (and is a very - cool feature :-). + accesses a file that smbd + 8 has oplocked. This allows complete + data consistency between SMB/CIFS, NFS and local file access (and is + a very cool feature :-). This parameter defaults to on, but is translated to a no-op on systems that no not have the necessary kernel support. @@ -3389,12 +3384,12 @@ - lanman auth (G) - 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. + lanman auth (G) + This parameter determines whether or not smbd + 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. Default : lanman auth = yes @@ -3405,9 +3400,10 @@ - large readwrite (G) - This parameter determines whether or not smbd - supports the new 64k streaming read and write varient SMB requests introduced + large readwrite (G) + This parameter determines whether or not smbd + 8 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 @@ -3422,14 +3418,15 @@ - ldap admin dn (G) + ldap admin dn (G) The ldap admin dn defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information. The ldap admin dn is used in conjunction with the admin dn password stored in the private/secrets.tdb file. See the - smbpasswd(8) man - page for more information on how to accmplish this. + smbpasswd + 8 man page for more information on how + to accmplish this. @@ -3441,7 +3438,7 @@ - ldap filter (G) + ldap filter (G) 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 @@ -3455,7 +3452,7 @@ - ldap port (G) + ldap port (G) This parameter is only available if Samba has been configure to include the --with-ldapsam option at compile time. @@ -3477,7 +3474,7 @@ - ldap server (G) + ldap server (G) This parameter is only available if Samba has been configure to include the --with-ldapsam option at compile time. @@ -3494,7 +3491,7 @@ - ldap ssl (G) + ldap ssl (G) This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is NOT related to @@ -3528,7 +3525,7 @@ - ldap suffix (G) + ldap suffix (G) Specifies where user and machine accounts are added to the tree. Can be overriden by ldap user suffix and ldap machine suffix. It also used as the base dn for all ldap searches. @@ -3539,7 +3536,7 @@ - ldap user suffix (G) + ldap user suffix (G) It specifies where users are added to the tree. @@ -3552,7 +3549,7 @@ - ldap machine suffix (G) + ldap machine suffix (G) It specifies where machines should be added to the ldap tree. @@ -3564,7 +3561,7 @@ - ldap passwd sync (G) + ldap passwd sync (G) 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 @@ -3588,7 +3585,7 @@ - ldap trust ids (G) + ldap trust ids (G) Normally, Samba validates each entry in the LDAP server against getpwnam(). This allows LDAP to be used for Samba with the unix system using @@ -3607,7 +3604,7 @@ - level2 oplocks (S) + level2 oplocks (S) This parameter controls whether Samba supports level2 (read-only) oplocks on a share. @@ -3651,9 +3648,9 @@ - lm announce (G) - This parameter determines if - nmbd(8) will produce Lanman announce + lm announce (G) + This parameter determines if nmbd + 8 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 @@ -3678,7 +3675,7 @@ - lm interval (G) + lm interval (G) If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the lm announce parameter) then this @@ -3698,7 +3695,7 @@ - load printers (G) + load printers (G) A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default. See the printers section for @@ -3711,9 +3708,9 @@ - local master (G) - This option allows - nmbd(8) to try and become a local master browser + local master (G) + This option allows nmbd + 8 to try and become a local master browser on a subnet. If set to no then nmbd will not attempt to become a local master browser on a subnet and will also lose in all browsing elections. By @@ -3732,7 +3729,7 @@ - lock dir (G) + lock dir (G) Synonym for lock directory. @@ -3740,7 +3737,7 @@ - lock directory (G) + lock directory (G) This option specifies the directory where lock files will be placed. The lock files are used to implement the max connections @@ -3754,7 +3751,7 @@ - lock spin count (G) + lock spin count (G) 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 @@ -3773,7 +3770,7 @@ - lock spin time (G) + lock spin time (G) The time in microseconds that smbd should pause before attempting to gain a failed lock. See lock spin @@ -3787,7 +3784,7 @@ - locking (S) + locking (S) This controls whether or not locking will be performed by the server in response to lock requests from the client. @@ -3815,7 +3812,7 @@ - log file (G) + log file (G) This option allows you to override the name of the Samba log file (also known as the debug file). @@ -3829,7 +3826,7 @@ - log level (G) + log level (G) The value of the parameter (a astring) allows the debug level (logging level) to be specified in the smb.conf file. This parameter has been @@ -3847,7 +3844,7 @@ - logon drive (G) + logon drive (G) This parameter specifies the local path to which the home directory will be connected (see logon home) @@ -3864,7 +3861,7 @@ - logon home (G) + logon home (G) This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC. It allows you to do @@ -3906,7 +3903,7 @@ - logon path (G) + logon path (G) 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 @@ -3954,7 +3951,7 @@ - logon script (G) + logon script (G) 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 @@ -3996,7 +3993,7 @@ - lppause command (S) + lppause command (S) This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job. @@ -4040,7 +4037,7 @@ - lpq cache time (G) + lpq cache time (G) This controls how long lpq info will be cached for to prevent the lpq command being called too often. A separate cache is kept for each variation of the @@ -4069,7 +4066,7 @@ - lpq command (S) + lpq command (S) This parameter specifies the command to be executed on the server host in order to obtain lpq -style printer status information. @@ -4113,7 +4110,7 @@ - lpresume command (S) + lpresume command (S) 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. @@ -4153,7 +4150,7 @@ - lprm command (S) + lprm command (S) This parameter specifies the command to be executed on the server host in order to delete a print job. @@ -4183,7 +4180,7 @@ - machine password timeout (G) + machine password timeout (G) If a Samba server is a member of a Windows NT Domain (see the security = domain) parameter) then periodically a running @@ -4193,8 +4190,8 @@ will be changed, in seconds. The default is one week (expressed in seconds), the same as a Windows NT Domain member server. - See also smbpasswd(8) - , and the + See also smbpasswd + 8, and the security = domain) parameter. Default: machine password timeout = 604800 @@ -4203,7 +4200,7 @@ - magic output (S) + magic output (S) This parameter specifies the name of a file which will contain output created by a magic script (see the magic script @@ -4223,7 +4220,7 @@ - magic script (S) + magic script (S) 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 @@ -4254,7 +4251,7 @@ - mangle case (S) + mangle case (S) See the section on NAME MANGLING @@ -4264,7 +4261,7 @@ - mangled map (S) + mangled map (S) 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 @@ -4289,7 +4286,7 @@ - mangled names (S) + mangled names (S) 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. @@ -4348,7 +4345,7 @@ - mangling method (G) + mangling method (G) 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 @@ -4363,7 +4360,7 @@ - mangle prefix (G) + mangle prefix (G) controls the number of prefix characters from the original name used when generating the mangled names. A larger value will give a weaker @@ -4375,10 +4372,10 @@ - mangled stack (G) + mangled stack (G) This parameter controls the number of mangled names - that should be cached in the Samba server - smbd(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 @@ -4402,7 +4399,7 @@ - mangling char (S) + mangling char (S) This controls what character is used as the magic character in name mangling. The default is a '~' @@ -4419,7 +4416,7 @@ - map archive (S) + map archive (S) 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 @@ -4439,7 +4436,7 @@ - map hidden (S) + map hidden (S) This controls whether DOS style hidden files should be mapped to the UNIX world execute bit. @@ -4454,7 +4451,7 @@ - map system (S) + map system (S) This controls whether DOS style system files should be mapped to the UNIX group execute bit. @@ -4469,14 +4466,15 @@ - map to guest (G) + map to guest (G) This parameter is only useful in security modes other than security = share - i.e. user, server, and domain. This parameter can take three different values, which tell - smbd(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 : @@ -4524,7 +4522,7 @@ - max connections (S) + max connections (S) This option allows the number of simultaneous connections to a service to be limited. If max connections is greater than 0 then connections will be refused if @@ -4544,7 +4542,7 @@ - max disk size (G) + max disk size (G) 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 @@ -4571,7 +4569,7 @@ - max log size (G) + max log size (G) 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 @@ -4587,7 +4585,7 @@ - max mux (G) + max mux (G) 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. @@ -4599,9 +4597,10 @@ - max open files (G) + max open files (G) This parameter limits the maximum number of - open files that one smbd(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. @@ -4617,11 +4616,11 @@ - max print jobs (S) + max print jobs (S) This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment. - If this number is exceeded, - smbd(8) will remote "Out of Space" to the client. + If this number is exceeded, smbd + 8 will remote "Out of Space" to the client. See all total print jobs. @@ -4633,7 +4632,7 @@ - max protocol (G) + max protocol (G) The value of the parameter (a string) is the highest protocol level that will be supported by the server. @@ -4671,14 +4670,15 @@ - max smbd processes (G) + max smbd processes (G) This parameter limits the maximum number of smbd(8) 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 smbd associated with him or her + conditions, each user will have an smbd + 8 associated with him or her to handle connections to all shares from a given host. @@ -4691,8 +4691,9 @@ - max ttl (G) - This option tells nmbd(8) + max ttl (G) + This option tells nmbd + 8 what the default 'time to live' of NetBIOS names should be (in seconds) when nmbd is requesting a name using either a broadcast packet or from a WINS server. You should never need to @@ -4705,9 +4706,9 @@ - max wins ttl (G) - This option tells nmbd(8) - when acting as a WINS server ( + max wins ttl (G) + This option tells smbd + 8 when acting as a WINS server ( wins support = yes) what the maximum 'time to live' of NetBIOS names that nmbd will grant will be (in seconds). You should never need to change this @@ -4723,7 +4724,7 @@ - max xmit (G) + max xmit (G) 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 @@ -4738,7 +4739,7 @@ - message command (G) + message command (G) This specifies what command to run when the server receives a WinPopup style message. @@ -4748,13 +4749,13 @@ An example is: - message command = csh -c 'xedit %s;rm %s' & + message command = csh -c 'xedit %s;rm %s' & This delivers the message using xedit, then removes it afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY. That's why I - have the '&' on the end. If it doesn't return immediately then + have the '&' on the end. If it doesn't return immediately then your PCs may freeze when sending messages (they should recover after 30 seconds, hopefully). @@ -4799,7 +4800,7 @@ Default: no message command Example: message command = csh -c 'xedit %s; - rm %s' & + rm %s' & @@ -4807,7 +4808,7 @@ - min passwd length (G) + min passwd length (G) Synonym for min password length. @@ -4816,7 +4817,7 @@ - min password length (G) + min password length (G) This option sets the minimum length in characters of a plaintext password that smbd will accept when performing UNIX password changing. @@ -4834,7 +4835,7 @@ - min print space (S) + min print space (S) 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 @@ -4852,7 +4853,7 @@ - min protocol (G) + min protocol (G) The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support. Please refer to the max protocol @@ -4876,8 +4877,9 @@ - min wins ttl (G) - This option tells nmbd(8) + min wins ttl (G) + This option tells nmbd + 8 when acting as a WINS server ( wins support = yes) what the minimum 'time to live' of NetBIOS names that nmbd will grant will be (in @@ -4890,7 +4892,7 @@ - msdfs proxy (S) + msdfs proxy (S) 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 @@ -4901,7 +4903,7 @@ and host msdfs options to find out how to set up a Dfs root share. - Example: msdfs proxy = \otherserver\someshare + Example: msdfs proxy = \\\\otherserver\\someshare @@ -4909,17 +4911,17 @@ - msdfs root (S) + msdfs root (S) This boolean parameter is only available if Samba is configured and compiled with the --with-msdfs 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 msdfs:serverA\shareA,serverB\shareB + links of the form msdfs:serverA\\shareA,serverB\\shareB and so on. For more information on setting up a Dfs tree - on Samba, refer to msdfs_setup.html - . + on Samba, refer to "Hosting a Microsoft + Distributed File System tree on Samba" document. See also host msdfs @@ -4929,7 +4931,7 @@ - name cache timeout (G) + name cache timeout (G) 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. @@ -4942,7 +4944,7 @@ - name resolve order (G) + name resolve order (G) 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 @@ -4995,7 +4997,7 @@ - netbios aliases (G) + netbios aliases (G) 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 @@ -5016,7 +5018,7 @@ - netbios name (G) + netbios name (G) 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 @@ -5035,7 +5037,7 @@ - netbios scope (G) + netbios scope (G) 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. @@ -5044,7 +5046,7 @@ - nis homedir (G) + nis homedir (G) 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 @@ -5077,7 +5079,7 @@ - non unix account range (G) + non unix account range (G) 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 @@ -5101,7 +5103,7 @@ - nt acl support (S) + nt acl support (S) This boolean parameter controls whether smbd(8) will attempt to map UNIX permissions into Windows NT access control lists. @@ -5115,9 +5117,10 @@ - nt pipe support (G) + nt pipe support (G) This boolean parameter controls whether - smbd(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. @@ -5129,7 +5132,7 @@ - nt status support (G) + nt status support (G) This boolean parameter controls whether smbd(8) will negotiate NT specific status support with Windows NT/2k/XP clients. This is a developer @@ -5146,11 +5149,12 @@ - null passwords (G) + null passwords (G) Allow or disallow client access to accounts that have null passwords. - See also smbpasswd (5). + See also smbpasswd + 5. Default: null passwords = no @@ -5160,7 +5164,7 @@ - obey pam restrictions (G) + obey pam restrictions (G) 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 @@ -5181,7 +5185,7 @@ - only user (S) + only user (S) This is a boolean option that controls whether connections with usernames not in the user list will be allowed. By default this option is disabled so that a @@ -5209,7 +5213,7 @@ - only guest (S) + only guest (S) A synonym for guest only. @@ -5218,7 +5222,7 @@ - oplock break wait time (G) + oplock break wait time (G) 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 @@ -5236,15 +5240,15 @@ - oplock contention limit (S) + oplock contention limit (S) This is a very 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 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 + In brief it specifies a number, which causes smbd + 8not 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 smbd to behave in a similar way to Windows NT. @@ -5260,7 +5264,7 @@ - oplocks (S) + oplocks (S) This boolean option tells smbd whether to issue oplocks (opportunistic locks) to file open requests on this share. The oplock code can dramatically (approx. 30% or more) improve @@ -5288,13 +5292,16 @@ - ntlm auth (G) - This parameter determines whether or not smbd will + ntlm auth (G) + This parameter determines + whether or not smbd + 8 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 lanman auth should be enabled in order to be able to log in. + Please note that at least this option or lanman auth should + be enabled in order to be able to log in. Default : ntlm auth = yes @@ -5302,10 +5309,11 @@ - os level (G) + os level (G) This integer value controls what level Samba advertises itself as for browse elections. The value of this - parameter determines whether nmbd(8) + parameter determines whether nmbd + 8 has a chance of becoming a local master browser for the WORKGROUP in the local broadcast area. @@ -5325,7 +5333,7 @@ - os2 driver map (G) + os2 driver map (G) 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: @@ -5338,10 +5346,9 @@ LaserJet 5L. The need for the file is due to the printer driver namespace - problem described in the Samba + 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: os2 driver map = <empty string> @@ -5350,7 +5357,7 @@ - pam password change (G) + pam password change (G) 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 @@ -5368,12 +5375,12 @@ - panic action (G) + panic action (G) This is a Samba developer option that allows a - system command to be called when either - smbd(8) or nmbd(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 or smbd + 8 crashes. This is usually used to + draw attention to the fact that a problem occurred. Default: panic action = <empty string> Example: panic action = "/bin/sleep 90000" @@ -5381,7 +5388,7 @@ - paranoid server security (G) + paranoid server security (G) 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 @@ -5394,7 +5401,7 @@ - passdb backend (G) + passdb backend (G) 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. @@ -5487,13 +5494,13 @@ - passwd chat (G) + passwd chat (G) This string controls the "chat" - conversation that takes places between smbd and the local password changing + conversation that takes places between smbd + 8 and the local password changing program to change the user's password. The string describes a - sequence of response-receive pairs that - smbd(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 passwd program and what to expect back. If the expected output is not received then the password is not changed. @@ -5515,8 +5522,8 @@ The string can contain the macro %n 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 @@ -5538,10 +5545,10 @@ passwd chat debug and pam password change. - Default: passwd chat = *new*password* %n\n - *new*password* %n\n *changed* - Example: passwd chat = "*Enter OLD password*" %o\n - "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password + Default: passwd chat = *new*password* %n\\n + *new*password* %n\\n *changed* + Example: passwd chat = "*Enter OLD password*" %o\\n + "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password changed*" @@ -5549,11 +5556,12 @@ - passwd chat debug (G) + passwd chat debug (G) This boolean specifies if the passwd chat script parameter is run in debug mode. In this mode the strings passed to and received from the passwd chat are printed - in the smbd(8) log with a + in the smbd + 8 log with a debug level of 100. This is a dangerous option as it will allow plaintext passwords to be seen in the smbd log. It is available to help @@ -5576,7 +5584,7 @@ - passwd program (G) + passwd program (G) The name of a program that can be used to set UNIX user passwords. Any occurrences of %u will be replaced with the user name. The user name is checked for @@ -5614,7 +5622,7 @@ - password level (G) + password level (G) 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 @@ -5657,7 +5665,7 @@ - password server (G) + password server (G) By specifying the name of another SMB server (such as a WinNT box) with this option, and using security = domain or security = server you can get Samba @@ -5752,7 +5760,7 @@ - path (S) + path (S) 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 @@ -5783,7 +5791,7 @@ - pid directory (G) + pid directory (G) This option specifies the directory where pid files will be placed. @@ -5795,8 +5803,9 @@ - posix locking (S) - The smbd(8) + posix locking (S) + The smbd + 8 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 @@ -5812,7 +5821,7 @@ - postexec (S) + postexec (S) 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 @@ -5837,7 +5846,7 @@ - postscript (S) + postscript (S) This parameter forces a printer to interpret the print files as PostScript. This is done by adding a %! to the start of print output. @@ -5853,7 +5862,7 @@ - preexec (S) + preexec (S) This option specifies a command to be run whenever the service is connected to. It takes the usual substitutions. @@ -5862,12 +5871,12 @@ is an example: preexec = csh -c 'echo \"Welcome to %S!\" | - /usr/local/samba/bin/smbclient -M %m -I %I' & + /usr/local/samba/bin/smbclient -M %m -I %I' & Of course, this could get annoying after a while :-) See also preexec close - and postexec + and postexec . Default: none (no command executed) @@ -5879,7 +5888,7 @@ - preexec close (S) + preexec close (S) This boolean option controls whether a non-zero return code from preexec should close the service being connected to. @@ -5890,7 +5899,7 @@ - preferred master (G) + preferred master (G) This boolean parameter controls if nmbd(8) is a preferred master browser for its workgroup. @@ -5919,7 +5928,7 @@ - prefered master (G) + prefered master (G) Synonym for preferred master for people who cannot spell :-). @@ -5928,7 +5937,7 @@ - preload (G) + preload (G) 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 @@ -5946,7 +5955,7 @@ - preserve case (S) + preserve case (S) This controls if new filenames are created with the case that the client passes, or if they are forced to be the default case @@ -5962,7 +5971,7 @@ - print command (S) + print command (S) After a print job has finished spooling to a service, this command will be used via a system() call to process the spool file. Typically the command specified will @@ -6052,7 +6061,7 @@ - print ok (S) + print ok (S) Synonym for printable. @@ -6062,7 +6071,7 @@ - printable (S) + printable (S) If this parameter is yes, then clients may open, write to and submit spool files on the directory specified for the service. @@ -6080,7 +6089,7 @@ - printcap (G) + printcap (G) Synonym for printcap name. @@ -6090,7 +6099,7 @@ - printcap name (G) + printcap name (G) This parameter may be used to override the compiled-in default printcap name used by the server (usually /etc/printcap). See the discussion of the A minimal printcap file would look something like this: - - 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 + where the '|' separates aliases of a printer. The fact that the second alias has a space in it gives a hint to Samba @@ -6143,7 +6152,7 @@ - printer admin (S) + printer admin (S) 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 @@ -6160,11 +6169,11 @@ - printer driver (S) + printer driver (S) Note :This 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 + the Samba 2.2. Printing HOWTO for more information on the new method of loading printer drivers onto a Samba server. @@ -6193,11 +6202,11 @@ - printer driver file (G) + printer driver file (G) Note :This 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 + the Samba 2.2. Printing HOWTO for more information on the new method of loading printer drivers onto a Samba server. @@ -6229,11 +6238,11 @@ - printer driver location (S) + printer driver location (S) Note :This 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 + the Samba 2.2. Printing HOWTO for more information on the new method of loading printer drivers onto a Samba server. @@ -6263,7 +6272,7 @@ - printer name (S) + printer name (S) This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent. @@ -6280,7 +6289,7 @@ - printer (S) + printer (S) Synonym for printer name. @@ -6289,7 +6298,7 @@ - printing (S) + printing (S) This parameters controls how printer status information is interpreted on your system. It also affects the default values for the print command, @@ -6320,7 +6329,7 @@ - private dir (G) + private dir (G) This parameters defines the directory smbd will use for storing such files as smbpasswd and secrets.tdb. @@ -6334,7 +6343,7 @@ - protocol (G) + protocol (G) Synonym for max protocol. @@ -6343,7 +6352,7 @@ - public (S) + public (S) Synonym for guest ok. @@ -6352,7 +6361,7 @@ - queuepause command (S) + queuepause command (S) This parameter specifies the command to be executed on the server host in order to pause the printer queue. @@ -6381,7 +6390,7 @@ - queueresume command (S) + queueresume command (S) 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 @@ -6416,7 +6425,7 @@ - read bmpx (G) + read bmpx (G) This boolean parameter controls whether smbd(8) will support the "Read Block Multiplex" SMB. This is now rarely used and defaults to @@ -6431,7 +6440,7 @@ - read list (S) + read list (S) 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 - read only (S) + read only (S) An inverted synonym is writeable. @@ -6472,7 +6481,7 @@ - read raw (G) + read raw (G) This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients. @@ -6495,7 +6504,7 @@ - read size (G) + read size (G) The option read size affects the overlap of disk reads/writes with network reads/writes. If the amount of data being transferred in several of the SMB @@ -6522,7 +6531,7 @@ - realm (G) + realm (G) This option specifies the kerberos realm to use. The realm is used as the ADS equivalent of the NT4domain. It @@ -6535,7 +6544,7 @@ - remote announce (G) + remote announce (G) This option allows you to setup nmbd(8) to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name. @@ -6560,7 +6569,7 @@ 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.txt + See the documentation file BROWSING in the docs/ directory. Default: remote announce = <empty string> @@ -6571,7 +6580,7 @@ - remote browse sync (G) + remote browse sync (G) This option allows you to setup nmbd(8) to periodically request synchronization of browse lists with the master browser of a Samba @@ -6609,7 +6618,7 @@ - restrict anonymous (G) + restrict anonymous (G) This is a integer parameter, and mirrors as much as possible the functinality the RestrictAnonymous @@ -6622,7 +6631,7 @@ - root (G) + root (G) Synonym for root directory". @@ -6631,7 +6640,7 @@ - root dir (G) + root dir (G) Synonym for root directory". @@ -6639,7 +6648,7 @@ - root directory (G) + root directory (G) The server will chroot() (i.e. Change its root directory) to this directory on startup. This is not strictly necessary for secure operation. Even without it the @@ -6671,7 +6680,7 @@ - root postexec (S) + root postexec (S) This is the same as the postexec parameter except that the command is run as root. This is useful for unmounting filesystems @@ -6686,7 +6695,7 @@ - root preexec (S) + root preexec (S) This is the same as the preexec parameter except that the command is run as root. This is useful for mounting filesystems (such as CDROMs) when a @@ -6704,7 +6713,7 @@ - root preexec close (S) + root preexec close (S) This is the same as the preexec close parameter except that the command is run as root. @@ -6718,14 +6727,14 @@ - security (G) + security (G) This option affects how clients respond to Samba and is one of the most important settings in the smb.conf file. The option sets the "security mode bit" in replies to - protocol negotiations with smbd(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. @@ -6770,7 +6779,7 @@ The different settings will now be explained. - SECURITY = SHARE + SECURITY = SHARE When clients connect to a share level security server they @@ -6839,7 +6848,7 @@ See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. - SECURITY = USER + SECURITY = USER This is the default security setting in Samba 2.2. @@ -6866,7 +6875,7 @@ See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. - SECURITY = SERVER + SECURITY = SERVER In this mode Samba will try to validate the username/password @@ -6902,11 +6911,11 @@ linkend="ENCRYPTPASSWORDS">encrypted passwords parameter. - SECURITY = DOMAIN + SECURITY = DOMAIN - This mode will only work correctly if smbpasswd(8) has been used to add this + This mode will only work correctly if smbpasswd + 8 has been used to add this machine into a Windows NT Domain. It expects the encrypted passwords parameter to be set to yes. In this @@ -6956,7 +6965,7 @@ - security mask (S) + security mask (S) 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 @@ -6991,7 +7000,7 @@ - server string (G) + server string (G) This controls what string will show up in the printer comment box in print manager and next to the IPC connection in net view. It can be any string that you wish @@ -7016,7 +7025,7 @@ - set directory (S) + set directory (S) If set directory = no, then users of the service may not use the setdir command to change directory. @@ -7032,7 +7041,7 @@ - share modes (S) + share modes (S) This enables or disables the honoring of the share modes during a file open. These modes are used by clients to gain exclusive read or write access @@ -7061,7 +7070,7 @@ - short preserve case (S) + short preserve case (S) 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 @@ -7081,7 +7090,7 @@ - show add printer wizard (G) + show add printer wizard (G) 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 @@ -7116,7 +7125,7 @@ - shutdown script (G) + shutdown script (G) This parameter only exists in the HEAD cvs branch This a full path name to a script called by smbd(8) that @@ -7142,15 +7151,15 @@ Default: None. Example: abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f Shutdown script example: - - #!/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 & + Shutdown does not return so we need to launch it in background. @@ -7160,7 +7169,7 @@ - smb passwd file (G) + smb passwd file (G) This option sets the path to the encrypted smbpasswd file. By default the path to the smbpasswd file is compiled into Samba. @@ -7175,7 +7184,7 @@ - smb ports (G) + smb ports (G) Specifies which ports the server should listen on for SMB traffic. @@ -7186,7 +7195,7 @@ - socket address (G) + socket address (G) 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 @@ -7203,7 +7212,7 @@ - socket options (G) + socket options (G) This option allows you to set socket options to be used when talking with the client. @@ -7276,7 +7285,7 @@ - source environment (G) + source environment (G) This parameter causes Samba to set environment variables as per the content of the file named. @@ -7298,17 +7307,23 @@ /usr/local/smb_env_vars - -use spnego (G) - 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: use spnego = yes - - - stat cache (G) - This parameter determines if smbd(8) will use a cache in order to + use spnego (G) + 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: use spnego = yes + + + + + stat cache (G) + 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. @@ -7317,7 +7332,7 @@ - stat cache size (G) + stat cache size (G) This parameter determines the number of entries in the stat cache. You should never need to change this parameter. @@ -7329,7 +7344,7 @@ - strict allocate (S) + strict allocate (S) 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 @@ -7353,7 +7368,7 @@ - strict locking (S) + strict locking (S) 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 @@ -7373,7 +7388,7 @@ - strict sync (S) + strict sync (S) 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 @@ -7381,7 +7396,8 @@ 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 smbd ignores the Windows applications requests for + default) means that smbd + 8 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 @@ -7397,7 +7413,7 @@ - strip dot (G) + strip dot (G) 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. @@ -7409,7 +7425,7 @@ - sync always (S) + sync always (S) 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 @@ -7431,7 +7447,7 @@ - syslog (G) + syslog (G) 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 @@ -7451,7 +7467,7 @@ - syslog only (G) + syslog only (G) If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files. @@ -7463,7 +7479,7 @@ - template homedir (G) + template homedir (G) 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. @@ -7479,9 +7495,10 @@ - template shell (G) + template shell (G) When filling out the user information for a Windows NT - user, the winbindd(8) daemon + user, the winbindd + 8 daemon uses this parameter to fill in the login shell for that user. Default: template shell = /bin/false @@ -7491,7 +7508,7 @@ - time offset (G) + time offset (G) 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 @@ -7505,9 +7522,9 @@ - time server (G) - This parameter determines if - nmbd(8) advertises itself as a time server to Windows + time server (G) + This parameter determines if nmbd + 8 advertises itself as a time server to Windows clients. Default: time server = no @@ -7516,7 +7533,7 @@ - timestamp logs (G) + timestamp logs (G) Synonym for debug timestamp. @@ -7527,16 +7544,17 @@ - total print jobs (G) + total print jobs (G) 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 smbd will return an + by a client which will exceed this number, then smbd + 8 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 designed as a printing throttle. See also - max print jobs. + max print jobs. Default: total print jobs = 0 @@ -7545,7 +7563,7 @@ - unicode (G) + unicode (G) 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! @@ -7557,19 +7575,19 @@ - unix charset (G) + unix charset (G) 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: unix charset = ASCII - Example: unix charset = UTF8 + Default: unix charset = UTF8 + Example: unix charset = ASCII - unix extensions(G) + unix extensions(G) 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 @@ -7585,7 +7603,7 @@ - unix password sync (G) + unix password sync (G) 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. @@ -7606,7 +7624,7 @@ - update encrypted (G) + update encrypted (G) 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 @@ -7637,7 +7655,7 @@ - use client driver (S) + use client driver (S) 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 @@ -7675,7 +7693,7 @@ - use mmap (G) + use mmap (G) 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 @@ -7693,7 +7711,7 @@ - use rhosts (G) + use rhosts (G) If this global parameter is yes, it specifies that the UNIX user's .rhosts file in their home directory will be read to find the names of hosts and users who will be allowed @@ -7713,7 +7731,7 @@ - user (S) + user (S) Synonym for username. @@ -7722,7 +7740,7 @@ - users (S) + users (S) Synonym for username. @@ -7730,7 +7748,7 @@ - username (S) + username (S) 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). @@ -7771,7 +7789,7 @@ 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. @@ -7795,7 +7813,7 @@ - username level (G) + username level (G) 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 @@ -7818,7 +7836,7 @@ - username map (G) + username map (G) 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 @@ -7881,10 +7899,10 @@ '!' to tell Samba to stop processing if it gets a match on that line. - - !sys = mary fred - guest = * - + +!sys = mary fred +guest = * + Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \\server\fred and @@ -7910,7 +7928,7 @@ - use sendfile (S) + use sendfile (S) 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 @@ -7927,7 +7945,7 @@ - utmp (G) + utmp (G) This boolean parameter is only available if Samba has been configured and compiled with the option --with-utmp. If set to yes then Samba will attempt @@ -7949,7 +7967,7 @@ - utmp directory(G) + utmp directory(G) This parameter is only available if Samba has been configured and compiled with the option --with-utmp. It specifies a directory pathname that is @@ -7966,7 +7984,7 @@ - wtmp directory(G) + wtmp directory(G) This parameter is only available if Samba has been configured and compiled with the option --with-utmp. It specifies a directory pathname that is @@ -7988,9 +8006,9 @@ - valid users (S) + valid users (S) This is a list of users that should be allowed - to login to this service. Names starting with '@', '+' and '&' + to login to this service. Names starting with '@', '+' and '&' are interpreted using the same rules as described in the invalid users parameter. @@ -8015,7 +8033,7 @@ - veto files(S) + veto files(S) 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 @@ -8063,7 +8081,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - veto oplock files (S) + veto oplock files (S) This parameter is only valid when the oplocks parameter is turned on for a share. It allows the Samba administrator @@ -8089,7 +8107,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - vfs path (S) + vfs path (S) This parameter specifies the directory to look in for vfs modules. The name of every vfs object will be prepended by this directory @@ -8102,7 +8120,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - vfs object (S) + vfs object (S) 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 @@ -8116,7 +8134,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - vfs options (S) + vfs options (S) This parameter allows parameters to be passed to the vfs layer at initialization time. See also @@ -8129,7 +8147,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - volume (S) + volume (S) 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. @@ -8141,7 +8159,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - wide links (S) + wide links (S) 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 @@ -8160,9 +8178,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - winbind cache time (G) - This parameter specifies the number of seconds the - winbindd(8) daemon will cache + winbind cache time (G) + This parameter specifies the number of + seconds the winbindd + 8 daemon will cache user and group information before querying a Windows NT server again. @@ -8172,11 +8191,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - winbind enum users (G) - On large installations using - winbindd(8) it may be - necessary to suppress the enumeration of users through the - setpwent(), + winbind enum users (G) + On large installations using winbindd + 8 it may be + necessary to suppress the enumeration of users through the setpwent(), getpwent() and endpwent() group of system calls. If the winbind enum users parameter is @@ -8194,11 +8212,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - winbind enum groups (G) - On large installations using - winbindd(8) it may be - necessary to suppress the enumeration of groups through the - setgrent(), + winbind enum groups (G) + On large installations using winbindd + 8 it may be necessary to suppress + the enumeration of groups through the setgrent(), getgrent() and endgrent() group of system calls. If the winbind enum groups parameter is @@ -8215,10 +8232,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - winbind gid (G) + winbind gid (G) The winbind gid parameter specifies the range of group - ids that are allocated by the - winbindd(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. @@ -8231,7 +8248,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - winbind separator (G) + winbind separator (G) This parameter allows an admin to define the character used when listing a username of the form of DOMAIN \user. This parameter @@ -8252,10 +8269,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - winbind uid (G) + winbind uid (G) The winbind gid parameter specifies the range of group - ids that are allocated by the - winbindd(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. @@ -8268,12 +8285,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - winbind use default domain - - winbind use default domain (G) - This parameter specifies whether the - winbindd(8) - daemon should operate on users without domain component in their username. + winbind use default domain (G) + 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. @@ -8286,7 +8301,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - wins hook (G) + wins hook (G) 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 @@ -8334,7 +8349,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - wins proxy (G) + wins proxy (G) 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 @@ -8348,10 +8363,10 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - wins server (G) + wins server (G) This specifies the IP address (or DNS name: IP - address for preference) of the WINS server that - nmbd(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 @@ -8361,7 +8376,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ to a WINS server if you have multiple subnets and wish cross-subnet browsing to work correctly. - See the documentation file BROWSING.txt + See the documentation file BROWSING in the docs/ directory of your Samba source distribution. Default: not enabled @@ -8372,9 +8387,9 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - wins support (G) - This boolean controls if the - nmbd(8) process in Samba will act as a WINS server. You should + wins support (G) + 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 nmbd to be your WINS server. Note that you should NEVER set this to yes @@ -8387,7 +8402,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - workgroup (G) + workgroup (G) 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 - writable (S) + writable (S) Synonym for writeable for people who can't spell :-). @@ -8412,7 +8427,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - write cache size (S) + write cache size (S) If this integer parameter is set to non-zero value, Samba will create an in-memory cache for each oplocked file (it does not do this for @@ -8444,7 +8459,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - write list (S) + write list (S) 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 - wins partners (G) + wins partners (G) 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. @@ -8485,7 +8500,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - write ok (S) + write ok (S) Inverted synonym for read only. @@ -8494,7 +8509,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - write raw (G) + write raw (G) 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. @@ -8506,7 +8521,7 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - writeable (S) + writeable (S) Inverted synonym for read only. @@ -8526,8 +8541,8 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ problem - but be aware of the possibility. On a similar note, many clients - especially DOS clients - - limit service names to eight characters. smbd(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. @@ -8542,22 +8557,22 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ VERSION - 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. SEE ALSO - samba(7), - smbpasswd(8), - swat(8), - smbd(8), - nmbd(8), - smbclient(1), - nmblookup(1), - testparm(1), - testprns(1) - + + samba + 7, smbpasswd + 8, swat + 8, smbd + 8, nmbd + 8, smbclient + 1, nmblookup + 1, testparm + 1, testprns + 1. @@ -8570,11 +8585,11 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbcacls.1.sgml b/docs/docbook/manpages/smbcacls.1.sgml index 766d2a78b1..5e0e6c80e9 100644 --- a/docs/docbook/manpages/smbcacls.1.sgml +++ b/docs/docbook/manpages/smbcacls.1.sgml @@ -1,5 +1,5 @@ - + smbcacls @@ -32,8 +32,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. The smbcacls program manipulates NT Access Control Lists (ACLs) on SMB file shares. @@ -90,7 +90,8 @@ 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 smb.conf file is + workgroup specified in the smb.conf + 5 file is used, or "username%password" or "DOMAIN\username%password" and the password and workgroup names are used as provided. @@ -147,12 +148,12 @@ The format of an ACL is one or more ACL entries separated by either commas or newlines. An ACL entry is one of the following: - + REVISION:<revision number> OWNER:<sid or name> GROUP:<sid or name> ACL:<sid or name>:<type>/<flags>/<mask> - + The revision of the ACL specifies the internal Windows @@ -165,24 +166,22 @@ ACL:<sid or name>:<type>/<flags>/<mask> otherwise the name specified is resolved using the server on which the file or directory resides. - ACLs specify permissions granted to the SID. This SID again - can be specified in CWS-1-x-y-z format or as a name in which case - it is resolved against the server on which the file or directory - resides. The type, flags and mask values determine the type of - access granted to the SID. - - The type can be either 0 or 1 corresponding to ALLOWED or - DENIED access to the SID. The flags values are generally - zero for file ACLs and either 9 or 2 for directory ACLs. Some - common flags are: - - - #define SEC_ACE_FLAG_OBJECT_INHERIT 0x1 - #define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2 - #define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4 - - #define SEC_ACE_FLAG_INHERIT_ONLY 0x8 - + ACLs specify permissions granted to the SID. This SID again + can be specified in CWS-1-x-y-z format or as a name in which case + it is resolved against the server on which the file or directory + resides. The type, flags and mask values determine the type of + access granted to the SID. + + The type can be either 0 or 1 corresponding to ALLOWED or + DENIED access to the SID. The flags values are generally + zero for file ACLs and either 9 or 2 for directory ACLs. Some + common flags are: + + + #define SEC_ACE_FLAG_OBJECT_INHERIT 0x1 + #define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2 + #define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4 + #define SEC_ACE_FLAG_INHERIT_ONLY 0x8 At present flags can only be specified as decimal or @@ -233,8 +232,7 @@ ACL:<sid or name>:<type>/<flags>/<mask> VERSION - 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. @@ -249,7 +247,8 @@ ACL:<sid or name>:<type>/<flags>/<mask> and Tim Potter. The conversion to DocBook for Samba 2.2 was done - by Gerald Carter + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done + by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbclient.1.sgml b/docs/docbook/manpages/smbclient.1.sgml index 43994a4529..7e908e5d70 100644 --- a/docs/docbook/manpages/smbclient.1.sgml +++ b/docs/docbook/manpages/smbclient.1.sgml @@ -1,5 +1,5 @@ - + smbclient @@ -44,12 +44,13 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. smbclient is a client that can 'talk' to an SMB/CIFS server. It offers an interface - similar to that of the ftp program (see ftp(1)). + similar to that of the ftp program (see ftp + 1). 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 @@ -81,7 +82,9 @@ The server name is looked up according to either the -R parameter to smbclient or - using the name resolve order parameter in the smb.conf file, + using the name resolve order parameter in + the smb.conf + 5 file, allowing an administrator to change the order and methods by which server names are looked up. @@ -113,15 +116,17 @@ -s smb.conf - Specifies the location of the all important - smb.conf file. + Specifies the location of the all + important smb.conf + 5 file. -O socket options TCP socket options to set on the client - socket. See the socket options parameter in the - smb.conf (5) manpage for the list of valid + socket. See the socket options parameter in + the smb.conf + 5 manual page for the list of valid options. @@ -134,44 +139,51 @@ 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: - 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 lmhosts(5) for details) then - any name type matches for lookup. - - host : Do a standard host + no name type attached to the NetBIOS name (see + the lmhosts + 5 for details) then + any name type matches for lookup. + + + host: Do a standard host name to IP address resolution, using the system /etc/hosts , 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 /etc/nsswitch.conf 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. - - wins : Query a name with + it is ignored. + + + wins: Query a name with the IP address listed in the wins server parameter. If no WINS server has - been specified this method will be ignored. - - bcast : Do a broadcast on + been specified this method will be ignored. + + + bcast: Do a broadcast on each of the known local interfaces listed in the interfaces parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally - connected subnet. + connected subnet. + If this parameter is not set then the name resolve order - defined in the smb.conf file parameter + defined in the smb.conf + 5 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 name resolve order - parameter of the smb.conf file the name resolution + parameter of the smb.conf + 5 file the name resolution methods will be attempted in this order. @@ -202,8 +214,8 @@ -I options useful, as they allow you to control the FROM and TO parts of the message. - See the message command parameter in the - smb.conf(5) for a description of how to handle incoming + See the message command parameter in the smb.conf + 5 for a description of how to handle incoming WinPopup messages in Samba. Note: Copy WinPopup into the startup group @@ -379,11 +391,11 @@ password used in the connection. The format of the file is - + username = <value> password = <value> domain = <value> - + If the domain parameter is missing the current workgroup name @@ -435,9 +447,9 @@ domain = <value> -W WORKGROUP Override the default workgroup (domain) specified - in the workgroup parameter of the smb.conf - file for this connection. This may be needed to connect to some - servers. + in the workgroup parameter of the smb.conf + 5 file for this connection. This may be + needed to connect to some servers. @@ -519,7 +531,7 @@ domain = <value> Tar Filenames - 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). @@ -587,7 +599,7 @@ domain = <value> smb:\> - 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. @@ -1040,8 +1052,8 @@ domain = <value> and writeable only by the user. To test the client, you will need to know the name of a - running SMB/CIFS server. It is possible to run smbd(8) - as an ordinary user - running that server as a daemon + running SMB/CIFS server. It is possible to run smbd + 8 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. @@ -1063,8 +1075,7 @@ domain = <value> VERSION - 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. @@ -1078,11 +1089,11 @@ domain = <value> 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbcontrol.1.sgml b/docs/docbook/manpages/smbcontrol.1.sgml index 166ef63e87..6632e07269 100644 --- a/docs/docbook/manpages/smbcontrol.1.sgml +++ b/docs/docbook/manpages/smbcontrol.1.sgml @@ -1,5 +1,5 @@ - + smbcontrol @@ -29,14 +29,14 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. smbcontrol is a very small program, which - sends messages to an smbd(8), - an nmbd(8) - or a winbindd(8) - daemon running on the system. + sends messages to a smbd + 8, a nmbd + 8, or a winbindd + 8 daemon running on the system. @@ -54,8 +54,7 @@ destination - One of nmbd - smbd or a process ID. + One of nmbd, smbd or a process ID. The smbd destination causes the message to "broadcast" to all smbd daemons. @@ -190,9 +189,9 @@ SEE ALSO - nmbd(8), - and smbd(8). - + nmbd + 8 and smbd + 8. @@ -205,11 +204,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbd.8.sgml b/docs/docbook/manpages/smbd.8.sgml index 9fb80901be..32837ba903 100644 --- a/docs/docbook/manpages/smbd.8.sgml +++ b/docs/docbook/manpages/smbd.8.sgml @@ -1,5 +1,5 @@ - + smbd @@ -32,7 +32,8 @@ DESCRIPTION - This program is part of the Samba suite. + This program is part of the Samba + 7 suite. smbd is the server daemon that provides filesharing and printing services to Windows clients. @@ -46,15 +47,14 @@ 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 smb.conf(5) - . This man page will not describe the + services (see smb.conf + 5. This man page will not describe the services, but will concentrate on the administrative aspects of running the server. Please note that there are significant security - implications to running this server, and the smb.conf(5) - manpage should be regarded as mandatory reading before + implications to running this server, and the smb.conf + 5 manual page should be regarded as mandatory reading before proceeding with installation. A session is created whenever a client requests one. @@ -160,9 +160,9 @@ data, most of which is extremely cryptic. Note that specifying this parameter here will - override the log - level parameter in the - smb.conf(5) file. + override the log + level parameter in the smb.conf + 5 file. @@ -175,9 +175,9 @@ messages from the running server. The log file generated is never removed by the server although its size may be controlled by the max log size - option in the - smb.conf(5) file. Beware: + url="smb.conf.5.html#maxlogsize">max log size + option in the smb.conf + 5 file. Beware: If the directory specified does not exist, smbd will log to the default debug log location defined at compile time. @@ -189,9 +189,9 @@ -O <socket options> See the socket options - parameter in the smb.conf(5) - file for details. + url="smb.conf.5.html#socketoptions">socket options + parameter in the smb.conf + 5 file for details. @@ -226,8 +226,8 @@ 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 - smb.conf(5) for more information. + to provide. See smb.conf + 5 for more information. The default configuration file name is determined at compile time. @@ -243,7 +243,7 @@ If the server is to be run by the inetd meta-daemon, this file must contain suitable startup information for the - meta-daemon. See the UNIX_INSTALL.html + meta-daemon. See the "How to Install and Test SAMBA" document for details. @@ -255,7 +255,7 @@ If running the server as a daemon at startup, this file will need to contain an appropriate startup - sequence for the server. See the UNIX_INSTALL.html + sequence for the server. See the "How to Install and Test SAMBA" document for details. @@ -265,21 +265,20 @@ meta-daemon inetd, 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 UNIX_INSTALL.html + See the "How to Install and Test SAMBA" document for details. /usr/local/samba/lib/smb.conf - This is the default location of the - smb.conf - server configuration file. Other common places that systems + This is the default location of the smb.conf + 5 server configuration file. Other common places that systems install this file are /usr/samba/lib/smb.conf - and /etc/smb.conf. + and /etc/samba/smb.conf. This file describes all the services the server - is to make available to clients. See - smb.conf(5) for more information. + is to make available to clients. See smb.conf + 5 for more information. @@ -317,9 +316,9 @@ 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 - obey pam restricions - smb.conf paramater. When this is set, the following restrictions apply: + by the limitations of the SMB protocol and the obey + pam restricions smb.conf + 5 paramater. When this is set, the following restrictions apply: @@ -379,9 +378,9 @@ it to die on its own. The debug log level of smbd may be raised - or lowered using smbcontrol(1) - program (SIGUSR[1|2] signals are no longer used in - Samba 2.2). This is to allow transient problems to be diagnosed, + or lowered using smbcontrol + 1 program (SIGUSR[1|2] signals are no longer + used since Samba 2.2). This is to allow transient problems to be diagnosed, whilst still running at a normally low log level. Note that as the signal handlers send a debug write, @@ -394,14 +393,15 @@ SEE ALSO - hosts_access(5), inetd(8), - nmbd(8), - smb.conf(5) - , smbclient(1) - , - testparm(1), - testprns(1), and the Internet RFC's - rfc1001.txt, rfc1002.txt. + hosts_access + 5, inetd + 8, nmbd + 8, smb.conf + 5, smbclient + 1, testparm + 1, testprns + 1, and the + Internet RFC's rfc1001.txt, rfc1002.txt. In addition the CIFS (formerly SMB) specification is available as a link from the Web page http://samba.org/cifs/. @@ -417,11 +417,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbgroupedit.8.sgml b/docs/docbook/manpages/smbgroupedit.8.sgml index 188218c249..6c489bb785 100644 --- a/docs/docbook/manpages/smbgroupedit.8.sgml +++ b/docs/docbook/manpages/smbgroupedit.8.sgml @@ -1,15 +1,11 @@ - + smbgroupedit 8 - - smbgroupedit Query/set/change UNIX - Windows NT group mapping @@ -25,17 +21,13 @@ - DESCRIPTION -This program is part of the Samba -suite. - +This program is part of the Samba +7 suite. The smbgroupedit command allows for mapping unix groups @@ -70,8 +62,8 @@ etc. Privilege : -For examples, - +For example: + Users SID : S-1-5-32-545 Unix group: -1 @@ -91,9 +83,8 @@ Users NTGroupName(SID) -> UnixGroupName -For example, - - +For example: + Users (S-1-5-32-545) -> -1 @@ -109,8 +100,6 @@ Users (S-1-5-32-545) -> -1 - FILES @@ -120,8 +109,6 @@ Users (S-1-5-32-545) -> -1 - EXIT STATUS @@ -163,65 +150,45 @@ the 'Domain Admins' Global group: domadm:x:502:joe,john,mary - map this domadm group to the 'domain admins' group: - + map this domadm group to the 'domain admins' group: - Get the SID for the Windows NT "Domain Admins" - group: - + Get the SID for the Windows NT "Domain Admins" group: root# smbgroupedit -vs | grep "Domain Admins" 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: - - - + root# smbgroupedit \ -c S-1-5-21-1108995562-3116817432-1375597819-512 \ -u domadm -td - - warning: don't copy and paste this sample, the + warning: don't copy and paste this sample, the Domain Admins SID (the S-1-5-21-...-512) is different for every PDC. - - + To verify that your mapping has taken effect: - - - + root# smbgroupedit -vs|grep "Domain Admins" Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> domadm - -To give access to a certain directory on a domain member machine (an +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: - - - + root# smbgroupedit -a unixgroup -td - - - - - - VERSION @@ -232,22 +199,16 @@ the Samba suite. - - SEE ALSO -smb.conf(5) - +smb.conf +5 - - AUTHOR @@ -261,7 +222,8 @@ to the way the Linux kernel is developed. smbgroupedit 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. +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. diff --git a/docs/docbook/manpages/smbmnt.8.sgml b/docs/docbook/manpages/smbmnt.8.sgml index 55b66d5d25..6d48b12b9b 100644 --- a/docs/docbook/manpages/smbmnt.8.sgml +++ b/docs/docbook/manpages/smbmnt.8.sgml @@ -1,5 +1,5 @@ - + smbmnt @@ -38,8 +38,8 @@ by the user, and that the user has write permission on. The smbmnt program is normally invoked - by smbmount(8) - . It should not be invoked directly by users. + by smbmount + 8. It should not be invoked directly by users. smbmount searches the normal PATH for smbmnt. You must ensure that the smbmnt version in your path matches the smbmount used. @@ -107,7 +107,8 @@ The conversion of this manpage for Samba 2.2 was performed - by Gerald Carter + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbmount.8.sgml b/docs/docbook/manpages/smbmount.8.sgml index c4b91a5572..d17e4e6bcf 100644 --- a/docs/docbook/manpages/smbmount.8.sgml +++ b/docs/docbook/manpages/smbmount.8.sgml @@ -1,5 +1,5 @@ - + smbmount @@ -26,7 +26,8 @@ smbmount mounts a Linux SMB filesystem. It is usually invoked as mount.smbfs by - the mount(8) command when using the + the mount + 8 command when using the "-t smbfs" option. This command only works in Linux, and the kernel must support the smbfs filesystem. @@ -39,11 +40,12 @@ smbmount 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 log.smbmount. The - smbmount process may also be called mount.smbfs. + typically this output will end up in log.smbmount. The + smbmount process may also be called mount.smbfs. NOTE: smbmount - calls smbmnt(8) to do the actual mount. You + calls smbmnt + 8 to do the actual mount. You must make sure that smbmnt is in the path so that it can be found. @@ -84,15 +86,12 @@ credentials=<filename> - specifies a file that contains a username - and/or password. The format of the file is: - - - - username = <value> - password = <value> - - + specifies a file that contains a username and/or password. +The format of the file is: + +username = <value> +password = <value> + This is preferred over having passwords in plaintext in a shared file, such as /etc/fstab. Be sure to protect any @@ -174,8 +173,8 @@ sockopt=<arg> sets the TCP socket options. See the smb.conf - socket options option. + url="smb.conf.5.html#SOCKETOPTIONS">smb.conf + 5 socket options option. @@ -298,10 +297,9 @@ FreeBSD also has a smbfs, but it is not related to smbmount - For Solaris, HP-UX and others you may want to look at - smbsh(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 smbsh + 1 or at other solutions, such as + Sharity or perhaps replacing the SMB server with a NFS server. @@ -321,7 +319,8 @@ The conversion of this manpage for Samba 2.2 was performed - by Gerald Carter + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbpasswd.5.sgml b/docs/docbook/manpages/smbpasswd.5.sgml index 5c80ac4c06..f78e986bef 100644 --- a/docs/docbook/manpages/smbpasswd.5.sgml +++ b/docs/docbook/manpages/smbpasswd.5.sgml @@ -1,5 +1,5 @@ - + smbpasswd @@ -19,8 +19,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. smbpasswd is the Samba encrypted password file. It contains the username, Unix user id and the SMB hashed passwords of the @@ -122,7 +122,7 @@ 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 characters. + The contents of this field may be any of the following characters: @@ -136,12 +136,11 @@ Password Hash and NT Password Hash are ignored). Note that this will only allow users to log on with no password if the null passwords parameter is set in the smb.conf(5) - config file. + url="smb.conf.5.html#NULLPASSWORDS">smb.conf + 5 config file. D - 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. W - This means this account is a "Workstation Trust" account. This kind of account is used @@ -178,8 +177,9 @@ SEE ALSO - smbpasswd(8), - samba(7), and + smbpasswd + 8, Samba + 7, and the Internet RFC1321 for details on the MD4 algorithm. @@ -194,11 +194,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbpasswd.8.sgml b/docs/docbook/manpages/smbpasswd.8.sgml index 8e6d925ae0..5d475cf08c 100644 --- a/docs/docbook/manpages/smbpasswd.8.sgml +++ b/docs/docbook/manpages/smbpasswd.8.sgml @@ -1,5 +1,5 @@ - + smbpasswd @@ -37,25 +37,27 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. The smbpasswd program has several different - functions, depending on whether it is run by the root - user or not. When run as a normal user it allows the user to change + functions, depending on whether it is run by the root 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. 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 passwd(1) program works. - smbpasswd differs from how the passwd program works + similar to the way the passwd(1) program works. + smbpasswd differs from how the passwd program works however in that it is not setuid root but works in - a client-server mode and communicates with a locally running - smbd(8). As a consequence in order for this to + a client-server mode and communicates with a + locally running smbd + 8. 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 smbpasswd(5) file. + the smbpasswd + 5 file. When run by an ordinary user with no options, smbpasswd will prompt them for their old SMB password and then ask them @@ -67,12 +69,13 @@ smbpasswd can also be used by a normal user to change their SMB password on remote machines, such as Windows NT Primary Domain - Controllers. See the (-r) and -U options below. + Controllers. See the (-r) and -U options + below. 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, - smbpasswd accesses the local smbpasswd file + the attributes of the user in this file to be made. When run by root, + smbpasswd accesses the local smbpasswd file directly, thus enabling changes to be made even if smbd is not running. @@ -121,8 +124,8 @@ 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 smbpasswd(5) - for details on the 'old' and new password file formats. + this information and the command will FAIL. See smbpasswd + 5 for details on the 'old' and new password file formats. This option is only available when running smbpasswd as @@ -140,7 +143,8 @@ If the smbpasswd file is in the 'old' format, then smbpasswd will FAIL to enable the account. - See smbpasswd (5) for + See smbpasswd + 5 for details on the 'old' and new password file formats. This option is only available when running smbpasswd as root. @@ -226,15 +230,15 @@ 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: - 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 lmhosts(5) for details) then + no name type attached to the NetBIOS name (see the lmhosts + 5 for details) then any name type matches for lookup. - host : Do a standard host + host: Do a standard host name to IP address resolution, using the system /etc/hosts , NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this @@ -243,12 +247,12 @@ type being queried is the 0x20 (server) name type, otherwise it is ignored. - wins : Query a name with + wins: Query a name with the IP address listed in the wins server parameter. If no WINS server has been specified this method will be ignored. - bcast : Do a broadcast on + bcast: Do a broadcast on each of the known local interfaces listed in the interfaces parameter. This is the least reliable of the name resolution methods as it depends on the @@ -256,8 +260,8 @@ The default order is lmhosts, host, wins, bcast - and without this parameter or any entry in the - smb.conf file the name resolution methods will + and without this parameter or any entry in the smb.conf + 5 file the name resolution methods will be attempted in this order. @@ -292,7 +296,6 @@ - -s This option causes smbpasswd to be silent (i.e. @@ -312,7 +315,7 @@ switch is used to specify the password to be used with the ldap admin dn. Note that the password is stored in - the private/secrets.tdb and is keyed off + the secrets.tdb and is keyed off of the admin's DN. This means that if the value of ldap admin dn ever changes, the password will need to be manually updated as well. @@ -355,14 +358,15 @@ 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 - smbd running on the local machine by specifying a - allow hosts or deny hosts - entry in the smb.conf file and neglecting to + smbd running on the local machine by specifying either allow + hosts or deny hosts entry in + the smb.conf + 5 file and neglecting to allow "localhost" access to the smbd. In addition, the smbpasswd command is only useful if Samba - has been set up to use encrypted passwords. See the file - ENCRYPTION.txt in the docs directory for details + has been set up to use encrypted passwords. See the document + "LanMan and NT Password Encryption in Samba" in the docs directory for details on how to do this. @@ -370,15 +374,14 @@ VERSION - 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. SEE ALSO - smbpasswd(5), - samba(7) - + smbpasswd + 5, Samba + 7. @@ -391,11 +394,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbsh.1.sgml b/docs/docbook/manpages/smbsh.1.sgml index c40609be4f..af080c298c 100644 --- a/docs/docbook/manpages/smbsh.1.sgml +++ b/docs/docbook/manpages/smbsh.1.sgml @@ -1,5 +1,5 @@ - + smbsh @@ -29,8 +29,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. smbsh allows you to access an NT filesystem using UNIX commands such as ls, @@ -46,7 +46,8 @@ -W WORKGROUP Override the default workgroup specified in the - workgroup parameter of the smb.conf file + workgroup parameter of the smb.conf + 5 file for this session. This may be needed to connect to some servers. @@ -61,7 +62,8 @@ - -P prefixThis option allows + -P prefix + This option allows the user to set the directory prefix for SMB access. The default value if this option is not specified is smb. @@ -75,19 +77,20 @@ 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 : - 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 lmhosts(5) - for details) then any name type matches for lookup. + (see the lmhosts + 5 for details) + then any name type matches for lookup. - host : + host: Do a standard host name to IP address resolution, using the system /etc/hosts, NIS, or DNS lookups. This method of name resolution is operating @@ -98,14 +101,14 @@ (server) name type, otherwise it is ignored. - wins : + wins: Query a name with the IP address listed in the wins server parameter. If no WINS server has been specified this method will be ignored. - bcast : + bcast: Do a broadcast on each of the known local interfaces listed in the interfaces parameter. This is the least reliable of the name @@ -115,14 +118,15 @@ If this parameter is not set then the name resolve order - defined in the smb.conf file parameter - (name resolve order) will be used. + defined in the smb.conf + 5 file parameter + (name resolve order) will be used. The default order is lmhosts, host, wins, bcast. Without this parameter or any entry in the name resolve order - parameter of the smb.conf - file, the name resolution methods will be attempted in this - order. + parameter of the smb.conf + 5 file, the name resolution methods + will be attempted in this order. @@ -133,7 +137,8 @@ is zero. The higher this value, the more detail will be logged - about the activities of nmblookup. At level + about the activities of nmblookup + 1. At level 0, only critical errors and serious warnings will be logged. @@ -164,13 +169,12 @@ To use the smbsh command, execute smbsh from the prompt and enter the username and password that authenticates you to the machine running the Windows NT - operating system. - - - system% smbsh - Username: user - Password: XXXXXXX - + operating system. + +system% smbsh +Username: user +Password: XXXXXXX + Any dynamically linked command you execute from @@ -188,8 +192,7 @@ VERSION - 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. @@ -210,9 +213,9 @@ SEE ALSO - smbd(8), - smb.conf(5) - + smbd + 8, smb.conf + 5 @@ -225,11 +228,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbspool.8.sgml b/docs/docbook/manpages/smbspool.8.sgml index d164cb0864..f30539601e 100644 --- a/docs/docbook/manpages/smbspool.8.sgml +++ b/docs/docbook/manpages/smbspool.8.sgml @@ -1,5 +1,5 @@ - + smbspool @@ -27,8 +27,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. smbspool is a very small print spooling program that sends a print file to an SMB printer. The command-line arguments @@ -45,10 +45,8 @@ smb://server/printer smb://workgroup/server/printer - smb://username:password@server/printer - - smb://username:password@workgroup/server/printer - + smb://username:password@server/printer + smb://username:password@workgroup/server/printer smbspool tries to get the URI from argv[0]. If argv[0] @@ -97,15 +95,14 @@ VERSION - 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. SEE ALSO - smbd(8), - and samba(7). - + smbd + 8 and Samba + 7. @@ -121,11 +118,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbstatus.1.sgml b/docs/docbook/manpages/smbstatus.1.sgml index 99963a4bec..67d39f2586 100644 --- a/docs/docbook/manpages/smbstatus.1.sgml +++ b/docs/docbook/manpages/smbstatus.1.sgml @@ -1,5 +1,5 @@ - + smbstatus @@ -31,8 +31,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. smbstatus is a very simple program to list the current Samba connections. @@ -84,8 +84,8 @@ -p|--processes - print a list of - smbd(8) processes and exit. + print a list of smbd + 8 processes and exit. Useful for scripting. @@ -102,9 +102,9 @@ -s|--conf=<configuration file> The default configuration file name is determined at compile time. The file specified contains the - configuration details required by the server. See smb.conf(5) - for more information. + configuration details required by the server. See + smb.conf5 + for more information. @@ -128,8 +128,9 @@ SEE ALSO - smbd(8) and - smb.conf(5). + smbd + 8 and smb.conf + 5. @@ -142,11 +143,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbtar.1.sgml b/docs/docbook/manpages/smbtar.1.sgml index bd70493b6b..ffb5087347 100644 --- a/docs/docbook/manpages/smbtar.1.sgml +++ b/docs/docbook/manpages/smbtar.1.sgml @@ -1,5 +1,5 @@ - + smbtar @@ -37,12 +37,12 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. smbtar is a very small shell script on top - of smbclient(1) - which dumps SMB shares directly to tape. + of smbclient1 + which dumps SMB shares directly to tape. @@ -144,8 +144,9 @@ -l log level Log (debug) level. Corresponds to the - -d flag of smbclient(1) - . + -d flag of + smbclient1 + . @@ -181,9 +182,9 @@ DIAGNOSTICS - See the DIAGNOSTICS section for the - smbclient(1) - command. + See the DIAGNOSTICS section for the + smbclient1 + command. @@ -196,10 +197,11 @@ SEE ALSO - smbd(8), - smbclient(1), - smb.conf(5), - + smbd + 8, + smbclient1 + , smb.conf + 5. @@ -216,11 +218,11 @@ url="mailto:Martin.Kraemer@mch.sni.de">Martin Kraemer. 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 - + excellent piece of Open Source software, available at 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. + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/smbumount.8.sgml b/docs/docbook/manpages/smbumount.8.sgml index d6a1b65b57..089ede79ea 100644 --- a/docs/docbook/manpages/smbumount.8.sgml +++ b/docs/docbook/manpages/smbumount.8.sgml @@ -1,5 +1,5 @@ - + smbumount @@ -47,8 +47,8 @@ SEE ALSO - smbmount(8) - + smbmount + 8 @@ -67,7 +67,8 @@ The conversion of this manpage for Samba 2.2 was performed - by Gerald Carter + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/swat.8.sgml b/docs/docbook/manpages/swat.8.sgml index c0052f3d53..9c4daad6d0 100644 --- a/docs/docbook/manpages/swat.8.sgml +++ b/docs/docbook/manpages/swat.8.sgml @@ -1,5 +1,5 @@ - + swat @@ -23,13 +23,13 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. swat allows a Samba administrator to - configure the complex - smb.conf(5) file via a Web browser. In addition, + configure the complex smb.conf + 5 file via a Web browser. In addition, a swat configuration page has help links to all the configurable options in the smb.conf file allowing an administrator to easily look up the effects of any change. @@ -46,8 +46,9 @@ -s smb configuration file The default configuration file path is determined at compile time. The file specified contains - the configuration details required by the smbd - server. This is the file that swat will modify. + the configuration details required by the smbd + 8 server. This is the file + that swat 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. @@ -152,8 +153,9 @@ /usr/local/samba/lib/smb.conf - This is the default location of the smb.conf(5) - server configuration file that swat edits. Other + This is the default location of the + smb.conf5 + server configuration file that swat edits. Other common places that systems install this file are /usr/samba/lib/smb.conf and /etc/smb.conf . This file describes all the services the server @@ -166,8 +168,9 @@ WARNINGS - swat will rewrite your smb.conf - file. It will rearrange the entries and delete all + swat will rewrite your + smb.conf5 + file. It will rearrange the entries and delete all comments, include= and copy= options. If you have a carefully crafted smb.conf then back it up or don't use swat! @@ -177,16 +180,15 @@ VERSION - 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. SEE ALSO - inetd(5), - smbd(8), - smb.conf(5) - + inetd(5), + smbd8 + , smb.conf + 5 @@ -199,11 +201,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/testparm.1.sgml b/docs/docbook/manpages/testparm.1.sgml index f34528a43d..ec8092a926 100644 --- a/docs/docbook/manpages/testparm.1.sgml +++ b/docs/docbook/manpages/testparm.1.sgml @@ -1,5 +1,5 @@ - + testparm @@ -29,11 +29,12 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. testparm is a very simple test program - to check an smbd configuration file for + to check an smbd + 8 configuration file for internal correctness. If this program reports no problems, you can use the configuration file with confidence that smbd will successfully load the configuration file. @@ -82,9 +83,9 @@ -v If this option is specified, testparm - will also output all options that were not used in - smb.conf and are thus set to - their defaults. + will also output all options that were not used in + smb.conf5 + and are thus set to their defaults. @@ -98,7 +99,8 @@ configfilename This is the name of the configuration file to check. If this parameter is not present then the - default smb.conf file will be checked. + default smb.conf5 + file will be checked. @@ -108,7 +110,9 @@ If this parameter and the following are specified, then testparm will examine the hosts allow and hosts deny - parameters in the smb.conf file to + parameters in the + smb.conf5 + file to determine if the hostname with this IP address would be allowed access to the smbd server. If this parameter is supplied, the hostIP parameter must also @@ -130,9 +134,11 @@ - smb.conf + smb.conf5 + This is usually the name of the configuration - file used by smbd. + file used by smbd8 + . @@ -158,9 +164,11 @@ SEE ALSO - smb.conf(5), - smbd(8) - + + smb.conf5 + , + smbd8 + @@ -173,11 +181,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/testprns.1.sgml b/docs/docbook/manpages/testprns.1.sgml index cd99494a9a..85cc860c4a 100644 --- a/docs/docbook/manpages/testprns.1.sgml +++ b/docs/docbook/manpages/testprns.1.sgml @@ -1,5 +1,5 @@ - + testprns @@ -23,13 +23,13 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. testprns is a very simple test program to determine whether a given printer name is valid for use in - a service to be provided by - smbd(8). + a service to be provided by smbd + 8. "Valid" in this context means "can be found in the printcap specified". This program is very stupid - so stupid in @@ -54,8 +54,9 @@ done beyond that required to extract the printer name. It may be that the print spooling system is more forgiving or less forgiving than testprns. However, if - testprns finds the printer then - smbd should do so as well. + testprns finds the printer then + smbd8 + should do so as well. @@ -117,9 +118,9 @@ SEE ALSO printcap(5), - smbd(8), - smbclient(1) - + smbd + 8, smbclient + 1 @@ -132,11 +133,11 @@ 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 - + excellent piece of Open Source software, available at 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 + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/vfstest.1.sgml b/docs/docbook/manpages/vfstest.1.sgml index d6c7e5f142..c89035d814 100644 --- a/docs/docbook/manpages/vfstest.1.sgml +++ b/docs/docbook/manpages/vfstest.1.sgml @@ -1,8 +1,7 @@ %globalentities; ]> - - + vfstest @@ -28,8 +27,8 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. vfstest is a small command line utility that has the ability to test dso samba VFS modules. It gives the diff --git a/docs/docbook/manpages/wbinfo.1.sgml b/docs/docbook/manpages/wbinfo.1.sgml index a6ca244243..5003c847a4 100644 --- a/docs/docbook/manpages/wbinfo.1.sgml +++ b/docs/docbook/manpages/wbinfo.1.sgml @@ -1,5 +1,5 @@ - + wbinfo @@ -37,14 +37,15 @@ DESCRIPTION - This tool is part of the - Samba suite. + This tool is part of the Samba + 7 suite. The wbinfo program queries and returns information - created and used by the - winbindd(8) daemon. + created and used by the winbindd + 8 daemon. - The winbindd(8) daemon must be configured + The winbindd + 8 daemon must be configured and running for the wbinfo program to be able to return information. @@ -56,27 +57,30 @@ -u This option will list all users available - in the Windows NT domain for which the winbindd(8) - daemon is operating in. Users in all trusted domains + in the Windows NT domain for which the winbindd + 8 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 - winbindd(8). + user ids to any users that have not already been seen by + winbindd8 + . -g This option will list all groups available - in the Windows NT domain for which the winbindd(8) - daemon is operating in. Groups in all trusted domains + in the Windows NT domain for which the Samba + 7 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 - winbindd(8). + group ids to any groups that have not already been + seen by winbindd + 8. -N name The -N option - queries winbindd(8) to query the WINS + queries winbindd + 8 to query the WINS server for the IP address associated with the NetBIOS name specified by the name parameter. @@ -86,7 +90,8 @@ -I ip The -I option - queries winbindd(8) to send a node status + queries winbindd + 8 to send a node status request to get the NetBIOS name associated with the IP address specified by the ip parameter. @@ -96,13 +101,15 @@ -n name The -n option - queries winbindd(8) for the SID + queries winbindd + 8 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 smb.conf - workgroup parameter. + domain used is the one specified in the smb.conf + 5 workgroup + parameter. @@ -135,16 +142,18 @@ -S sid Convert a SID to a UNIX user id. If the SID - does not correspond to a UNIX user mapped by - winbindd(8) then the operation will fail. + does not correspond to a UNIX user mapped by + winbindd8 + then the operation will fail. -Y sid Convert a SID to a UNIX group id. If the SID - does not correspond to a UNIX group mapped by - winbindd(8) then the operation will fail. + does not correspond to a UNIX group mapped by + winbindd8 then + the operation will fail. @@ -160,7 +169,8 @@ -m Produce a list of domains trusted by the - Windows NT server winbindd(8) contacts + Windows NT server winbindd + 8 contacts when resolving names. This list does not include the Windows NT domain the server is a Primary Domain Controller for. @@ -201,8 +211,9 @@ EXIT STATUS The wbinfo program returns 0 if the operation - succeeded, or 1 if the operation failed. If the winbindd(8) - daemon is not working wbinfo will always return + succeeded, or 1 if the operation failed. If the + winbindd8 + daemon is not working wbinfo will always return failure. @@ -216,8 +227,8 @@ SEE ALSO - winbindd(8) - + winbindd + 8 @@ -232,7 +243,8 @@ were written by Tim Potter. The conversion to DocBook for Samba 2.2 was done - by Gerald Carter + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba + 3.0 was done by Alexander Bokovoy. diff --git a/docs/docbook/manpages/winbindd.8.sgml b/docs/docbook/manpages/winbindd.8.sgml index ccef2fa623..68f41afead 100644 --- a/docs/docbook/manpages/winbindd.8.sgml +++ b/docs/docbook/manpages/winbindd.8.sgml @@ -1,5 +1,5 @@ - + winbindd @@ -29,8 +29,8 @@ DESCRIPTION - This program is part of the - Samba suite. + This program is part of the Samba + 7 suite. winbindd is a daemon that provides a service for the Name Service Switch capability that is present @@ -88,12 +88,11 @@ /etc/nsswitch.conf file can be used to initially resolve user and group information from /etc/passwd and /etc/group and then from the - Windows NT server. - - + Windows NT server. + passwd: files winbind group: files winbind - + The following simple configuration in the /etc/nsswitch.conf file can be used to initially @@ -172,7 +171,8 @@ group: files winbind -s|--conf=smb.conf Specifies the location of the all-important - smb.conf file. + smb.conf + 5 file. @@ -208,8 +208,9 @@ group: files winbind CONFIGURATION Configuration of the winbindd daemon - is done through configuration parameters in the smb.conf(5) - file. All parameters should be specified in the + is done through configuration parameters in the + smb.conf5 + file. All parameters should be specified in the [global] section of smb.conf. @@ -243,27 +244,24 @@ group: files winbind following setup. This was tested on a RedHat 6.2 Linux box. In /etc/nsswitch.conf put the - following: - - + following: + passwd: files winbind group: files winbind - - - In /etc/pam.d/* replace the - auth lines with something like this: + - - + In /etc/pam.d/* replace the + auth lines with something like this: + 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 - + - Note in particular the use of the sufficient - keyword and the use_first_pass keyword. + Note in particular the use of the sufficient + keyword and the use_first_pass keyword. Now replace the account lines with this: @@ -282,17 +280,17 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok for "PDC". Next copy libnss_winbind.so to - /lib and pam_winbind.so - to /lib/security. A symbolic link needs to be + /lib and pam_winbind.so + to /lib/security. A symbolic link needs to be made from /lib/libnss_winbind.so to /lib/libnss_winbind.so.2. If you are using an older version of glibc then the target of the link should be /lib/libnss_winbind.so.1. - Finally, setup a smb.conf containing directives like the - following: - - + Finally, setup a smb.conf + 5 containing directives like the + following: + [global] winbind separator = + winbind cache time = 10 @@ -303,7 +301,7 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok workgroup = DOMAIN security = domain password server = * - + Now start winbindd and you should find that your user and @@ -321,9 +319,10 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok The following notes are useful when configuring and running winbindd: - nmbd must be running on the local machine - for winbindd to work. winbindd - queries the list of trusted domains for the Windows NT server + nmbd + 8 must be running on the local machine + for winbindd to work. winbindd queries + the list of trusted domains for the Windows NT server on startup and when a SIGHUP is received. Thus, for a running winbindd to become aware of new trust relationships between servers, it must be sent a SIGHUP signal. @@ -357,8 +356,9 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok SIGHUP - Reload the smb.conf(5) - file and apply any parameter changes to the running + Reload the smb.conf + 5 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. @@ -431,10 +431,13 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok SEE ALSO - nsswitch.conf(5), - samba(7), - wbinfo(1), - smb.conf(5) + nsswitch.conf(5), + Samba + 7, + wbinfo + 8, + smb.conf + 5 @@ -445,11 +448,12 @@ auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. - wbinfo and winbindd - were written by Tim Potter. + wbinfo and winbindd were + written by Tim Potter. The conversion to DocBook for Samba 2.2 was done - by Gerald Carter + by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy. -- cgit