docs/docbook/manpages/samba.7.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="samba">
   3
   4 <refmeta>
   5         <refentrytitle>samba</refentrytitle>
   6         <manvolnum>7</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>SAMBA</refname>
  12         <refpurpose>A Windows SMB/CIFS fileserver for UNIX</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis><command>Samba</command></cmdsynopsis>
  17 </refsynopsisdiv>
  18
  19 <refsect1>
  20         <title>DESCRIPTION</title>
  21
  22         <para>The Samba software suite is a collection of programs
  23         that implements the Server Message Block (commonly abbreviated
  24         as SMB) protocol for UNIX systems. This protocol is sometimes
  25         also referred to as the Common Internet File System (CIFS). For a
  26         more thorough description, see <ulink url="http://www.ubiqx.org/cifs/">
  27         http://www.ubiqx.org/cifs/</ulink>. Samba also implements the NetBIOS
  28         protocol in nmbd.</para>
  29
  30         <variablelist>
  31                 <varlistentry>
  32                 <term><command>smbd</command></term>
  33                 <listitem><para>The <command>smbd </command>
  34                 daemon provides the file and print services to
  35                 SMB clients, such as Windows 95/98, Windows NT, Windows
  36                 for Workgroups or LanManager. The configuration file
  37                 for this daemon is described in <filename>smb.conf</filename>
  38                 </para></listitem>
  39                 </varlistentry>
  40
  41                 <varlistentry>
  42                 <term><command>nmbd</command></term>
  43                 <listitem><para>The <command>nmbd</command>
  44                 daemon provides NetBIOS nameservice and browsing
  45                 support. The configuration file for this daemon
  46                 is described in <filename>smb.conf</filename></para>
  47                 </listitem>
  48                 </varlistentry>
  49
  50                 <varlistentry>
  51                 <term><command>smbclient</command></term>
  52                 <listitem><para>The <command>smbclient</command>
  53                 program implements a simple ftp-like client. This
  54                 is useful for accessing SMB shares on other compatible
  55                 servers (such as Windows NT), and can also be used
  56                 to allow a UNIX box to print to a printer attached to
  57                 any SMB server (such as a PC running Windows NT).</para>
  58                 </listitem>
  59                 </varlistentry>
  60
  61                 <varlistentry>
  62                 <term><command>testparm</command></term>
  63                 <listitem><para>The <command>testparm</command>
  64                 utility is a simple syntax checker for Samba's
  65                 <filename>smb.conf</filename>configuration file.</para>
  66                 </listitem>
  67                 </varlistentry>
  68
  69                 <varlistentry>
  70                 <term><command>testprns</command></term>
  71                 <listitem><para>The <command>testprns</command>
  72                 utility supports testing printer names defined
  73                 in your <filename>printcap</filename> file used
  74                 by Samba.</para>
  75                 </listitem>
  76                 </varlistentry>
  77
  78                 <varlistentry>
  79                 <term><command>smbstatus</command></term>
  80                 <listitem><para>The <command>smbstatus</command>
  81                 tool provides access to information about the
  82                 current connections to <command>smbd</command>.</para>
  83                 </listitem>
  84                 </varlistentry>
  85
  86                 <varlistentry>
  87                 <term><command>nmblookup</command></term>
  88                 <listitem><para>The <command>nmblookup</command>
  89                 tools allows NetBIOS name queries to be made
  90                 from a UNIX host.</para>
  91                 </listitem>
  92                 </varlistentry>
  93
  94                 <varlistentry>
  95                 <term><command>make_smbcodepage</command></term>
  96                 <listitem><para>The <command>make_smbcodepage</command>
  97                 utility provides a means of creating SMB code page
  98                 definition files for your <command>smbd</command> server.</para>
  99                 </listitem>
 100                 </varlistentry>
 101
 102                 <varlistentry>
 103                 <term><command>smbpasswd</command></term>
 104                 <listitem><para>The <command>smbpasswd</command>
 105                 command is a tool for changing LanMan and Windows NT
 106                 password hashes on Samba and Windows NT servers.</para>
 107                 </listitem>
 108                 </varlistentry>
 109
 110         </variablelist>
 111 </refsect1>
 112
 113 <refsect1>
 114         <title>COMPONENTS</title>
 115
 116         <para>The Samba suite is made up of several components. Each
 117         component is described in a separate manual page. It is strongly
 118         recommended that you read the documentation that comes with Samba
 119         and the manual pages of those components that you use. If the
 120         manual pages and documents aren't clear enough then please visit
 121         <ulink url="http://devel.samba.org/">http://devel.samba.org</ulink>
 122         for information on how to file a bug report or submit a patch.</para>
 123
 124         <para>If you require help, visit the Samba webpage at
 125         <ulink url="http://samba.org/">http://www.samba.org/</ulink> and
 126         explore the many option available to you.
 127         </para>
 128 </refsect1>
 129
 130 <refsect1>
 131         <title>AVAILABILITY</title>
 132
 133         <para>The Samba software suite is licensed under the
 134         GNU Public License(GPL). A copy of that license should
 135         have come with the package in the file COPYING. You are
 136         encouraged to distribute copies of the Samba suite, but
 137         please obey the terms of this license.</para>
 138
 139         <para>The latest version of the Samba suite can be
 140         obtained via anonymous ftp from samba.org in the
 141         directory pub/samba/. It is also available on several
 142         mirror sites worldwide.</para>
 143
 144         <para>You may also find useful information about Samba
 145         on the newsgroup <ulink url="news:comp.protocols.smb">
 146         comp.protocol.smb</ulink> and the Samba mailing
 147         list. Details on how to join the mailing list are given in
 148         the README file that comes with Samba.</para>
 149
 150         <para>If you have access to a WWW viewer (such as Netscape
 151         or Mosaic) then you will also find lots of useful information,
 152         including back issues of the Samba mailing list, at
 153         <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.</para>
 154 </refsect1>
 155
 156 <refsect1>
 157         <title>VERSION</title>
 158
 159         <para>This man page is correct for version 2.2 of the
 160         Samba suite. </para>
 161 </refsect1>
 162
 163 <refsect1>
 164         <title>CONTRIBUTIONS</title>
 165
 166         <para>If you wish to contribute to the Samba project,
 167         then I suggest you join the Samba mailing list at
 168         <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.
 169         </para>
 170
 171         <para>If you have patches to submit, visit
 172         <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>
 173         for information on how to do it properly. We prefer patches in
 174         <command>diff -u</command> format.</para>
 175 </refsect1>
 176
 177 <refsect1>
 178         <title>CONTRIBUTORS</title>
 179
 180         <para>Contributors to the project are now too numerous
 181         to mention here but all deserve the thanks of all Samba
 182         users. To see a full list, look at <ulink
 183         url="ftp://samba.org/pub/samba/alpha/change-log">
 184         ftp://samba.org/pub/samba/alpha/change-log</ulink>
 185         for the pre-CVS changes and at <ulink
 186         url="ftp://samba.org/pub/samba/alpha/cvs.log">
 187         ftp://samba.org/pub/samba/alpha/cvs.log</ulink>
 188         for the contributors to Samba post-CVS. CVS is the Open Source
 189         source code control system used by the Samba Team to develop
 190         Samba. The project would have been unmanageable without it.</para>
 191
 192         <para>In addition, several commercial organizations now help
 193         fund the Samba Team with money and equipment. For details see
 194         the Samba Web pages at <ulink
 195         url="http://samba.org/samba/samba-thanks.html">
 196         http://samba.org/samba/samba-thanks.html</ulink>.</para>
 197 </refsect1>
 198
 199 <refsect1>
 200         <title>AUTHOR</title>
 201
 202         <para>The original Samba software and related utilities
 203         were created by Andrew Tridgell. Samba is now developed
 204         by the Samba Team as an Open Source project similar
 205         to the way the Linux kernel is developed.</para>
 206
 207         <para>The original Samba man pages were written by Karl Auer.
 208         The man page sources were converted to YODL format (another
 209         excellent piece of Open Source software, available at
 210         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 211         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 212         release by Jeremy Allison.  The conversion to DocBook for
 213         Samba 2.2 was done by Gerald Carter</para>
 214 </refsect1>
 215
 216 </refentry>