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