Samba 3: added Samba 3.0.24 sources
[tomato.git] / release / src / router / samba3 / docs / manpages / samba.7
blob5671f889c8d4489422b9387ba63a37b7cbe602bf
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
20 .TH "SAMBA" 7 "" "" ""
21 .SH "NAME"
22 samba - A Windows SMB/CIFS fileserver for UNIX
23 .SH "SYNOPSIS"
24 .HP 6
25 \fBsamba\fR
26 .SH "DESCRIPTION"
27 .PP
28 The Samba software suite is a collection of programs that implements the Server Message Block (commonly abbreviated as SMB) protocol for UNIX systems. This protocol is sometimes also referred to as the Common Internet File System (CIFS). For a more thorough description, see
29 http://www.ubiqx.org/cifs/. Samba also implements the NetBIOS protocol in nmbd.
30 .TP 3n
31 \fBsmbd\fR(8)
32 The
33 \fBsmbd\fR
34 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
35 \fBsmb.conf\fR(5)
36 .TP 3n
37 \fBnmbd\fR(8)
38 The
39 \fBnmbd\fR
40 daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon is described in
41 \fBsmb.conf\fR(5)
42 .TP 3n
43 \fBsmbclient\fR(1)
44 The
45 \fBsmbclient\fR
46 program implements a simple ftp-like client. This is useful for accessing SMB shares on other compatible servers (such as Windows NT), and can also be used to allow a UNIX box to print to a printer attached to any SMB server (such as a PC running Windows NT).
47 .TP 3n
48 \fBtestparm\fR(1)
49 The
50 \fBtestparm\fR
51 utility is a simple syntax checker for Samba's
52 \fBsmb.conf\fR(5)
53 configuration file.
54 .TP 3n
55 \fBtestprns\fR(1)
56 The
57 \fBtestprns\fR
58 utility supports testing printer names defined in your
59 \fIprintcap\fR
60 file used by Samba.
61 .TP 3n
62 \fBsmbstatus\fR(1)
63 The
64 \fBsmbstatus\fR
65 tool provides access to information about the current connections to
66 \fBsmbd\fR.
67 .TP 3n
68 \fBnmblookup\fR(1)
69 The
70 \fBnmblookup\fR
71 tools allows NetBIOS name queries to be made from a UNIX host.
72 .TP 3n
73 \fBsmbpasswd\fR(8)
74 The
75 \fBsmbpasswd\fR
76 command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers.
77 .TP 3n
78 \fBsmbcacls\fR(1)
79 The
80 \fBsmbcacls\fR
81 command is a tool to set ACL's on remote CIFS servers.
82 .TP 3n
83 \fBsmbsh\fR(1)
84 The
85 \fBsmbsh\fR
86 command is a program that allows you to run a unix shell with with an overloaded VFS.
87 .TP 3n
88 \fBsmbtree\fR(1)
89 The
90 \fBsmbtree\fR
91 command is a text-based network neighborhood tool.
92 .TP 3n
93 \fBsmbtar\fR(1)
94 The
95 \fBsmbtar\fR
96 can make backups of data on CIFS/SMB servers.
97 .TP 3n
98 \fBsmbspool\fR(8)
99 \fBsmbspool\fR
100 is a helper utility for printing on printers connected to CIFS servers.
101 .TP 3n
102 \fBsmbcontrol\fR(1)
103 \fBsmbcontrol\fR
104 is a utility that can change the behaviour of running samba daemons.
105 .TP 3n
106 \fBrpcclient\fR(1)
107 \fBrpcclient\fR
108 is a utility that can be used to execute RPC commands on remote CIFS servers.
109 .TP 3n
110 \fBpdbedit\fR(8)
112 \fBpdbedit\fR
113 command can be used to maintain the local user database on a samba server.
114 .TP 3n
115 \fBfindsmb\fR(1)
117 \fBfindsmb\fR
118 command can be used to find SMB servers on the local network.
119 .TP 3n
120 \fBnet\fR(8)
122 \fBnet\fR
123 command is supposed to work similar to the DOS/Windows NET.EXE command.
124 .TP 3n
125 \fBswat\fR(8)
126 \fBswat\fR
127 is a web-based interface to configuring
128 \fIsmb.conf\fR.
129 .TP 3n
130 \fBwinbindd\fR(8)
131 \fBwinbindd\fR
132 is a daemon that is used for integrating authentication and the user database into unix.
133 .TP 3n
134 \fBwbinfo\fR(1)
135 \fBwbinfo\fR
136 is a utility that retrieves and stores information related to winbind.
137 .TP 3n
138 \fBprofiles\fR(1)
139 \fBprofiles\fR
140 is a command-line utility that can be used to replace all occurences of a certain SID with another SID.
141 .TP 3n
142 \fBlog2pcap\fR(1)
143 \fBlog2pcap\fR
144 is a utility for generating pcap trace files from Samba log files.
145 .TP 3n
146 \fBvfstest\fR(1)
147 \fBvfstest\fR
148 is a utility that can be used to test vfs modules.
149 .TP 3n
150 \fBntlm_auth\fR(1)
151 \fBntlm_auth\fR
152 is a helper-utility for external programs wanting to do NTLM-authentication.
153 .TP 3n
154 \fBsmbmount\fR(8), \fBsmbumount\fR(8), \fBsmbmnt\fR(8)
155 \fBsmbmount\fR,\fBsmbumount\fR
157 \fBsmbmnt\fR
158 are commands that can be used to mount CIFS/SMB shares on Linux.
159 .TP 3n
160 \fBsmbcquotas\fR(1)
161 \fBsmbcquotas\fR
162 is a tool that can set remote QUOTA's on server with NTFS 5.
163 .SH "COMPONENTS"
165 The Samba suite is made up of several components. Each component is described in a separate manual page. It is strongly recommended that you read the documentation that comes with Samba and the manual pages of those components that you use. If the manual pages and documents aren't clear enough then please visit
166 http://devel.samba.org
167 for information on how to file a bug report or submit a patch.
169 If you require help, visit the Samba webpage at
170 http://www.samba.org/
171 and explore the many option available to you.
172 .SH "AVAILABILITY"
174 The Samba software suite is licensed under the GNU Public License(GPL). A copy of that license should have come with the package in the file COPYING. You are encouraged to distribute copies of the Samba suite, but please obey the terms of this license.
176 The latest version of the Samba suite can be obtained via anonymous ftp from samba.org in the directory pub/samba/. It is also available on several mirror sites worldwide.
178 You may also find useful information about Samba on the newsgroup
179 comp.protocol.smb
180 and the Samba mailing list. Details on how to join the mailing list are given in the README file that comes with Samba.
182 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
183 http://lists.samba.org.
184 .SH "VERSION"
186 This man page is correct for version 3.0 of the Samba suite.
187 .SH "CONTRIBUTIONS"
189 If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at
190 http://lists.samba.org.
192 If you have patches to submit, visit
193 http://devel.samba.org/
194 for information on how to do it properly. We prefer patches in
195 \fBdiff -u\fR
196 format.
197 .SH "CONTRIBUTORS"
199 Contributors to the project are now too numerous to mention here but all deserve the thanks of all Samba users. To see a full list, look at the
200 \fIchange-log\fR
201 in the source package for the pre-CVS changes and at
202 http://cvs.samba.org/
203 for the contributors to Samba post-CVS. CVS is the Open Source source code control system used by the Samba Team to develop Samba. The project would have been unmanageable without it.
204 .SH "AUTHOR"
206 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
208 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
209 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.