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