source4/smbd/samba.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   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 filesharing- and directory services to clients</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>samba</command>
  22                 <arg choice="opt">-i</arg>
  23                 <arg choice="opt">-M model</arg>
  24         </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>DESCRIPTION</title>
  29         <para>This program is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para><command>samba</command> is the server daemon that
  33         provides filesharing and directory services to Windows clients.
  34         The server provides filespace and directory services to
  35         clients using the SMB (or CIFS) protocol and other
  36         related protocols such as DCE/RPC, LDAP and Kerberos.
  37         </para>
  38
  39         <para>
  40         Clients supported include MSCLIENT 3.0 for DOS, Windows for
  41         Workgroups, Windows 95/98/ME, Windows NT, Windows 2000/XP/2003,
  42         OS/2, DAVE for Macintosh, and cifsfs for Linux.</para>
  43
  44         <para>An extensive description of the services that the
  45         server can provide is given in the man page for the
  46         configuration file controlling the attributes of those
  47         services (see <citerefentry><refentrytitle>smb.conf</refentrytitle>
  48         <manvolnum>5</manvolnum></citerefentry>.  This man page will not describe the
  49         services, but will concentrate on the administrative aspects
  50         of running the server.</para>
  51
  52         <para>Please note that there are significant security
  53         implications to running this server, and the <citerefentry><refentrytitle>smb.conf</refentrytitle>
  54         <manvolnum>5</manvolnum></citerefentry> manual page should be regarded as mandatory reading before
  55         proceeding with installation.</para>
  56
  57         <para>As of Samba 4, there is a single daemon that incorporates the
  58                 functionality of both smbd and nmbd that are present in older versions
  59                 of Samba.</para>
  60
  61 </refsect1>
  62
  63 <refsect1>
  64         <title>OPTIONS</title>
  65
  66         <variablelist>
  67                 <varlistentry>
  68                 <term>-i</term>
  69                 <listitem><para>If this parameter is specified it causes the
  70                 server to run "interactively", not as a daemon, even if the
  71                 server is executed on the command line of a shell. Setting this
  72                 parameter negates the implicit daemon mode when run from the
  73                 command line. <command>samba</command> also logs to standard
  74                 output, as if the <command>-S</command> parameter had been
  75                 given.
  76                 </para></listitem>
  77                 </varlistentry>
  78
  79                 <varlistentry>
  80                 <term>-M model</term>
  81                 <listitem><para>This parameter can be used to specify the
  82                 &quot;process model&quot; samba should use. This determines
  83                 how concurrent clients are handled. Available process
  84                 models include <emphasis>single</emphasis> (everything in
  85                 a single process), <emphasis>standard</emphasis> (similar
  86                 behaviour to that of Samba 3), <emphasis>thread</emphasis>
  87                 (single process, different threads.
  88                 </para></listitem>
  89                 </varlistentry>
  90         </variablelist>
  91 </refsect1>
  92
  93 <refsect1>
  94         <title>FILES</title>
  95
  96         <variablelist>
  97                 <varlistentry>
  98                 <term><filename>/etc/rc</filename></term>
  99                 <listitem><para>or whatever initialization script your
 100                 system uses).</para>
 101
 102                 <para>If running the server as a daemon at startup,
 103                 this file will need to contain an appropriate startup
 104                 sequence for the server. </para></listitem>
 105                 </varlistentry>
 106
 107                 <varlistentry>
 108                 <term><filename>/etc/services</filename></term>
 109                 <listitem><para>If running the server via the
 110                 meta-daemon <command>inetd</command>, this file
 111                 must contain a mapping of service name (e.g., netbios-ssn)
 112                 to service port (e.g., 139) and protocol type (e.g., tcp).
 113                 </para></listitem>
 114                 </varlistentry>
 115
 116                 <varlistentry>
 117                 <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
 118                 <listitem><para>This is the default location of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 119                 <manvolnum>5</manvolnum></citerefentry> server configuration file. Other common places that systems
 120                 install this file are <filename>/usr/samba/lib/smb.conf</filename>
 121                 and <filename>/etc/samba/smb.conf</filename>.</para>
 122
 123                 <para>This file describes all the services the server
 124                 is to make available to clients. See <citerefentry><refentrytitle>smb.conf</refentrytitle>
 125                 <manvolnum>5</manvolnum></citerefentry> for more information.</para>
 126                 </listitem>
 127                 </varlistentry>
 128         </variablelist>
 129 </refsect1>
 130
 131 <refsect1>
 132         <title>VERSION</title>
 133
 134         <para>This man page is correct for version 4 of
 135         the Samba suite.</para>
 136 </refsect1>
 137
 138 <refsect1>
 139         <title>DIAGNOSTICS</title>
 140
 141         <para>Most diagnostics issued by the server are logged
 142         in a specified log file. The log file name is specified
 143         at compile time, but may be overridden on the command line.</para>
 144
 145         <para>The number and nature of diagnostics available depends
 146         on the debug level used by the server. If you have problems, set
 147         the debug level to 3 and peruse the log files.</para>
 148
 149         <para>Most messages are reasonably self-explanatory. Unfortunately,
 150         at the time this man page was created, there are too many diagnostics
 151         available in the source code to warrant describing each and every
 152         diagnostic. At this stage your best bet is still to grep the
 153         source code and inspect the conditions that gave rise to the
 154         diagnostics you are seeing.</para>
 155 </refsect1>
 156
 157 <refsect1>
 158         <title>SEE ALSO</title>
 159         <para><citerefentry><refentrytitle>hosts_access</refentrytitle>
 160         <manvolnum>5</manvolnum></citerefentry>
 161         <citerefentry><refentrytitle>smb.conf</refentrytitle>
 162         <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
 163         <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle>
 164         <manvolnum>1</manvolnum></citerefentry>, and the
 165         Internet RFC's  <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>.
 166         In addition the CIFS (formerly SMB) specification is available
 167         as a link from the Web page <ulink noescape="1" url="http://samba.org/cifs/">
 168         http://samba.org/cifs/</ulink>.</para>
 169 </refsect1>
 170
 171 <refsect1>
 172         <title>AUTHOR</title>
 173
 174         <para>The original Samba software and related utilities
 175         were created by Andrew Tridgell. Samba is now developed
 176         by the Samba Team as an Open Source project similar
 177         to the way the Linux kernel is developed.</para>
 178
 179 </refsect1>
 180
 181 </refentry>