← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs-xml/manpages-3/samba.7.xml

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs-xml/manpages-3/samba.7.xml
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
 
3
<refentry id="samba.7">
 
4
 
 
5
<refmeta>
 
6
        <refentrytitle>samba</refentrytitle>
 
7
        <manvolnum>7</manvolnum>
 
8
        <refmiscinfo class="source">Samba</refmiscinfo>
 
9
        <refmiscinfo class="manual">Miscellanea</refmiscinfo>
 
10
        <refmiscinfo class="version">3.4</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
 
 
14
<refnamediv>
 
15
        <refname>samba</refname>
 
16
        <refpurpose>A Windows SMB/CIFS fileserver for UNIX</refpurpose>
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv>
 
20
        <cmdsynopsis><command>samba</command></cmdsynopsis>
 
21
</refsynopsisdiv>
 
22
 
 
23
<refsect1>
 
24
        <title>DESCRIPTION</title>
 
25
        
 
26
        <para>The Samba software suite is a collection of programs 
 
27
        that implements the Server Message Block (commonly abbreviated 
 
28
        as SMB) protocol for UNIX systems. This protocol is sometimes 
 
29
        also referred to as the Common Internet File System (CIFS). For a
 
30
        more thorough description, see <ulink url="http://www.ubiqx.org/cifs/">
 
31
        http://www.ubiqx.org/cifs/</ulink>. Samba also implements the NetBIOS
 
32
        protocol in nmbd.</para>
 
33
        
 
34
        <variablelist>
 
35
                <varlistentry>
 
36
                <term><citerefentry><refentrytitle>smbd</refentrytitle>
 
37
                <manvolnum>8</manvolnum></citerefentry></term>
 
38
                <listitem><para>The <command>smbd</command> daemon provides the file and print services to 
 
39
                SMB clients, such as Windows 95/98, Windows NT, Windows 
 
40
                for Workgroups or LanManager. The configuration file 
 
41
                for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
 
42
                <manvolnum>5</manvolnum></citerefentry>
 
43
                </para></listitem>
 
44
                </varlistentry>
 
45
                
 
46
                <varlistentry>
 
47
                <term><citerefentry><refentrytitle>nmbd</refentrytitle>
 
48
                <manvolnum>8</manvolnum></citerefentry></term>
 
49
                <listitem><para>The <command>nmbd</command>
 
50
                daemon provides NetBIOS nameservice and browsing
 
51
                support. The configuration file for this daemon 
 
52
                is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
 
53
                <manvolnum>5</manvolnum></citerefentry></para>
 
54
                </listitem>
 
55
                </varlistentry>
 
56
 
 
57
                <varlistentry>
 
58
                <term><citerefentry><refentrytitle>smbclient</refentrytitle>
 
59
                <manvolnum>1</manvolnum></citerefentry></term>
 
60
                <listitem><para>The <command>smbclient</command>
 
61
                program implements a simple ftp-like client. This 
 
62
                is useful for accessing SMB shares on other compatible
 
63
                servers (such as Windows NT), and can also be used 
 
64
                to allow a UNIX box to print to a printer attached to 
 
65
                any SMB server (such as a PC running Windows NT).</para>
 
66
                </listitem>
 
67
                </varlistentry>
 
68
 
 
69
                <varlistentry>
 
70
                <term><citerefentry><refentrytitle>testparm</refentrytitle>
 
71
                <manvolnum>1</manvolnum></citerefentry></term>
 
72
                <listitem><para>The <command>testparm</command>
 
73
                utility is a simple syntax checker for Samba's <citerefentry><refentrytitle>smb.conf</refentrytitle>
 
74
                <manvolnum>5</manvolnum></citerefentry> configuration file.</para>
 
75
                </listitem>
 
76
                </varlistentry>
 
77
 
 
78
                <varlistentry>
 
79
                <term><citerefentry><refentrytitle>testprns</refentrytitle>
 
80
                <manvolnum>1</manvolnum></citerefentry></term>
 
81
                <listitem><para>The <command>testprns</command>
 
82
                utility supports testing printer names defined 
 
83
                in your <filename>printcap</filename> file used 
 
84
                by Samba.</para>
 
85
                </listitem>
 
86
                </varlistentry>
 
87
 
 
88
                <varlistentry>
 
89
                <term><citerefentry><refentrytitle>smbstatus</refentrytitle>
 
