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