Initial import
[samba] / 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 .ad l
25 .hy 0
26 .HP 6
27 \fBsamba\fR
28 .ad
29 .hy
30
31 .SH "DESCRIPTION"
32
33 .PP
34 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\&.
35
36 .TP
37 \fBsmbd\fR(8)
38 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) 
39
40 .TP
41 \fBnmbd\fR(8)
42 The \fBnmbd\fR daemon provides NetBIOS nameservice and browsing support\&. The configuration file for this daemon is described in \fBsmb\&.conf\fR(5)
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 .TP
49 \fBtestparm\fR(1)
50 The \fBtestparm\fR utility is a simple syntax checker for Samba's \fBsmb\&.conf\fR(5) configuration file\&.
51
52 .TP
53 \fBtestprns\fR(1)
54 The \fBtestprns\fR utility supports testing printer names defined in your \fIprintcap\fR file used by Samba\&.
55
56 .TP
57 \fBsmbstatus\fR(1)
58 The \fBsmbstatus\fR tool provides access to information about the current connections to \fBsmbd\fR\&.
59
60 .TP
61 \fBnmblookup\fR(1)
62 The \fBnmblookup\fR tools allows NetBIOS name queries to be made from a UNIX host\&.
63
64 .TP
65 \fBsmbpasswd\fR(8)
66 The \fBsmbpasswd\fR command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers\&.
67
68 .TP
69 \fBsmbcacls\fR(1)
70 The \fBsmbcacls\fR command is a tool to set ACL's on remote CIFS servers\&.
71
72 .TP
73 \fBsmbsh\fR(1)
74 The \fBsmbsh\fR command is a program that allows you to run a unix shell with with an overloaded VFS\&.
75
76 .TP
77 \fBsmbtree\fR(1)
78 The \fBsmbtree\fR command is a text\-based network neighborhood tool\&.
79
80 .TP
81 \fBsmbtar\fR(1)
82 The \fBsmbtar\fR can make backups of data on CIFS/SMB servers\&.
83
84 .TP
85 \fBsmbspool\fR(8)
86 \fBsmbspool\fR is a helper utility for printing on printers connected to CIFS servers\&.
87
88 .TP
89 \fBsmbcontrol\fR(1)
90 \fBsmbcontrol\fR is a utility that can change the behaviour of running samba daemons\&.
91
92 .TP
93 \fBrpcclient\fR(1)
94 \fBrpcclient\fR is a utility that can be used to execute RPC commands on remote CIFS servers\&.
95
96 .TP
97 \fBpdbedit\fR(8)
98 The \fBpdbedit\fR command can be used to maintain the local user database on a samba server\&.
99
100 .TP
101 \fBfindsmb\fR(1)
102 The \fBfindsmb\fR command can be used to find SMB servers on the local network\&.
103
104 .TP
105 \fBnet\fR(8)
106 The \fBnet\fR command is supposed to work similar to the DOS/Windows NET\&.EXE command\&.
107
108 .TP
109 \fBswat\fR(8)
110 \fBswat\fR is a web\-based interface to configuring \fIsmb\&.conf\fR\&.
111
112 .TP
113 \fBwinbindd\fR(8)
114 \fBwinbindd\fR is a daemon that is used for integrating authentication and the user database into unix\&.
115
116 .TP
117 \fBwbinfo\fR(1)
118 \fBwbinfo\fR is a utility that retrieves and stores information related to winbind\&.
119
120 .TP
121 \fBprofiles\fR(1)
122 \fBprofiles\fR is a command\-line utility that can be used to replace all occurences of a certain SID with another SID\&.
123
124 .TP
125 \fBlog2pcap\fR(1)
126 \fBlog2pcap\fR is a utility for generating pcap trace files from Samba log files\&.
127
128 .TP
129 \fBvfstest\fR(1)
130 \fBvfstest\fR is a utility that can be used to test vfs modules\&.
131
132 .TP
133 \fBntlm_auth\fR(1)
134 \fBntlm_auth\fR is a helper\-utility for external programs wanting to do NTLM\-authentication\&.
135
136 .TP
137 \fBsmbmount\fR(8), \fBsmbumount\fR(8), \fBsmbmnt\fR(8)
138 \fBsmbmount\fR,\fBsmbumount\fR and \fBsmbmnt\fR are commands that can be used to mount CIFS/SMB shares on Linux\&.
139
140 .TP
141 \fBsmbcquotas\fR(1)
142 \fBsmbcquotas\fR is a tool that can set remote QUOTA's on server with NTFS 5\&.
143
144 .SH "COMPONENTS"
145
146 .PP
147 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\&.
148
149 .PP
150 If you require help, visit the Samba webpage athttp://www\&.samba\&.org/ and explore the many option available to you\&.
151
152 .SH "AVAILABILITY"
153
154 .PP
155 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\&.
156
157 .PP
158 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\&.
159
160 .PP
161 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\&.
162
163 .PP
164 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\&.
165
166 .SH "VERSION"
167
168 .PP
169 This man page is correct for version 3\&.0 of the Samba suite\&.
170
171 .SH "CONTRIBUTIONS"
172
173 .PP
174 If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list athttp://lists\&.samba\&.org\&.
175
176 .PP
177 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\&.
178
179 .SH "CONTRIBUTORS"
180
181 .PP
182 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\&.
183
184 .SH "AUTHOR"
185
186 .PP
187 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\&.
188
189 .PP
190 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\&.
191