90
                <manvolnum>1</manvolnum></citerefentry></term>
 
91
                <listitem><para>The <command>smbstatus</command>
 
92
                tool provides access to information about the 
 
93
                current connections to <command>smbd</command>.</para>
 
94
                </listitem>
 
95
                </varlistentry>
 
96
 
 
97
                <varlistentry>
 
98
                <term><citerefentry><refentrytitle>nmblookup</refentrytitle>
 
99
                <manvolnum>1</manvolnum></citerefentry></term>
 
100
                <listitem><para>The <command>nmblookup</command>
 
101
                tools allows NetBIOS name queries to be made 
 
102
                from a UNIX host.</para>
 
103
                </listitem>
 
104
                </varlistentry>
 
105
 
 
106
                <varlistentry>
 
107
                <term><citerefentry><refentrytitle>smbpasswd</refentrytitle>
 
108
                <manvolnum>8</manvolnum></citerefentry></term>
 
109
                <listitem><para>The <command>smbpasswd</command>
 
110
                command is a tool for changing LanMan and Windows NT 
 
111
                password hashes on Samba and Windows NT servers.</para>
 
112
                </listitem>
 
113
                </varlistentry>
 
114
 
 
115
                <varlistentry>
 
116
                <term><citerefentry><refentrytitle>smbcacls</refentrytitle>
 
117
                <manvolnum>1</manvolnum></citerefentry></term>
 
118
                <listitem><para>The <command>smbcacls</command> command is 
 
119
                a tool to set ACL's on remote CIFS servers. </para>
 
120
                </listitem>
 
121
                </varlistentry>
 
122
 
 
123
                <varlistentry>
 
124
                <term><citerefentry><refentrytitle>smbsh</refentrytitle>
 
125
                <manvolnum>1</manvolnum></citerefentry></term>
 
126
                <listitem><para>The <command>smbsh</command> command is 
 
127
                a program that allows you to run a unix shell with 
 
128
                with an overloaded VFS.</para></listitem>
 
129
                </varlistentry>
 
130
 
 
131
                <varlistentry>
 
132
                <term><citerefentry><refentrytitle>smbtree</refentrytitle>
 
133
                <manvolnum>1</manvolnum></citerefentry></term>
 
134
                <listitem><para>The <command>smbtree</command> command 
 
135
                is a text-based network neighborhood tool.</para></listitem>
 
136
                </varlistentry>
 
137
 
 
138
                <varlistentry>
 
139
                <term><citerefentry><refentrytitle>smbtar</refentrytitle>
 
140
                <manvolnum>1</manvolnum></citerefentry></term>
 
141
                <listitem><para>The <command>smbtar</command> can make 
 
142
                backups of data on CIFS/SMB servers.</para></listitem>
 
143
                </varlistentry>
 
144
 
 
145
                <varlistentry>
 
146
                <term><citerefentry><refentrytitle>smbspool</refentrytitle>
 
147
                <manvolnum>8</manvolnum></citerefentry></term>
 
148
                <listitem><para><command>smbspool</command> is a 
 
149
                helper utility for printing on printers connected 
 
150
                to CIFS servers. </para></listitem>
 
151
                </varlistentry>
 
152
 
 
153
                <varlistentry>
 
154
                <term><citerefentry><refentrytitle>smbcontrol</refentrytitle>
 
155
                <manvolnum>1</manvolnum></citerefentry></term>
 
156
                <listitem><para><command>smbcontrol</command> is a utility
 
157
                that can change the behaviour of running samba daemons.
 
158
                </para></listitem>
 
159
                </varlistentry>
 
160
 
 
161
                <varlistentry>
 
162
                <term><citerefentry><refentrytitle>rpcclient</refentrytitle>
 
163
                <manvolnum>1</manvolnum></citerefentry></term>
 
164
                <listitem><para><command>rpcclient</command> is a utility
 
165
                that can be used to execute RPC commands on remote 
 
166
                CIFS servers.</para></listitem>
 
167
                </varlistentry>
 
168
 
 
169
                <varlistentry>
 
170
                <term><citerefentry><refentrytitle>pdbedit</refentrytitle>
 
171
                <manvolnum>8</manvolnum></citerefentry></term>
 
172
                <listitem><para>The <command>pdbedit</command> command 
 
173
                can be used to maintain the local user database on 
 
174
                a samba server.</para></listitem></varlistentry>
 
