← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/samba/intrepid-updates

« back to all changes in this revision

Viewing changes to docs/manpages/samba.7

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2008-06-02 09:01:46 UTC
  • mfrom: (0.25.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20080602090146-92ur4nx39ccg708r
Tags: 2:3.0.30-2ubuntu1
https://launchpad.net/bugs/32067
https://launchpad.net/bugs/201059
https://launchpad.net/bugs/206036
* Merge from debian unstable, remaining changes:
  * debian/patches/VERSION.patch
    - set SAMABA_VERSION_VENDOR_SUFFIX to Ubuntu
  * debian/smb.conf
    - add "(Samba, Ubuntu)" to server string.
    - comment out the default [homes] shares, and a comment about
      "value users = %S to show users how to restrict access to 
      \\server\useranem to only username.
    - Add map to guest = Bad user, maps bad username to guest access.
      (LP: #32067)
  * debian/samba-common.postinst:
    - Fix upgrade from a first installation done with feisty, edgy, or dapper.
      (LP: #201059)
    - When populating the new sambashare group, it's not an error if the user
      simply doesn't exist; test for this case and the install continue 
      instead of aborting. (LP: #206036)
  * debian/smba-common.config:
    - do not change priority to HIGH if dhclient3 is installed
    - used priority medium instead of hight for the workgroup question
  * debian/winbind.files
    - insclude additional files
  * debian/patches/fix-documentation.patch:
    - fix typos in net(8) and smb.conf(5) man pages
  * debian/mksambapasswd.awk:
    - Don't add user with UID less than 1000 to smbpasswd.
  * debian/samba.init:
    - add 'status' option for LSB conformance.
  * Updated control version.
  * Dropped Changes:
    - Dropped debian/patches/fix-smbprinting-os2.patch. Accepted upstream.
    - Dropped debian/patches/fix-documentation.patch. Accepted upstream.
     

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "" "" ""
 
1
.\"     Title: samba
 
2
.\"    Author: 
 
3
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
 
4
.\"      Date: 05/28/2008
 
5
.\"    Manual: Miscellanea
 
6
.\"    Source: Samba 3.0
 
7
.\"
 
8
.TH "SAMBA" "7" "05/28/2008" "Samba 3\.0" "Miscellanea"
 
9
.\" disable hyphenation
 
10
.nh
 
11
.\" disable justification (adjust text to left margin only)
 
12
.ad l
21
13
.SH "NAME"
22
14
samba - A Windows SMB/CIFS fileserver for UNIX
23
15
.SH "SYNOPSIS"
25
17
samba
26
18
.SH "DESCRIPTION"
27
19
.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.
 
20
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
 
21
http://www\.ubiqx\.org/cifs/\. Samba also implements the NetBIOS protocol in nmbd\.
30
22
.PP
31
23
\fBsmbd\fR(8)
32
 
.RS 3n
 
24
.RS 4
33
25
The
34
26
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
 
27
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
28
\fBsmb.conf\fR(5)
37
29
.RE
38
30
.PP
39
31
\fBnmbd\fR(8)
40
 
.RS 3n
 
32
.RS 4
41
33
The
42
34
nmbd
43
 
daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon is described in
 
35
daemon provides NetBIOS nameservice and browsing support\. The configuration file for this daemon is described in
44
36
\fBsmb.conf\fR(5)
45
37
.RE
46
38
.PP
47
39
\fBsmbclient\fR(1)
48
 
.RS 3n
 
40
.RS 4
49
41
The
50
42
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).
 
43
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
44
.RE
53
45
.PP
54
46
\fBtestparm\fR(1)
55
 
.RS 3n
 
47
.RS 4
56
48
The
57
49
testparm
58
 
utility is a simple syntax checker for Samba's
 
50
utility is a simple syntax checker for Samba\'s
59
51
\fBsmb.conf\fR(5)
60
 
configuration file.
 
52
configuration file\.
61
53
.RE
62
54
.PP
63
55
\fBtestprns\fR(1)
64
 
.RS 3n
 
56
.RS 4
65
57
The
66
58
testprns
67
59
utility supports testing printer names defined in your
68
60
\fIprintcap\fR
69
 
file used by Samba.
 
61
file used by Samba\.
70
62
.RE
71
63
.PP
72
64
\fBsmbstatus\fR(1)
73
 
.RS 3n
 
65
.RS 4
74
66
The
75
67
smbstatus
76
68
tool provides access to information about the current connections to
77
 
smbd.
 
69
smbd\.
78
70
.RE
79
71
.PP
80
72
\fBnmblookup\fR(1)
81
 
.RS 3n
 
73
.RS 4
82
74
The
83
75
nmblookup
84
 
tools allows NetBIOS name queries to be made from a UNIX host.
 
76
tools allows NetBIOS name queries to be made from a UNIX host\.
85
77
.RE
86
78
.PP
87
79
\fBsmbpasswd\fR(8)
88
 
.RS 3n
 
80
.RS 4
89
81
The
90
82
smbpasswd
91
 
command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers.
 
83
command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers\.
92
84
.RE
93
85
.PP
94
86
\fBsmbcacls\fR(1)
95
 
.RS 3n
 
87
.RS 4
96
88
The
97
89
smbcacls
98
 
command is a tool to set ACL's on remote CIFS servers.
 
90
command is a tool to set ACL\'s on remote CIFS servers\.
99
91
.RE
100
92
.PP
101
93
\fBsmbsh\fR(1)
102
 
.RS 3n
 
94
.RS 4
103
95
The
104
96
smbsh
105
 
command is a program that allows you to run a unix shell with with an overloaded VFS.
 
97
command is a program that allows you to run a unix shell with with an overloaded VFS\.
106
98
.RE
107
99
.PP
108
100
\fBsmbtree\fR(1)
109
 
.RS 3n
 
101
.RS 4
110
102
The
111
103
smbtree
112
 
command is a text-based network neighborhood tool.
 
104
command is a text\-based network neighborhood tool\.
113
105
.RE
114
106
.PP
115
107
\fBsmbtar\fR(1)
116
 
.RS 3n
 
108
.RS 4
117
109
The
118
110
smbtar
119
 
can make backups of data on CIFS/SMB servers.
 
111
can make backups of data on CIFS/SMB servers\.
120
112
.RE
121
113
.PP
122
114
\fBsmbspool\fR(8)
123
 
.RS 3n
 
115
.RS 4
124
116
smbspool
125
 
is a helper utility for printing on printers connected to CIFS servers.
 
117
is a helper utility for printing on printers connected to CIFS servers\.
126
118
.RE
127
119
.PP
128
120
\fBsmbcontrol\fR(1)
129
 
.RS 3n
 
121
.RS 4
130
122
smbcontrol
131
 
is a utility that can change the behaviour of running samba daemons.
 
123
is a utility that can change the behaviour of running samba daemons\.
132
124
.RE
133
125
.PP
134
126
\fBrpcclient\fR(1)
135
 
.RS 3n
 
127
.RS 4
136
128
rpcclient
137
 
is a utility that can be used to execute RPC commands on remote CIFS servers.
 
129
is a utility that can be used to execute RPC commands on remote CIFS servers\.
138
130
.RE
139
131
.PP
140
132
\fBpdbedit\fR(8)
141
 
.RS 3n
 
133
.RS 4
142
134
The
143
135
pdbedit
144
 
command can be used to maintain the local user database on a samba server.
 
136
command can be used to maintain the local user database on a samba server\.
145
137
.RE
146
138
.PP
147
139
\fBfindsmb\fR(1)
148
 
.RS 3n
 
140
.RS 4
149
141
The
150
142
findsmb
151
 
command can be used to find SMB servers on the local network.
 
143
command can be used to find SMB servers on the local network\.
152
144
.RE
153
145
.PP
154
146
\fBnet\fR(8)
155
 
.RS 3n
 
147
.RS 4
156
148
The
157
149
net
158
 
command is supposed to work similar to the DOS/Windows NET.EXE command.
 
150
command is supposed to work similar to the DOS/Windows NET\.EXE command\.
159
151
.RE
160
152
.PP
161
153
\fBswat\fR(8)
162
 
.RS 3n
 
154
.RS 4
163
155
swat
164
 
is a web-based interface to configuring
165
 
\fIsmb.conf\fR.
 
156
is a web\-based interface to configuring
 
157
\fIsmb\.conf\fR\.
166
158
.RE
167
159
.PP
168
160
\fBwinbindd\fR(8)
169
 
.RS 3n
 
161
.RS 4
170
162
winbindd
171
 
is a daemon that is used for integrating authentication and the user database into unix.
 
163
is a daemon that is used for integrating authentication and the user database into unix\.
172
164
.RE
173
165
.PP
174
166
\fBwbinfo\fR(1)
175
 
.RS 3n
 
167
.RS 4
176
168
wbinfo
177
 
is a utility that retrieves and stores information related to winbind.
 
169
is a utility that retrieves and stores information related to winbind\.
178
170
.RE
179
171
.PP
180
172
\fBprofiles\fR(1)
181
 
.RS 3n
 
173
.RS 4
182
174
profiles
183
 
is a command-line utility that can be used to replace all occurences of a certain SID with another SID.
 
175
is a command\-line utility that can be used to replace all occurences of a certain SID with another SID\.
184
176
.RE
185
177
.PP
186
178
\fBlog2pcap\fR(1)
187
 
.RS 3n
 
179
.RS 4
188
180
log2pcap
189
 
is a utility for generating pcap trace files from Samba log files.
 
181
is a utility for generating pcap trace files from Samba log files\.
190
182
.RE
191
183
.PP
192
184
\fBvfstest\fR(1)
193
 
.RS 3n
 
185
.RS 4
194
186
vfstest
195
 
is a utility that can be used to test vfs modules.
 
187
is a utility that can be used to test vfs modules\.
196
188
.RE
197
189
.PP
198
190
\fBntlm_auth\fR(1)
199
 
.RS 3n
 
191
.RS 4
200
192
ntlm_auth
201
 
is a helper-utility for external programs wanting to do NTLM-authentication.
 
193
is a helper\-utility for external programs wanting to do NTLM\-authentication\.
202
194
.RE
203
195
.PP
204
196
\fBsmbmount\fR(8), \fBsmbumount\fR(8), \fBsmbmnt\fR(8)
205
 
.RS 3n
 
197
.RS 4
206
198
smbmount,smbumount
207
199
and
208
200
smbmnt
209
 
are commands that can be used to mount CIFS/SMB shares on Linux.
 
201
are commands that can be used to mount CIFS/SMB shares on Linux\.
210
202
.RE
211
203
.PP
212
204
\fBsmbcquotas\fR(1)
213
 
.RS 3n
 
205
.RS 4
214
206
smbcquotas
215
 
is a tool that can set remote QUOTA's on server with NTFS 5.
 
207
is a tool that can set remote QUOTA\'s on server with NTFS 5\.
216
208
.RE
217
209
.SH "COMPONENTS"
218
210
.PP
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.
 
211
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
 
212
http://devel\.samba\.org
 
213
for information on how to file a bug report or submit a patch\.
222
214
.PP
223
215
If you require help, visit the Samba webpage at
224
 
http://www.samba.org/
225
 
and explore the many option available to you.
 
216
http://www\.samba\.org/
 
217
and explore the many option available to you\.
226
218
.SH "AVAILABILITY"
227
219
.PP
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.
 
220
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\.
229
221
.PP
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.
 
222
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\.
231
223
.PP
232
224
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.
 
225
comp\.protocol\.smb
 
226
and the Samba mailing list\. Details on how to join the mailing list are given in the README file that comes with Samba\.
235
227
.PP
236
228
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.
 
229
http://lists\.samba\.org\.
238
230
.SH "VERSION"
239
231
.PP
240
 
This man page is correct for version 3.0 of the Samba suite.
 
232
This man page is correct for version 3\.0 of the Samba suite\.
241
233
.SH "CONTRIBUTIONS"
242
234
.PP
243
235
If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at
244
 
http://lists.samba.org.
 
236
http://lists\.samba\.org\.
245
237
.PP
246
238
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.
 
239
http://devel\.samba\.org/
 
240
for information on how to do it properly\. We prefer patches in
 
241
diff \-u
 
242
format\.
251
243
.SH "CONTRIBUTORS"
252
244
.PP
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.
 
245
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
 
246
\fIchange\-log\fR
 
247
in the source package for the pre\-CVS changes and at
 
248
http://cvs\.samba\.org/
 
249
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
250
.SH "AUTHOR"
259
251
.PP
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.
 
252
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\.
261
253
.PP
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.
264
 
 
 
254
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
 
255
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\.