docs: Update doc to use absolute path for 'dedicated keytab file'
[sfrench/samba-autobuild/.git] / docs-xml / manpages / samba.8.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.8">
4
5 <refmeta>
6         <refentrytitle>samba</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>samba</refname>
16         <refpurpose>Server to provide AD and SMB/CIFS services to clients</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>samba</command>
22                 <arg choice="opt">-D</arg>
23                 <arg choice="opt">-i</arg>
24                 <arg choice="opt">-M &lt;model&gt;</arg>
25                 <arg choice="opt">--maximum-runtime=&lt;seconds&gt;</arg>
26                 <arg choice="opt">-b</arg>
27                 <arg choice="opt">--help</arg>
28                 <arg choice="opt">--usage</arg>
29                 <arg choice="opt">-d &lt;debug level&gt;</arg>
30                 <arg choice="opt">--debug-stderr</arg>
31                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
32                 <arg choice="opt">--option=&lt;smb_conf_param&gt;=&lt;value&gt;</arg>
33                 <arg choice="opt">-l &lt;log directory&gt;</arg>
34                 <arg choice="opt">--leak-report</arg>
35                 <arg choice="opt">--leak-report-full</arg>
36                 <arg choice="opt">-V</arg>
37         </cmdsynopsis>
38 </refsynopsisdiv>
39
40 <refsect1>
41         <title>DESCRIPTION</title>
42         <para>This program is part of the <citerefentry><refentrytitle>samba</refentrytitle>
43         <manvolnum>7</manvolnum></citerefentry> suite.</para>
44
45         <para><command>samba</command> is the server daemon that
46         provides Active Directory, filesharing and printing services to clients.
47         The server provides filespace and directory services to
48         clients using the SMB (or CIFS) protocol and other
49         related protocols such as DCE/RPC, LDAP and Kerberos.
50         </para>
51
52         <para>
53         Clients supported include MSCLIENT 3.0 for DOS, Windows for
54         Workgroups, Windows 95/98/ME, Windows NT, Windows 2000/XP/2003,
55         OS/2, DAVE for Macintosh, and cifsfs for Linux.</para>
56
57         <para>An extensive description of the services that the
58         server can provide is given in the man page for the
59         configuration file controlling the attributes of those
60         services (see <citerefentry><refentrytitle>smb.conf</refentrytitle>
61         <manvolnum>5</manvolnum></citerefentry>.  This man page will not describe the
62         services, but will concentrate on the administrative aspects
63         of running the server.
64         </para>
65
66         <para>Please note that there are significant security
67         implications to running this server, and the <citerefentry><refentrytitle>smb.conf</refentrytitle>
68         <manvolnum>5</manvolnum></citerefentry> manual page should be regarded as mandatory reading before
69         proceeding with installation.
70         </para>
71 </refsect1>
72
73 <refsect1>
74         <title>OPTIONS</title>
75
76         <variablelist>
77                 <varlistentry>
78                 <term>-D|--daemon</term>
79                 <listitem><para>If specified, this parameter causes
80                 the server to operate as a daemon. That is, it detaches
81                 itself and runs in the background, fielding requests
82                 on the appropriate ports. Operating the server as a
83                 daemon is the recommended way of running
84                 <command>samba</command> for servers that provide more
85                 than casual use file and print services.  This switch is
86                 assumed if <command>samba</command> is executed on the
87                 command line of a shell.
88                 </para></listitem>
89                 </varlistentry>
90
91                 <varlistentry>
92                 <term>-i|--interactive</term>
93                 <listitem><para>If this parameter is specified it causes the
94                 server to run "interactively", not as a daemon, even if the
95                 server is executed on the command line of a shell. Setting this
96                 parameter negates the implicit daemon mode when run from the
97                 command line. <command>samba</command> also logs to standard
98                 output, as if the <command>-S</command> parameter had been
99                 given.
100                 </para></listitem>
101                 </varlistentry>
102
103                 <varlistentry>
104                 <term>-M model</term>
105                 <listitem><para>This parameter can be used to specify the
106                 &quot;process model&quot; samba should use. This determines
107                 how concurrent clients are handled. Available process
108                 models include <emphasis>single</emphasis> (everything in
109                 a single process), <emphasis>standard</emphasis> (similar
110                 behaviour to that of Samba 3), <emphasis>thread</emphasis>
111                 (single process, different threads.
112                 </para></listitem>
113                 </varlistentry>
114
115                 <varlistentry>
116                 <term>--maximum-runtime=seconds</term>
117                 <listitem><para>Set maximum runtime of the server process till
118                 autotermination in seconds.
119                 </para></listitem>
120                 </varlistentry>
121
122                 <varlistentry>
123                 <term>-b|--show-build</term>
124                 <listitem><para>Print information about how Samba was built.
125                 </para></listitem>
126                 </varlistentry>
127
128                 <varlistentry>
129                 <term>--usage</term>
130                 <listitem><para>Display brief usage message.</para></listitem>
131                 </varlistentry>
132
133                 <varlistentry>
134                 <term>--debug-stderr</term>
135                 <listitem><para>Send debug output to STDERR.</para></listitem>
136                 </varlistentry>
137
138                 <varlistentry>
139                 <term>--leak-report</term>
140                 <listitem><para>Enable talloc leak reporting on exit.
141                 </para></listitem>
142                 </varlistentry>
143
144                 <varlistentry>
145                 <term>--leak-report-full</term>
146                 <listitem><para>Enable full talloc leak reporting on exit.
147                 </para></listitem>
148                 </varlistentry>
149
150                 &popt.common.samba.server;
151                 &popt.autohelp;
152         </variablelist>
153 </refsect1>
154
155 <refsect1>
156         <title>FILES</title>
157
158         <variablelist>
159                 <varlistentry>
160                 <term><filename>/etc/rc</filename></term>
161                 <listitem><para>or whatever initialization script your
162                 system uses.</para>
163
164                 <para>If running the server as a daemon at startup,
165                 this file will need to contain an appropriate startup
166                 sequence for the server. </para></listitem>
167                 </varlistentry>
168
169                 <varlistentry>
170                 <term><filename>/etc/services</filename></term>
171                 <listitem><para>If running the server via the
172                 meta-daemon <command>inetd</command>, this file
173                 must contain a mapping of service name (e.g., netbios-ssn)
174                 to service port (e.g., 139) and protocol type (e.g., tcp).
175                 </para></listitem>
176                 </varlistentry>
177
178                 <varlistentry>
179                 <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
180                 <listitem><para>This is the default location of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
181                 <manvolnum>5</manvolnum></citerefentry> server configuration file. Other common places that systems
182                 install this file are <filename>/usr/samba/lib/smb.conf</filename>
183                 and <filename>/etc/samba/smb.conf</filename>.</para>
184
185                 <para>This file describes all the services the server
186                 is to make available to clients. See <citerefentry><refentrytitle>smb.conf</refentrytitle>
187                 <manvolnum>5</manvolnum></citerefentry> for more information.</para>
188                 </listitem>
189                 </varlistentry>
190         </variablelist>
191 </refsect1>
192
193 <refsect1>
194         <title>DIAGNOSTICS</title>
195
196         <para>Most diagnostics issued by the server are logged
197         in a specified log file. The log file name is specified
198         at compile time, but may be overridden on the command line.</para>
199
200         <para>The number and nature of diagnostics available depends
201         on the debug level used by the server. If you have problems, set
202         the debug level to 3 and peruse the log files.</para>
203
204         <para>Most messages are reasonably self-explanatory. Unfortunately,
205         at the time this man page was created, there are too many diagnostics
206         available in the source code to warrant describing each and every
207         diagnostic. At this stage your best bet is still to grep the
208         source code and inspect the conditions that gave rise to the
209         diagnostics you are seeing.</para>
210 </refsect1>
211
212 <refsect1>
213         <title>VERSION</title>
214
215         <para>This man page is correct for version 4 of the Samba suite.</para>
216 </refsect1>
217
218 <refsect1>
219         <title>SEE ALSO</title>
220         <para><citerefentry><refentrytitle>hosts_access</refentrytitle>
221         <manvolnum>5</manvolnum></citerefentry>
222         <citerefentry><refentrytitle>smb.conf</refentrytitle>
223         <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
224         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba-tool</refentrytitle>
225         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle>
226         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle>
227         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>winbindd</refentrytitle>
228         <manvolnum>1</manvolnum></citerefentry>, and the
229         Internet RFC's  <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>.
230         In addition the CIFS (formerly SMB) specification is available
231         as a link from the Web page <ulink noescape="1" url="https://www.samba.org/cifs/">
232         https://www.samba.org/cifs/</ulink>.</para>
233 </refsect1>
234
235 <refsect1>
236         <title>AUTHOR</title>
237
238         <para>The original Samba software and related utilities
239         were created by Andrew Tridgell. Samba is now developed
240         by the Samba Team as an Open Source project similar
241         to the way the Linux kernel is developed.</para>
242 </refsect1>
243
244 </refentry>