175
 
 
176
                <varlistentry>
 
177
                <term><citerefentry><refentrytitle>findsmb</refentrytitle>
 
178
                <manvolnum>1</manvolnum></citerefentry></term>
 
179
                <listitem><para>The <command>findsmb</command> command 
 
180
                can be used to find SMB servers on the local network.
 
181
                </para></listitem></varlistentry>
 
182
 
 
183
                <varlistentry>
 
184
                <term><citerefentry><refentrytitle>net</refentrytitle>
 
185
                <manvolnum>8</manvolnum></citerefentry></term>
 
186
                <listitem><para>The <command>net</command> command 
 
187
                is supposed to work similar to the DOS/Windows
 
188
                NET.EXE command.</para></listitem>
 
189
                </varlistentry>
 
190
 
 
191
                <varlistentry>
 
192
                <term><citerefentry><refentrytitle>swat</refentrytitle>
 
193
                <manvolnum>8</manvolnum></citerefentry></term>
 
194
                <listitem><para><command>swat</command> is a web-based
 
195
                interface to configuring <filename>smb.conf</filename>.
 
196
                </para></listitem>
 
197
                </varlistentry>
 
198
 
 
199
                <varlistentry>
 
200
                <term><citerefentry><refentrytitle>winbindd</refentrytitle>
 
201
                <manvolnum>8</manvolnum></citerefentry></term>
 
202
                <listitem><para><command>winbindd</command> is a daemon 
 
203
                that is used for integrating authentication and 
 
204
                the user database into unix.</para></listitem>
 
205
                </varlistentry>
 
206
 
 
207
                <varlistentry>
 
208
                <term><citerefentry><refentrytitle>wbinfo</refentrytitle>
 
209
                <manvolnum>1</manvolnum></citerefentry></term>
 
210
                <listitem><para><command>wbinfo</command> is a utility 
 
211
                that retrieves and stores information related to winbind.
 
212
                </para></listitem>
 
213
                </varlistentry>
 
214
 
 
215
                <varlistentry>
 
216
                <term><citerefentry><refentrytitle>profiles</refentrytitle>
 
217
                <manvolnum>1</manvolnum></citerefentry></term>
 
218
                <listitem><para><command>profiles</command> is a command-line
 
219
                utility that can be used to replace all occurences of 
 
220
                a certain SID with another SID.
 
221
                </para></listitem>
 
222
                </varlistentry>
 
223
 
 
224
                <varlistentry>
 
225
                <term><citerefentry><refentrytitle>log2pcap</refentrytitle>
 
226
                                <manvolnum>1</manvolnum></citerefentry></term>
 
227
                <listitem><para><command>log2pcap</command> is a utility 
 
228
                                for generating pcap trace files from Samba log 
 
229
                                files.</para></listitem>
 
230
                </varlistentry>
 
231
 
 
232
                <varlistentry>
 
233
                <term><citerefentry><refentrytitle>vfstest</refentrytitle>
 
234
                <manvolnum>1</manvolnum></citerefentry></term>
 
235
                <listitem><para><command>vfstest</command> is a utility
 
236
                that can be used to test vfs modules.</para></listitem>
 
237
                </varlistentry>
 
238
 
 
239
                <varlistentry>
 
240
                <term><citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 
241
                <manvolnum>1</manvolnum></citerefentry></term>
 
242
                <listitem><para><command>ntlm_auth</command> is a helper-utility
 
243
                for external programs wanting to do NTLM-authentication.
 
244
                </para></listitem></varlistentry>
 
245
 
 
246
                <varlistentry>
 
247
                        <term>
 
248
<citerefentry><refentrytitle>smbmount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, 
 
249
<citerefentry><refentrytitle>smbumount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, 
 
250
<citerefentry><refentrytitle>smbmnt</refentrytitle><manvolnum>8</manvolnum></citerefentry></term>
 
251
                <listitem><para><command>smbmount</command>,<command>smbumount</command> and <command>smbmnt</command> are commands that can be used to 
 
252
                mount CIFS/SMB shares on Linux.
 
253
                </para></listitem>
 
254
                </varlistentry>
 
255
 
 
256
                <varlistentry>
 
257
                <term><citerefentry><refentrytitle>smbcquotas</refentrytitle>
 
258
                <manvolnum>1</manvolnum></citerefentry></term>
 
259
                <listitem><para><command>smbcquotas</command> is a tool that 
 
