include updates
[tomato.git] / release / src-rt-6.x.4708 / router / samba-3.0.25b / docs / manpages / samba.7
blobb2f284cbd023ed4f1d280a3de81349044d266051
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 1
25 samba
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 .PP
31 \fBsmbd\fR(8)
32 .RS 3n
33 The
34 smbd
35 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
36 \fBsmb.conf\fR(5)
37 .RE
38 .PP
39 \fBnmbd\fR(8)
40 .RS 3n
41 The
42 nmbd
43 daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon is described in
44 \fBsmb.conf\fR(5)
45 .RE
46 .PP
47 \fBsmbclient\fR(1)
48 .RS 3n
49 The
50 smbclient
51 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).
52 .RE
53 .PP
54 \fBtestparm\fR(1)
55 .RS 3n
56 The
57 testparm
58 utility is a simple syntax checker for Samba's
59 \fBsmb.conf\fR(5)
60 configuration file.
61 .RE
62 .PP
63 \fBtestprns\fR(1)
64 .RS 3n
65 The
66 testprns
67 utility supports testing printer names defined in your
68 \fIprintcap\fR
69 file used by Samba.
70 .RE
71 .PP
72 \fBsmbstatus\fR(1)
73 .RS 3n
74 The
75 smbstatus
76 tool provides access to information about the current connections to
77 smbd.
78 .RE
79 .PP
80 \fBnmblookup\fR(1)
81 .RS 3n
82 The
83 nmblookup
84 tools allows NetBIOS name queries to be made from a UNIX host.
85 .RE
86 .PP
87 \fBsmbpasswd\fR(8)
88 .RS 3n
89 The
90 smbpasswd
91 command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers.
92 .RE
93 .PP
94 \fBsmbcacls\fR(1)
95 .RS 3n
96 The
97 smbcacls
98 command is a tool to set ACL's on remote CIFS servers.
99 .RE
101 \fBsmbsh\fR(1)
102 .RS 3n
104 smbsh
105 command is a program that allows you to run a unix shell with with an overloaded VFS.
108 \fBsmbtree\fR(1)
109 .RS 3n
111 smbtree
112 command is a text-based network neighborhood tool.
115 \fBsmbtar\fR(1)
116 .RS 3n
118 smbtar
119 can make backups of data on CIFS/SMB servers.
122 \fBsmbspool\fR(8)
123 .RS 3n
124 smbspool
125 is a helper utility for printing on printers connected to CIFS servers.
128 \fBsmbcontrol\fR(1)
129 .RS 3n
130 smbcontrol
131 is a utility that can change the behaviour of running samba daemons.
134 \fBrpcclient\fR(1)
135 .RS 3n
136 rpcclient
137 is a utility that can be used to execute RPC commands on remote CIFS servers.
140 \fBpdbedit\fR(8)
141 .RS 3n
143 pdbedit
144 command can be used to maintain the local user database on a samba server.
147 \fBfindsmb\fR(1)
148 .RS 3n
150 findsmb
151 command can be used to find SMB servers on the local network.
154 \fBnet\fR(8)
155 .RS 3n
158 command is supposed to work similar to the DOS/Windows NET.EXE command.
161 \fBswat\fR(8)
162 .RS 3n
163 swat
164 is a web-based interface to configuring
165 \fIsmb.conf\fR.
168 \fBwinbindd\fR(8)
169 .RS 3n
170 winbindd
171 is a daemon that is used for integrating authentication and the user database into unix.
174 \fBwbinfo\fR(1)
175 .RS 3n
176 wbinfo
177 is a utility that retrieves and stores information related to winbind.
180 \fBprofiles\fR(1)
181 .RS 3n
182 profiles
183 is a command-line utility that can be used to replace all occurences of a certain SID with another SID.
186 \fBlog2pcap\fR(1)
187 .RS 3n
188 log2pcap
189 is a utility for generating pcap trace files from Samba log files.
192 \fBvfstest\fR(1)
193 .RS 3n
194 vfstest
195 is a utility that can be used to test vfs modules.
198 \fBntlm_auth\fR(1)
199 .RS 3n
200 ntlm_auth
201 is a helper-utility for external programs wanting to do NTLM-authentication.
204 \fBsmbmount\fR(8), \fBsmbumount\fR(8), \fBsmbmnt\fR(8)
205 .RS 3n
206 smbmount,smbumount
208 smbmnt
209 are commands that can be used to mount CIFS/SMB shares on Linux.
212 \fBsmbcquotas\fR(1)
213 .RS 3n
214 smbcquotas
215 is a tool that can set remote QUOTA's on server with NTFS 5.
217 .SH "COMPONENTS"
219 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
220 http://devel.samba.org
221 for information on how to file a bug report or submit a patch.
223 If you require help, visit the Samba webpage at
224 http://www.samba.org/
225 and explore the many option available to you.
226 .SH "AVAILABILITY"
228 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.
230 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.
232 You may also find useful information about Samba on the newsgroup
233 comp.protocol.smb
234 and the Samba mailing list. Details on how to join the mailing list are given in the README file that comes with Samba.
236 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
237 http://lists.samba.org.
238 .SH "VERSION"
240 This man page is correct for version 3.0 of the Samba suite.
241 .SH "CONTRIBUTIONS"
243 If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at
244 http://lists.samba.org.
246 If you have patches to submit, visit
247 http://devel.samba.org/
248 for information on how to do it properly. We prefer patches in
249 diff -u
250 format.
251 .SH "CONTRIBUTORS"
253 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
254 \fIchange-log\fR
255 in the source package for the pre-CVS changes and at
256 http://cvs.samba.org/
257 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.
258 .SH "AUTHOR"
260 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.
262 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
263 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.