source: branches/samba-3.3.x/docs/manpages/samba.7@ 342

Last change on this file since 342 was 342, checked in by Herwig Bauernfeind, 15 years ago

Update 3.3 to 3.3.9

File size: 11.3 KB
Line 
1.\" Title: samba
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 10/12/2009
5.\" Manual: Miscellanea
6.\" Source: Samba 3.3
7.\" Language: English
8.\"
9.TH "SAMBA" "7" "10/12/2009" "Samba 3\&.3" "Miscellanea"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170samba \- A Windows SMB/CIFS fileserver for UNIX
171.SH "Synopsis"
172.fam C
173.HP \w'\ 'u
174\FCsamba\F[]
175.fam
176.SH "DESCRIPTION"
177.PP
178The 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
179http://www\&.ubiqx\&.org/cifs/\&. Samba also implements the NetBIOS protocol in nmbd\&.
180.PP
181\fBsmbd\fR(8)
182.RS 4
183The
184\FCsmbd\F[]
185daemon 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
186\fBsmb.conf\fR(5)
187.RE
188.PP
189\fBnmbd\fR(8)
190.RS 4
191The
192\FCnmbd\F[]
193daemon provides NetBIOS nameservice and browsing support\&. The configuration file for this daemon is described in
194\fBsmb.conf\fR(5)
195.RE
196.PP
197\fBsmbclient\fR(1)
198.RS 4
199The
200\FCsmbclient\F[]
201program 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)\&.
202.RE
203.PP
204\fBtestparm\fR(1)
205.RS 4
206The
207\FCtestparm\F[]
208utility is a simple syntax checker for Samba\'s
209\fBsmb.conf\fR(5)
210configuration file\&.
211.RE
212.PP
213\fBtestprns\fR(1)
214.RS 4
215The
216\FCtestprns\F[]
217utility supports testing printer names defined in your
218\FCprintcap\F[]
219file used by Samba\&.
220.RE
221.PP
222\fBsmbstatus\fR(1)
223.RS 4
224The
225\FCsmbstatus\F[]
226tool provides access to information about the current connections to
227\FCsmbd\F[]\&.
228.RE
229.PP
230\fBnmblookup\fR(1)
231.RS 4
232The
233\FCnmblookup\F[]
234tools allows NetBIOS name queries to be made from a UNIX host\&.
235.RE
236.PP
237\fBsmbpasswd\fR(8)
238.RS 4
239The
240\FCsmbpasswd\F[]
241command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers\&.
242.RE
243.PP
244\fBsmbcacls\fR(1)
245.RS 4
246The
247\FCsmbcacls\F[]
248command is a tool to set ACL\'s on remote CIFS servers\&.
249.RE
250.PP
251\fBsmbsh\fR(1)
252.RS 4
253The
254\FCsmbsh\F[]
255command is a program that allows you to run a unix shell with with an overloaded VFS\&.
256.RE
257.PP
258\fBsmbtree\fR(1)
259.RS 4
260The
261\FCsmbtree\F[]
262command is a text\-based network neighborhood tool\&.
263.RE
264.PP
265\fBsmbtar\fR(1)
266.RS 4
267The
268\FCsmbtar\F[]
269can make backups of data on CIFS/SMB servers\&.
270.RE
271.PP
272\fBsmbspool\fR(8)
273.RS 4
274\FCsmbspool\F[]
275is a helper utility for printing on printers connected to CIFS servers\&.
276.RE
277.PP
278\fBsmbcontrol\fR(1)
279.RS 4
280\FCsmbcontrol\F[]
281is a utility that can change the behaviour of running samba daemons\&.
282.RE
283.PP
284\fBrpcclient\fR(1)
285.RS 4
286\FCrpcclient\F[]
287is a utility that can be used to execute RPC commands on remote CIFS servers\&.
288.RE
289.PP
290\fBpdbedit\fR(8)
291.RS 4
292The
293\FCpdbedit\F[]
294command can be used to maintain the local user database on a samba server\&.
295.RE
296.PP
297\fBfindsmb\fR(1)
298.RS 4
299The
300\FCfindsmb\F[]
301command can be used to find SMB servers on the local network\&.
302.RE
303.PP
304\fBnet\fR(8)
305.RS 4
306The
307\FCnet\F[]
308command is supposed to work similar to the DOS/Windows NET\&.EXE command\&.
309.RE
310.PP
311\fBswat\fR(8)
312.RS 4
313\FCswat\F[]
314is a web\-based interface to configuring
315\FCsmb\&.conf\F[]\&.
316.RE
317.PP
318\fBwinbindd\fR(8)
319.RS 4
320\FCwinbindd\F[]
321is a daemon that is used for integrating authentication and the user database into unix\&.
322.RE
323.PP
324\fBwbinfo\fR(1)
325.RS 4
326\FCwbinfo\F[]
327is a utility that retrieves and stores information related to winbind\&.
328.RE
329.PP
330\fBprofiles\fR(1)
331.RS 4
332\FCprofiles\F[]
333is a command\-line utility that can be used to replace all occurences of a certain SID with another SID\&.
334.RE
335.PP
336\fBlog2pcap\fR(1)
337.RS 4
338\FClog2pcap\F[]
339is a utility for generating pcap trace files from Samba log files\&.
340.RE
341.PP
342\fBvfstest\fR(1)
343.RS 4
344\FCvfstest\F[]
345is a utility that can be used to test vfs modules\&.
346.RE
347.PP
348\fBntlm_auth\fR(1)
349.RS 4
350\FCntlm_auth\F[]
351is a helper\-utility for external programs wanting to do NTLM\-authentication\&.
352.RE
353.PP
354\fBsmbmount\fR(8), \fBsmbumount\fR(8), \fBsmbmnt\fR(8)
355.RS 4
356\FCsmbmount\F[],\FCsmbumount\F[]
357and
358\FCsmbmnt\F[]
359are commands that can be used to mount CIFS/SMB shares on Linux\&.
360.RE
361.PP
362\fBsmbcquotas\fR(1)
363.RS 4
364\FCsmbcquotas\F[]
365is a tool that can set remote QUOTA\'s on server with NTFS 5\&.
366.RE
367.SH "COMPONENTS"
368.PP
369The 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
370http://devel\&.samba\&.org
371for information on how to file a bug report or submit a patch\&.
372.PP
373If you require help, visit the Samba webpage at
374http://www\&.samba\&.org/
375and explore the many option available to you\&.
376.SH "AVAILABILITY"
377.PP
378The 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\&.
379.PP
380The 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\&.
381.PP
382You may also find useful information about Samba on the newsgroup
383comp\&.protocol\&.smb
384and the Samba mailing list\&. Details on how to join the mailing list are given in the README file that comes with Samba\&.
385.PP
386If 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
387http://lists\&.samba\&.org\&.
388.SH "VERSION"
389.PP
390This man page is correct for version 3 of the Samba suite\&.
391.SH "CONTRIBUTIONS"
392.PP
393If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at
394http://lists\&.samba\&.org\&.
395.PP
396If you have patches to submit, visit
397http://devel\&.samba\&.org/
398for information on how to do it properly\&. We prefer patches in
399\FCdiff \-u\F[]
400format\&.
401.SH "CONTRIBUTORS"
402.PP
403Contributors 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
404\FCchange\-log\F[]
405in the source package for the pre\-CVS changes and at
406http://cvs\&.samba\&.org/
407for 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\&.
408.SH "AUTHOR"
409.PP
410The 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\&.
411.PP
412The 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
413ftp://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\&.
Note: See TracBrowser for help on using the repository browser.