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