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">&doc.version;</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:
 109                 <itemizedlist>
 110                         <listitem><para><emphasis>single</emphasis></para>
 111                         <para>All Samba services run in a single process. This is
 112                         not recommended for production configurations.
 113                         </para></listitem>
 114
 115                         <listitem><para><emphasis>standard</emphasis></para>
 116                         <para>A process is created for each Samba service,
 117                         and for those services that support it (currently only
 118                         LDAP and NETLOGON) a new processes is started
 119                         for each new client connection.</para>
 120
 121                         <para>Historically, this was the 'standard' way Samba behaved
 122                         up until v4.10. Note that this model can be resource intensive
 123                         if you have a large number of client connections.</para>
 124                         </listitem>
 125
 126                         <listitem><para><emphasis>prefork</emphasis></para>
 127                         <para>The default. A process is started for each Samba service,
 128                         and a fixed number of worker processes are started for those
 129                         services that support it (currently LDAP, NETLOGON, and KDC).
 130                         The client connections are then shared amongst the worker
 131                         processes.
 132                         Requests for services not supporting prefork are handled
 133                         by a single process for that service.</para>
 134                         <para>The number of prefork worker processes started is
 135                         controlled by the
 136                         <citerefentry><refentrytitle>smb.conf</refentrytitle>
 137                         <manvolnum>5</manvolnum></citerefentry> parameter
 138                         <smbconfoption name="prefork children"/>,
 139                         which defaults to 4.
 140                         </para></listitem>
 141                 </itemizedlist>
 142                 </para></listitem>
 143                 </varlistentry>
 144
 145                 <varlistentry>
 146                 <term>--maximum-runtime=seconds</term>
 147                 <listitem><para>Set maximum runtime of the server process till
 148                 autotermination in seconds.
 149                 </para></listitem>
 150                 </varlistentry>
 151
 152                 <varlistentry>
 153                 <term>-b|--show-build</term>
 154                 <listitem><para>Print information about how Samba was built.
 155                 </para></listitem>
 156                 </varlistentry>
 157
 158                 <varlistentry>
 159                 <term>--usage</term>
 160                 <listitem><para>Display brief usage message.</para></listitem>
 161                 </varlistentry>
 162
 163                 <varlistentry>
 164                 <term>--debug-stderr</term>
 165                 <listitem><para>Send debug output to STDERR.</para></listitem>
 166                 </varlistentry>
 167
 168                 <varlistentry>
 169                 <term>--leak-report</term>
 170                 <listitem><para>Enable talloc leak reporting on exit.
 171                 </para></listitem>
 172                 </varlistentry>
 173
 174                 <varlistentry>
 175                 <term>--leak-report-full</term>
 176                 <listitem><para>Enable full talloc leak reporting on exit.
 177                 </para></listitem>
 178                 </varlistentry>
 179
 180                 &popt.common.samba.server;
 181                 &popt.autohelp;
 182         </variablelist>
 183 </refsect1>
 184
 185 <refsect1>
 186         <title>FILES</title>
 187
 188         <variablelist>
 189                 <varlistentry>
 190                 <term><filename>/etc/rc</filename></term>
 191                 <listitem><para>or whatever initialization script your
 192                 system uses.</para>
 193
 194                 <para>If running the server as a daemon at startup,
 195                 this file will need to contain an appropriate startup
 196                 sequence for the server. </para></listitem>
 197                 </varlistentry>
 198
 199                 <varlistentry>
 200                 <term><filename>/etc/services</filename></term>
 201                 <listitem><para>If running the server via the
 202                 meta-daemon <command>inetd</command>, this file
 203                 must contain a mapping of service name (e.g., netbios-ssn)
 204                 to service port (e.g., 139) and protocol type (e.g., tcp).
 205                 </para></listitem>
 206                 </varlistentry>
 207
 208                 <varlistentry>
 209                 <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
 210                 <listitem><para>This is the default location of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 211                 <manvolnum>5</manvolnum></citerefentry> server configuration file. Other common places that systems
 212                 install this file are <filename>/usr/samba/lib/smb.conf</filename>
 213                 and <filename>/etc/samba/smb.conf</filename>.</para>
 214
 215                 <para>This file describes all the services the server
 216                 is to make available to clients. See <citerefentry><refentrytitle>smb.conf</refentrytitle>
 217                 <manvolnum>5</manvolnum></citerefentry> for more information.</para>
 218                 </listitem>
 219                 </varlistentry>
 220         </variablelist>
 221 </refsect1>
 222
 223 <refsect1>
 224         <title>DIAGNOSTICS</title>
 225
 226         <para>Most diagnostics issued by the server are logged
 227         in a specified log file. The log file name is specified
 228         at compile time, but may be overridden on the command line.</para>
 229
 230         <para>The number and nature of diagnostics available depends
 231         on the debug level used by the server. If you have problems, set
 232         the debug level to 3 and peruse the log files.</para>
 233
 234         <para>Most messages are reasonably self-explanatory. Unfortunately,
 235         at the time this man page was created, there are too many diagnostics
 236         available in the source code to warrant describing each and every
 237         diagnostic. At this stage your best bet is still to grep the
 238         source code and inspect the conditions that gave rise to the
 239         diagnostics you are seeing.</para>
 240 </refsect1>
 241
 242 <refsect1>
 243         <title>VERSION</title>
 244
 245         <para>This man page is part of version &doc.version; of the Samba suite.</para>
 246 </refsect1>
 247
 248 <refsect1>
 249         <title>SEE ALSO</title>
 250         <para><citerefentry><refentrytitle>hosts_access</refentrytitle>
 251         <manvolnum>5</manvolnum></citerefentry>
 252         <citerefentry><refentrytitle>smb.conf</refentrytitle>
 253         <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
 254         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba-tool</refentrytitle>
 255         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle>
 256         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle>
 257         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>winbindd</refentrytitle>
 258         <manvolnum>1</manvolnum></citerefentry>, and the
 259         Internet RFC's  <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>.
 260         In addition the CIFS (formerly SMB) specification is available
 261         as a link from the Web page <ulink noescape="1" url="https://www.samba.org/cifs/">
 262         https://www.samba.org/cifs/</ulink>.</para>
 263 </refsect1>
 264
 265 <refsect1>
 266         <title>AUTHOR</title>
 267
 268         <para>The original Samba software and related utilities
 269         were created by Andrew Tridgell. Samba is now developed
 270         by the Samba Team as an Open Source project similar
 271         to the way the Linux kernel is developed.</para>
 272 </refsect1>
 273
 274 </refentry>