260
                can set remote QUOTA's on server with NTFS 5. </para>
 
261
                </listitem>
 
262
                </varlistentry>
 
263
        </variablelist>
 
264
</refsect1>
 
265
 
 
266
<refsect1>
 
267
        <title>COMPONENTS</title>
 
268
        
 
269
        <para>The Samba suite is made up of several components. Each 
 
270
        component is described in a separate manual page. It is strongly 
 
271
        recommended that you read the documentation that comes with Samba 
 
272
        and the manual pages of those components that you use. If the 
 
273
        manual pages and documents aren't clear enough then please visit
 
274
        <ulink url="http://devel.samba.org/">http://devel.samba.org</ulink>
 
275
        for information on how to file a bug report or submit a patch.</para>
 
276
 
 
277
        <para>If you require help, visit the Samba webpage at
 
278
        <ulink url="http://samba.org/">http://www.samba.org/</ulink> and
 
279
        explore the many option available to you.
 
280
        </para>
 
281
</refsect1>
 
282
 
 
283
<refsect1>
 
284
        <title>AVAILABILITY</title>
 
285
        
 
286
        <para>The Samba software suite is licensed under the 
 
287
        GNU Public License(GPL). A copy of that license should 
 
288
        have come with the package in the file COPYING. You are 
 
289
        encouraged to distribute copies of the Samba suite, but 
 
290
        please obey the terms of this license.</para>
 
291
 
 
292
        <para>The latest version of the Samba suite can be 
 
293
        obtained via anonymous ftp from samba.org in the
 
294
        directory pub/samba/. It is also available on several 
 
295
        mirror sites worldwide.</para>
 
296
        
 
297
        <para>You may also find useful information about Samba 
 
298
        on the newsgroup <ulink url="news:comp.protocols.smb">
 
299
        comp.protocol.smb</ulink> and the Samba mailing 
 
300
        list. Details on how to join the mailing list are given in 
 
301
        the README file that comes with Samba.</para>
 
302
        
 
303
        <para>If you have access to a WWW viewer (such as Mozilla
 
304
        or Konqueror) then you will also find lots of useful information, 
 
305
        including back issues of the Samba mailing list, at
 
306
        <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.</para>
 
307
</refsect1>
 
308
 
 
309
<refsect1>
 
310
        <title>VERSION</title>
 
311
        
 
312
        <para>This man page is correct for version 3 of the 
 
313
        Samba suite. </para>
 
314
</refsect1>
 
315
 
 
316
<refsect1>
 
317
        <title>CONTRIBUTIONS</title>
 
318
        
 
319
        <para>If you wish to contribute to the Samba project, 
 
320
        then I suggest you join the Samba mailing list at 
 
321
        <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.
 
322
        </para>
 
323
 
 
324
        <para>If you have patches to submit, visit
 
325
        <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>
 
326
        for information on how to do it properly. We prefer patches 
 
327
        in <command>diff -u</command> format.</para>
 
328
</refsect1>
 
329
 
 
330
<refsect1>
 
331
        <title>CONTRIBUTORS</title>
 
332
        
 
333
        <para>Contributors to the project are now too numerous 
 
334
        to mention here but all deserve the thanks of all Samba 
 
335
        users. To see a full list, look at the
 
336
        <filename>change-log</filename> in the source package 
 
337
        for the pre-CVS changes and at <ulink 
 
338
        url="http://cvs.samba.org/">
 
339
        http://cvs.samba.org/</ulink>
 
340
        for the contributors to Samba post-CVS. CVS is the Open Source 
 
341
        source code control system used by the Samba Team to develop 
 
342
        Samba. The project would have been unmanageable without it.</para>
 
343
</refsect1>
 
344
 
 
345
<refsect1>
 
346
        <title>AUTHOR</title>
 
347
        
 
348
        <para>The original Samba software and related utilities 
 
349
        were created by Andrew Tridgell. Samba is now developed
 
350
        by the Samba Team as an Open Source project similar 
 
351
        to the way the Linux kernel is developed.</para>
 
352
        
 
353
        <para>The original Samba man pages were written by Karl Auer. 
 
354
        The man page sources were converted to YODL format (another 
 
355
        excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 
356
        ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
 
357
        release by Jeremy Allison.  The conversion to DocBook for 
 
358
        Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML
 
359
        4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
 
360
</refsect1>
 
361
 
 
362
</refentry>