docs-xml/manpages-3/samba.7.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.7">
   4
   5 <refmeta>
   6         <refentrytitle>samba</refentrytitle>
   7         <manvolnum>7</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">Miscellanea</refmiscinfo>
  10         <refmiscinfo class="version">3.6</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>samba</refname>
  16         <refpurpose>A Windows SMB/CIFS fileserver for UNIX</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis><command>samba</command></cmdsynopsis>
  21 </refsynopsisdiv>
  22
  23 <refsect1>
  24         <title>DESCRIPTION</title>
  25
  26         <para>The Samba software suite is a collection of programs
  27         that implements the Server Message Block (commonly abbreviated
  28         as SMB) protocol for UNIX systems. This protocol is sometimes
  29         also referred to as the Common Internet File System (CIFS). For a
  30         more thorough description, see <ulink url="http://www.ubiqx.org/cifs/">
  31         http://www.ubiqx.org/cifs/</ulink>. Samba also implements the NetBIOS
  32         protocol in nmbd.</para>
  33
  34         <variablelist>
  35                 <varlistentry>
  36                 <term><citerefentry><refentrytitle>smbd</refentrytitle>
  37                 <manvolnum>8</manvolnum></citerefentry></term>
  38                 <listitem><para>The <command>smbd</command> daemon provides the file and print services to
  39                 SMB clients, such as Windows 95/98, Windows NT, Windows
  40                 for Workgroups or LanManager. The configuration file
  41                 for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
  42                 <manvolnum>5</manvolnum></citerefentry>
  43                 </para></listitem>
  44                 </varlistentry>
  45
  46                 <varlistentry>
  47                 <term><citerefentry><refentrytitle>nmbd</refentrytitle>
  48                 <manvolnum>8</manvolnum></citerefentry></term>
  49                 <listitem><para>The <command>nmbd</command>
  50                 daemon provides NetBIOS nameservice and browsing
  51                 support. The configuration file for this daemon
  52                 is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
  53                 <manvolnum>5</manvolnum></citerefentry></para>
  54                 </listitem>
  55                 </varlistentry>
  56
  57                 <varlistentry>
  58                 <term><citerefentry><refentrytitle>smbclient</refentrytitle>
  59                 <manvolnum>1</manvolnum></citerefentry></term>
  60                 <listitem><para>The <command>smbclient</command>
  61                 program implements a simple ftp-like client. This
  62                 is useful for accessing SMB shares on other compatible
  63                 servers (such as Windows NT), and can also be used
  64                 to allow a UNIX box to print to a printer attached to
  65                 any SMB server (such as a PC running Windows NT).</para>
  66                 </listitem>
  67                 </varlistentry>
  68
  69                 <varlistentry>
  70                 <term><citerefentry><refentrytitle>testparm</refentrytitle>
  71                 <manvolnum>1</manvolnum></citerefentry></term>
  72                 <listitem><para>The <command>testparm</command>
  73                 utility is a simple syntax checker for Samba's <citerefentry><refentrytitle>smb.conf</refentrytitle>
  74                 <manvolnum>5</manvolnum></citerefentry> configuration file.</para>
  75                 </listitem>
  76                 </varlistentry>
  77
  78                 <varlistentry>
  79                 <term><citerefentry><refentrytitle>smbstatus</refentrytitle>
  80                 <manvolnum>1</manvolnum></citerefentry></term>
  81                 <listitem><para>The <command>smbstatus</command>
  82                 tool provides access to information about the
  83                 current connections to <command>smbd</command>.</para>
  84                 </listitem>
  85                 </varlistentry>
  86
  87                 <varlistentry>
  88                 <term><citerefentry><refentrytitle>nmblookup</refentrytitle>
  89                 <manvolnum>1</manvolnum></citerefentry></term>
  90                 <listitem><para>The <command>nmblookup</command>
  91                 tools allows NetBIOS name queries to be made
  92                 from a UNIX host.</para>
  93                 </listitem>
  94                 </varlistentry>
  95
  96                 <varlistentry>
  97                 <term><citerefentry><refentrytitle>smbpasswd</refentrytitle>
  98                 <manvolnum>8</manvolnum></citerefentry></term>
  99                 <listitem><para>The <command>smbpasswd</command>
 100                 command is a tool for changing LanMan and Windows NT
 101                 password hashes on Samba and Windows NT servers.</para>
 102                 </listitem>
 103                 </varlistentry>
 104
 105                 <varlistentry>
 106                 <term><citerefentry><refentrytitle>smbcacls</refentrytitle>
 107                 <manvolnum>1</manvolnum></citerefentry></term>
 108                 <listitem><para>The <command>smbcacls</command> command is
 109                 a tool to set ACL's on remote CIFS servers. </para>
 110                 </listitem>
 111                 </varlistentry>
 112
 113                 <varlistentry>
 114                 <term><citerefentry><refentrytitle>smbtree</refentrytitle>
 115                 <manvolnum>1</manvolnum></citerefentry></term>
 116                 <listitem><para>The <command>smbtree</command> command
 117                 is a text-based network neighborhood tool.</para></listitem>
 118                 </varlistentry>
 119
 120                 <varlistentry>
 121                 <term><citerefentry><refentrytitle>smbtar</refentrytitle>
 122                 <manvolnum>1</manvolnum></citerefentry></term>
 123                 <listitem><para>The <command>smbtar</command> can make
 124                 backups of data on CIFS/SMB servers.</para></listitem>
 125                 </varlistentry>
 126
 127                 <varlistentry>
 128                 <term><citerefentry><refentrytitle>smbspool</refentrytitle>
 129                 <manvolnum>8</manvolnum></citerefentry></term>
 130                 <listitem><para><command>smbspool</command> is a
 131                 helper utility for printing on printers connected
 132                 to CIFS servers. </para></listitem>
 133                 </varlistentry>
 134
 135                 <varlistentry>
 136                 <term><citerefentry><refentrytitle>smbcontrol</refentrytitle>
 137                 <manvolnum>1</manvolnum></citerefentry></term>
 138                 <listitem><para><command>smbcontrol</command> is a utility
 139                 that can change the behaviour of running samba daemons.
 140                 </para></listitem>
 141                 </varlistentry>
 142
 143                 <varlistentry>
 144                 <term><citerefentry><refentrytitle>rpcclient</refentrytitle>
 145                 <manvolnum>1</manvolnum></citerefentry></term>
 146                 <listitem><para><command>rpcclient</command> is a utility
 147                 that can be used to execute RPC commands on remote
 148                 CIFS servers.</para></listitem>
 149                 </varlistentry>
 150
 151                 <varlistentry>
 152                 <term><citerefentry><refentrytitle>pdbedit</refentrytitle>
 153                 <manvolnum>8</manvolnum></citerefentry></term>
 154                 <listitem><para>The <command>pdbedit</command> command
 155                 can be used to maintain the local user database on
 156                 a samba server.</para></listitem></varlistentry>
 157
 158                 <varlistentry>
 159                 <term><citerefentry><refentrytitle>findsmb</refentrytitle>
 160                 <manvolnum>1</manvolnum></citerefentry></term>
 161                 <listitem><para>The <command>findsmb</command> command
 162                 can be used to find SMB servers on the local network.
 163                 </para></listitem></varlistentry>
 164
 165                 <varlistentry>
 166                 <term><citerefentry><refentrytitle>net</refentrytitle>
 167                 <manvolnum>8</manvolnum></citerefentry></term>
 168                 <listitem><para>The <command>net</command> command
 169                 is supposed to work similar to the DOS/Windows
 170                 NET.EXE command.</para></listitem>
 171                 </varlistentry>
 172
 173                 <varlistentry>
 174                 <term><citerefentry><refentrytitle>swat</refentrytitle>
 175                 <manvolnum>8</manvolnum></citerefentry></term>
 176                 <listitem><para><command>swat</command> is a web-based
 177                 interface to configuring <filename>smb.conf</filename>.
 178                 </para></listitem>
 179                 </varlistentry>
 180
 181                 <varlistentry>
 182                 <term><citerefentry><refentrytitle>winbindd</refentrytitle>
 183                 <manvolnum>8</manvolnum></citerefentry></term>
 184                 <listitem><para><command>winbindd</command> is a daemon
 185                 that is used for integrating authentication and
 186                 the user database into unix.</para></listitem>
 187                 </varlistentry>
 188
 189                 <varlistentry>
 190                 <term><citerefentry><refentrytitle>wbinfo</refentrytitle>
 191                 <manvolnum>1</manvolnum></citerefentry></term>
 192                 <listitem><para><command>wbinfo</command> is a utility
 193                 that retrieves and stores information related to winbind.
 194                 </para></listitem>
 195                 </varlistentry>
 196
 197                 <varlistentry>
 198                 <term><citerefentry><refentrytitle>profiles</refentrytitle>
 199                 <manvolnum>1</manvolnum></citerefentry></term>
 200                 <listitem><para><command>profiles</command> is a command-line
 201                 utility that can be used to replace all occurrences of
 202                 a certain SID with another SID.
 203                 </para></listitem>
 204                 </varlistentry>
 205
 206                 <varlistentry>
 207                 <term><citerefentry><refentrytitle>log2pcap</refentrytitle>
 208                                 <manvolnum>1</manvolnum></citerefentry></term>
 209                 <listitem><para><command>log2pcap</command> is a utility
 210                                 for generating pcap trace files from Samba log
 211                                 files.</para></listitem>
 212                 </varlistentry>
 213
 214                 <varlistentry>
 215                 <term><citerefentry><refentrytitle>vfstest</refentrytitle>
 216                 <manvolnum>1</manvolnum></citerefentry></term>
 217                 <listitem><para><command>vfstest</command> is a utility
 218                 that can be used to test vfs modules.</para></listitem>
 219                 </varlistentry>
 220
 221                 <varlistentry>
 222                 <term><citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 223                 <manvolnum>1</manvolnum></citerefentry></term>
 224                 <listitem><para><command>ntlm_auth</command> is a helper-utility
 225                 for external programs wanting to do NTLM-authentication.
 226                 </para></listitem></varlistentry>
 227
 228                 <varlistentry>
 229                 <term><citerefentry><refentrytitle>smbcquotas</refentrytitle>
 230                 <manvolnum>1</manvolnum></citerefentry></term>
 231                 <listitem><para><command>smbcquotas</command> is a tool that
 232                 can set remote QUOTA's on server with NTFS 5. </para>
 233                 </listitem>
 234                 </varlistentry>
 235         </variablelist>
 236 </refsect1>
 237
 238 <refsect1>
 239         <title>COMPONENTS</title>
 240
 241         <para>The Samba suite is made up of several components. Each
 242         component is described in a separate manual page. It is strongly
 243         recommended that you read the documentation that comes with Samba
 244         and the manual pages of those components that you use. If the
 245         manual pages and documents aren't clear enough then please visit
 246         <ulink url="http://devel.samba.org/">http://devel.samba.org</ulink>
 247         for information on how to file a bug report or submit a patch.</para>
 248
 249         <para>If you require help, visit the Samba webpage at
 250         <ulink url="http://samba.org/">http://www.samba.org/</ulink> and
 251         explore the many option available to you.
 252         </para>
 253 </refsect1>
 254
 255 <refsect1>
 256         <title>AVAILABILITY</title>
 257
 258         <para>The Samba software suite is licensed under the
 259         GNU Public License(GPL). A copy of that license should
 260         have come with the package in the file COPYING. You are
 261         encouraged to distribute copies of the Samba suite, but
 262         please obey the terms of this license.</para>
 263
 264         <para>The latest version of the Samba suite can be
 265         obtained via anonymous ftp from samba.org in the
 266         directory pub/samba/. It is also available on several
 267         mirror sites worldwide.</para>
 268
 269         <para>You may also find useful information about Samba
 270         on the newsgroup <ulink url="news:comp.protocols.smb">
 271         comp.protocol.smb</ulink> and the Samba mailing
 272         list. Details on how to join the mailing list are given in
 273         the README file that comes with Samba.</para>
 274
 275         <para>If you have access to a WWW viewer (such as Mozilla
 276         or Konqueror) then you will also find lots of useful information,
 277         including back issues of the Samba mailing list, at
 278         <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.</para>
 279 </refsect1>
 280
 281 <refsect1>
 282         <title>VERSION</title>
 283
 284         <para>This man page is correct for version 3 of the
 285         Samba suite. </para>
 286 </refsect1>
 287
 288 <refsect1>
 289         <title>CONTRIBUTIONS</title>
 290
 291         <para>If you wish to contribute to the Samba project,
 292         then I suggest you join the Samba mailing list at
 293         <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.
 294         </para>
 295
 296         <para>If you have patches to submit, visit
 297         <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>
 298         for information on how to do it properly. We prefer patches
 299         in <command>diff -u</command> format.</para>
 300 </refsect1>
 301
 302 <refsect1>
 303         <title>CONTRIBUTORS</title>
 304
 305         <para>Contributors to the project are now too numerous
 306         to mention here but all deserve the thanks of all Samba
 307         users. To see a full list, look at the
 308         <filename>change-log</filename> in the source package
 309         for the pre-CVS changes and at <ulink
 310         url="http://cvs.samba.org/">
 311         http://cvs.samba.org/</ulink>
 312         for the contributors to Samba post-CVS. CVS is the Open Source
 313         source code control system used by the Samba Team to develop
 314         Samba. The project would have been unmanageable without it.</para>
 315 </refsect1>
 316
 317 <refsect1>
 318         <title>AUTHOR</title>
 319
 320         <para>The original Samba software and related utilities
 321         were created by Andrew Tridgell. Samba is now developed
 322         by the Samba Team as an Open Source project similar
 323         to the way the Linux kernel is developed.</para>
 324
 325         <para>The original Samba man pages were written by Karl Auer.
 326         The man page sources were converted to YODL format (another
 327         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 328         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 329         release by Jeremy Allison.  The conversion to DocBook for
 330         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML
 331         4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
 332 </refsect1>
 333
 334 </refentry>