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