docs/docbook/manpages/samba.7.xml

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