docs/docbook/manpages/samba.7.xml

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