trying to get HEAD building again. If you want the code
[gd/samba-autobuild/.git] / docs / manpages / samba.7
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
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "SAMBA" 7 "" "" ""
21 .SH NAME
22 samba \- A Windows SMB/CIFS fileserver for UNIX
23 .SH "SYNOPSIS"
24
25 .nf
26 \fBSamba\fR 
27 .fi
28
29 .SH "DESCRIPTION"
30
31 .PP
32 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 http://www\&.ubiqx\&.org/cifs/\&. Samba also implements the NetBIOS protocol in nmbd\&.
33
34 .TP
35 \fBsmbd\fR(8)
36 The \fBsmbd\fR daemon provides the file and print services to SMB clients, such as Windows 95/98, Windows NT, Windows for Workgroups or LanManager\&. The configuration file for this daemon is described in \fBsmb.conf\fR(5)
37
38
39 .TP
40 \fBnmbd\fR(8)
41 The \fBnmbd\fR daemon provides NetBIOS nameservice and browsing support\&. The configuration file for this daemon is described in \fBsmb.conf\fR(5)
42
43
44 .TP
45 \fBsmbclient\fR(1)
46 The \fBsmbclient\fR 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
48
49 .TP
50 \fBtestparm\fR(1)
51 The \fBtestparm\fR utility is a simple syntax checker for Samba's \fBsmb.conf\fR(5) configuration file\&.
52
53
54 .TP
55 \fBtestprns\fR(1)
56 The \fBtestprns\fR utility supports testing printer names defined in your \fIprintcap\fR file used by Samba\&.
57
58
59 .TP
60 \fBsmbstatus\fR(1)
61 The \fBsmbstatus\fR tool provides access to information about the current connections to \fBsmbd\fR\&.
62
63
64 .TP
65 \fBnmblookup\fR(1)
66 The \fBnmblookup\fR tools allows NetBIOS name queries to be made from a UNIX host\&.
67
68
69 .TP
70 \fBsmbgroupedit\fR(8)
71 The \fBsmbgroupedit\fR tool allows for mapping unix groups to NT Builtin, Domain, or Local groups\&. Also it allows setting priviledges for that group, such as saAddUser, etc\&.
72
73
74 .TP
75 \fBsmbpasswd\fR(8)
76 The \fBsmbpasswd\fR command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers\&.
77
78
79 .TP
80 \fBsmbcacls\fR(1)
81 The \fBsmbcacls\fR command is a tool to set ACL's on remote CIFS servers\&.
82
83
84 .TP
85 \fBsmbsh\fR(1)
86 The \fBsmbsh\fR command is a program that allows you to run a unix shell with with an overloaded VFS\&.
87
88
89 .TP
90 \fBsmbtree\fR(1)
91 The \fBsmbtree\fR command is a text-based network neighborhood tool\&.
92
93
94 .TP
95 \fBsmbtar\fR(1)
96 The \fBsmbtar\fR can make backups of data on CIFS/SMB servers\&.
97
98
99 .TP
100 \fBsmbspool\fR(8)
101 \fBsmbspool\fR is a helper utility for printing on printers connected to CIFS servers\&.
102
103
104 .TP
105 \fBsmbcontrol\fR(1)
106 \fBsmbcontrol\fR is a utility that can change the behaviour of running samba daemons\&.
107
108
109 .TP
110 \fBrpcclient\fR(1)
111 \fBrpcclient\fR is a utility that can be used to execute RPC commands on remote CIFS servers\&.
112
113
114 .TP
115 \fBpdbedit\fR(8)
116 The \fBpdbedit\fR command can be used to maintain the local user database on a samba server\&.
117
118
119 .TP
120 \fBfindsmb\fR(1)
121 The \fBfindsmb\fR command can be used to find SMB servers on the local network\&.
122
123
124 .TP
125 \fBnet\fR(8)
126 The \fBnet\fR command is supposed to work similar to the DOS/Windows NET\&.EXE command\&.
127
128
129 .TP
130 \fBswat\fR(8)
131 \fBswat\fR is a web-based interface to configuring \fIsmb\&.conf\fR\&.
132
133
134 .TP
135 \fBwinbindd\fR(8)
136 \fBwinbindd\fR is a daemon that is used for integrating authentication and the user database into unix\&.
137
138
139 .TP
140 \fBwbinfo\fR(1)
141 \fBwbinfo\fR is a utility that retrieves and stores information related to winbind\&.
142
143
144 .TP
145 \fBeditreg\fR(1)
146 \fBeditreg\fR is a command-line utility that can edit windows registry files\&.
147
148
149 .TP
150 \fBprofiles\fR(1)
151 \fBprofiles\fR is a command-line utility that can be used to replace all occurences of a certain SID with another SID\&.
152
153
154 .TP
155 \fBvfstest\fR(1)
156 \fBvfstest\fR is a utility that can be used to test vfs modules\&.
157
158
159 .TP
160 \fBntlm_auth\fR(1)
161 \fBntlm_auth\fR is a helper-utility for external programs wanting to do NTLM-authentication\&.
162
163
164 .TP
165 \fBsmbmount\fR(8), \fBsmbumount\fR(8), \fBsmbmount\fR(8)
166 \fBsmbmount\fR,\fBsmbmnt\fR and \fBsmbmnt\fR are commands that can be used to mount CIFS/SMB shares on Linux\&.
167
168
169 .TP
170 \fBsmbcquotas\fR(1)
171 \fBsmbcquotas\fR is a tool that can set remote QUOTA's on server with NTFS 5\&.
172
173
174 .SH "COMPONENTS"
175
176 .PP
177 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 visithttp://devel\&.samba\&.org for information on how to file a bug report or submit a patch\&.
178
179 .PP
180 If you require help, visit the Samba webpage athttp://www\&.samba\&.org/ and explore the many option available to you\&.
181
182 .SH "AVAILABILITY"
183
184 .PP
185 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\&.
186
187 .PP
188 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\&.
189
190 .PP
191 You may also find useful information about Samba on the newsgroup comp\&.protocol\&.smb and the Samba mailing list\&. Details on how to join the mailing list are given in the README file that comes with Samba\&.
192
193 .PP
194 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, athttp://lists\&.samba\&.org\&.
195
196 .SH "VERSION"
197
198 .PP
199 This man page is correct for version 3\&.0 of the Samba suite\&.
200
201 .SH "CONTRIBUTIONS"
202
203 .PP
204 If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list athttp://lists\&.samba\&.org\&.
205
206 .PP
207 If you have patches to submit, visithttp://devel\&.samba\&.org/ for information on how to do it properly\&. We prefer patches in \fBdiff -u\fR format\&.
208
209 .SH "CONTRIBUTORS"
210
211 .PP
212 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\fIchange-log\fR in the source package for the pre-CVS changes and at http://cvs\&.samba\&.org/ 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\&.
213
214 .SH "AUTHOR"
215
216 .PP
217 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\&.
218
219 .PP
220 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\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
221