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">
6 <refentrytitle>samba</refentrytitle>
7 <manvolnum>7</manvolnum>
8 <refmiscinfo class="source">Samba</refmiscinfo>
9 <refmiscinfo class="manual">Miscellanea</refmiscinfo>
10 <refmiscinfo class="version">&doc.version;</refmiscinfo>
15 <refname>samba</refname>
16 <refpurpose>A Windows AD and SMB/CIFS fileserver for UNIX</refpurpose>
20 <cmdsynopsis><command>samba</command></cmdsynopsis>
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. The first version of the SMB protocol is sometimes also
30 referred to as the Common Internet File System (CIFS). For a more
31 thorough description, 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>
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>.
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. The configuration file
52 for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
53 <manvolnum>5</manvolnum></citerefentry>.
58 <term><citerefentry><refentrytitle>nmbd</refentrytitle>
59 <manvolnum>8</manvolnum></citerefentry></term>
60 <listitem><para>The <command>nmbd</command>
61 daemon provides NetBIOS nameservice and browsing
62 support. The configuration file for this daemon
63 is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
64 <manvolnum>5</manvolnum></citerefentry>.</para>
69 <term><citerefentry><refentrytitle>winbindd</refentrytitle>
70 <manvolnum>8</manvolnum></citerefentry></term>
71 <listitem><para><command>winbindd</command> is a daemon
72 that is used for integrating authentication and
73 the user database into unix.</para></listitem>
77 <term><citerefentry><refentrytitle>smbclient</refentrytitle>
78 <manvolnum>1</manvolnum></citerefentry></term>
79 <listitem><para>The <command>smbclient</command>
80 program implements a simple ftp-like client. This
81 is useful for accessing SMB shares on other compatible
82 SMB servers, and can also be used
83 to allow a UNIX box to print to a printer attached to
84 any SMB server.</para>
89 <term><citerefentry><refentrytitle>samba-tool</refentrytitle>
90 <manvolnum>8</manvolnum></citerefentry></term>
91 <listitem><para>The <command>samba-tool</command>
92 is the main Samba Administration tool regarding
93 Active Directory services.</para>
98 <term><citerefentry><refentrytitle>testparm</refentrytitle>
99 <manvolnum>1</manvolnum></citerefentry></term>
100 <listitem><para>The <command>testparm</command>
101 utility is a simple syntax checker for Samba's <citerefentry><refentrytitle>smb.conf</refentrytitle>
102 <manvolnum>5</manvolnum></citerefentry> configuration file.
103 In AD server mode <command>samba-tool testparm</command>
104 should be used though.</para>
109 <term><citerefentry><refentrytitle>smbstatus</refentrytitle>
110 <manvolnum>1</manvolnum></citerefentry></term>
111 <listitem><para>The <command>smbstatus</command>
112 tool provides access to information about the
113 current connections to <command>smbd</command>.</para>
118 <term><citerefentry><refentrytitle>nmblookup</refentrytitle>
119 <manvolnum>1</manvolnum></citerefentry></term>
120 <listitem><para>The <command>nmblookup</command>
121 tool allows NetBIOS name queries to be made.</para>
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 setting passwords on local Samba but
130 also on remote SMB servers.</para>
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 SMB servers.</para>
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>
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 directly from SMB servers.</para></listitem>
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 SMB servers. </para></listitem>
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.
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 SMB servers.</para></listitem>
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>
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>
197 <term><citerefentry><refentrytitle>net</refentrytitle>
198 <manvolnum>8</manvolnum></citerefentry></term>
199 <listitem><para>The <command>net</command> command
200 is the main administration tool for Samba member and
201 standalone servers.</para></listitem>
205 <term><citerefentry><refentrytitle>wbinfo</refentrytitle>
206 <manvolnum>1</manvolnum></citerefentry></term>
207 <listitem><para><command>wbinfo</command> is a utility
208 that retrieves and stores information related to winbind.
213 <term><citerefentry><refentrytitle>profiles</refentrytitle>
214 <manvolnum>1</manvolnum></citerefentry></term>
215 <listitem><para><command>profiles</command> is a command-line
216 utility that can be used to replace all occurrences of
217 a certain SID with another SID.
222 <term><citerefentry><refentrytitle>log2pcap</refentrytitle>
223 <manvolnum>1</manvolnum></citerefentry></term>
224 <listitem><para><command>log2pcap</command> is a utility
225 for generating pcap trace files from Samba log
226 files.</para></listitem>
230 <term><citerefentry><refentrytitle>vfstest</refentrytitle>
231 <manvolnum>1</manvolnum></citerefentry></term>
232 <listitem><para><command>vfstest</command> is a utility
233 that can be used to test vfs modules.</para></listitem>
237 <term><citerefentry><refentrytitle>ntlm_auth</refentrytitle>
238 <manvolnum>1</manvolnum></citerefentry></term>
239 <listitem><para><command>ntlm_auth</command> is a helper-utility
240 for external programs wanting to do NTLM-authentication.
241 </para></listitem></varlistentry>
244 <term><citerefentry><refentrytitle>smbcquotas</refentrytitle>
245 <manvolnum>1</manvolnum></citerefentry></term>
246 <listitem><para><command>smbcquotas</command> is a tool to
247 manage quotas on remote SMB servers. </para>
254 <title>COMPONENTS</title>
256 <para>The Samba suite is made up of several components. Each
257 component is described in a separate manual page. It is strongly
258 recommended that you read the documentation that comes with Samba
259 and the manual pages of those components that you use. If the
260 manual pages and documents aren't clear enough then please visit
261 <ulink url="https://devel.samba.org/">https://devel.samba.org</ulink>
262 for information on how to file a bug report or submit a patch.</para>
264 <para>If you require help, visit the Samba webpage at
265 <ulink url="https://www.samba.org/">https://www.samba.org/</ulink> and
266 explore the many option available to you.
271 <title>AVAILABILITY</title>
273 <para>The Samba software suite is licensed under the
274 GNU Public License(GPL). A copy of that license should
275 have come with the package in the file COPYING. You are
276 encouraged to distribute copies of the Samba suite, but
277 please obey the terms of this license.</para>
279 <para>The latest version of the Samba suite can be
280 obtained from <ulink url="https://download.samba.org/pub/samba/">
281 https://download.samba.org/pub/samba/</ulink>.
284 <para>The Samba Wiki at
285 <ulink url="https://wiki.samba.org/">https://wiki.samba.org</ulink>
286 has also a lot of useful information.
287 On the Samba mailing list at
288 <ulink url="https://lists.samba.org/">https://lists.samba.org</ulink>
289 you can find a lot of information in the archives and you can
290 subscribe to the samba list and ask for help or discuss things.
295 <title>VERSION</title>
297 <para>This man page is part of version &doc.version; of the
302 <title>CONTRIBUTIONS</title>
304 <para>If you wish to contribute to the Samba project,
305 then I suggest you join the Samba mailing list at
306 <ulink url="https://lists.samba.org/">https://lists.samba.org</ulink>.
309 <para>If you have patches to submit, visit
310 <ulink url="https://devel.samba.org/">https://devel.samba.org/</ulink>
311 for information on how to do it properly. We prefer patches
312 in <command>git format-patch</command> format.</para>
316 <title>CONTRIBUTORS</title>
318 <para>Contributors to the project are now too numerous
319 to mention here but all deserve the thanks of all Samba
320 users. To see a full list, look at the
321 <filename>change-log</filename> in the source package
322 for the pre-CVS changes and at <ulink
323 url="https://git.samba.org/">
324 https://git.samba.org/</ulink>
325 for the contributors to Samba post-GIT. GIT is the Open Source
326 source code control system used by the Samba Team to develop
327 Samba. The project would have been unmanageable without it.</para>
331 <title>AUTHOR</title>
333 <para>The original Samba software and related utilities
334 were created by Andrew Tridgell. Samba is now developed
335 by the Samba Team as an Open Source project similar
336 to the way the Linux kernel is developed.</para>