docs/docbook/manpages/samba.7.sgml

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