docs-xml/manpages/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">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>samba</refname>
  16         <refpurpose>A Windows AD and 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 and provides Active Directory
  29         services. The first version of the SMB protocol is sometimes also
  30         referred to as the Common Internet File System (CIFS). For a more
  31         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>samba</refentrytitle>
  38                 <manvolnum>8</manvolnum></citerefentry></term>
  39                 <listitem><para>The <command>samba</command> daemon provides the
  40                 Active Directory services and file and print services to
  41                 SMB clients. 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>smbd</refentrytitle>
  49                 <manvolnum>8</manvolnum></citerefentry></term>
  50                 <listitem><para>The <command>smbd</command> daemon provides the file and print services to
  51                 SMB clients. The configuration file
  52                 for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
  53                 <manvolnum>5</manvolnum></citerefentry>.
  54                 </para></listitem>
  55                 </varlistentry>
  56
  57                 <varlistentry>
  58                 <term><citerefentry><refentrytitle>nmbd</refentrytitle>
  59                 <manvolnum>8</manvolnum></citerefentry></term>
  60                 <listitem><para>The <command>nmbd</command>
  61                 daemon provides NetBIOS nameservice and browsing
  62                 support. The configuration file for this daemon
  63                 is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
  64                 <manvolnum>5</manvolnum></citerefentry>.</para>
  65                 </listitem>
  66                 </varlistentry>
  67
  68                 <varlistentry>
  69                 <term><citerefentry><refentrytitle>winbindd</refentrytitle>
  70                 <manvolnum>8</manvolnum></citerefentry></term>
  71                 <listitem><para><command>winbindd</command> is a daemon
  72                 that is used for integrating authentication and
  73                 the user database into unix.</para></listitem>
  74                 </varlistentry>
  75
  76                 <varlistentry>
  77                 <term><citerefentry><refentrytitle>smbclient</refentrytitle>
  78                 <manvolnum>1</manvolnum></citerefentry></term>
  79                 <listitem><para>The <command>smbclient</command>
  80                 program implements a simple ftp-like client. This
  81                 is useful for accessing SMB shares on other compatible
  82                 SMB servers, and can also be used
  83                 to allow a UNIX box to print to a printer attached to
  84                 any SMB server.</para>
  85                 </listitem>
  86                 </varlistentry>
  87
  88                 <varlistentry>
  89                 <term><citerefentry><refentrytitle>samba-tool</refentrytitle>
  90                 <manvolnum>8</manvolnum></citerefentry></term>
  91                 <listitem><para>The <command>samba-tool</command>
  92                 is the main Samba Administration tool regarding
  93                 Active Directory services.</para>
  94                 </listitem>
  95                 </varlistentry>
  96
  97                 <varlistentry>
  98                 <term><citerefentry><refentrytitle>testparm</refentrytitle>
  99                 <manvolnum>1</manvolnum></citerefentry></term>
 100                 <listitem><para>The <command>testparm</command>
 101                 utility is a simple syntax checker for Samba's <citerefentry><refentrytitle>smb.conf</refentrytitle>
 102                 <manvolnum>5</manvolnum></citerefentry> configuration file.
 103                 In AD server mode <command>samba-tool testparm</command>
 104                 should be used though.</para>
 105                 </listitem>
 106                 </varlistentry>
 107
 108                 <varlistentry>
 109                 <term><citerefentry><refentrytitle>smbstatus</refentrytitle>
 110                 <manvolnum>1</manvolnum></citerefentry></term>
 111                 <listitem><para>The <command>smbstatus</command>
 112                 tool provides access to information about the
 113                 current connections to <command>smbd</command>.</para>
 114                 </listitem>
 115                 </varlistentry>
 116
 117                 <varlistentry>
 118                 <term><citerefentry><refentrytitle>nmblookup</refentrytitle>
 119                 <manvolnum>1</manvolnum></citerefentry></term>
 120                 <listitem><para>The <command>nmblookup</command>
 121                 tool allows NetBIOS name queries to be made.</para>
 122                 </listitem>
 123                 </varlistentry>
 124
 125                 <varlistentry>
 126                 <term><citerefentry><refentrytitle>smbpasswd</refentrytitle>
 127                 <manvolnum>8</manvolnum></citerefentry></term>
 128                 <listitem><para>The <command>smbpasswd</command>
 129                 command is a tool for setting passwords on local Samba but
 130                 also on remote SMB servers.</para>
 131                 </listitem>
 132                 </varlistentry>
 133
 134                 <varlistentry>
 135                 <term><citerefentry><refentrytitle>smbcacls</refentrytitle>
 136                 <manvolnum>1</manvolnum></citerefentry></term>
 137                 <listitem><para>The <command>smbcacls</command> command is
 138                 a tool to set ACL's on remote SMB servers.</para>
 139                 </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 directly from 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 SMB 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
 169                 <command>samba</command>, <command>smbd</command>, <command>nmbd</command> and
 170                 <command>winbindd</command> daemons.
 171                 </para></listitem>
 172                 </varlistentry>
 173
 174                 <varlistentry>
 175                 <term><citerefentry><refentrytitle>rpcclient</refentrytitle>
 176                 <manvolnum>1</manvolnum></citerefentry></term>
 177                 <listitem><para><command>rpcclient</command> is a utility
 178                 that can be used to execute RPC commands on remote
 179                 SMB servers.</para></listitem>
 180                 </varlistentry>
 181
 182                 <varlistentry>
 183                 <term><citerefentry><refentrytitle>pdbedit</refentrytitle>
 184                 <manvolnum>8</manvolnum></citerefentry></term>
 185                 <listitem><para>The <command>pdbedit</command> command
 186                 can be used to maintain the local user database on
 187                 a Samba server.</para></listitem></varlistentry>
 188
 189                 <varlistentry>
 190                 <term><citerefentry><refentrytitle>net</refentrytitle>
 191                 <manvolnum>8</manvolnum></citerefentry></term>
 192                 <listitem><para>The <command>net</command> command
 193                 is the main administration tool for Samba member and
 194                 standalone servers.</para></listitem>
 195                 </varlistentry>
 196
 197                 <varlistentry>
 198                 <term><citerefentry><refentrytitle>wbinfo</refentrytitle>
 199                 <manvolnum>1</manvolnum></citerefentry></term>
 200                 <listitem><para><command>wbinfo</command> is a utility
 201                 that retrieves and stores information related to winbind.
 202                 </para></listitem>
 203                 </varlistentry>
 204
 205                 <varlistentry>
 206                 <term><citerefentry><refentrytitle>profiles</refentrytitle>
 207                 <manvolnum>1</manvolnum></citerefentry></term>
 208                 <listitem><para><command>profiles</command> is a command-line
 209                 utility that can be used to replace all occurrences of
 210                 a certain SID with another SID.
 211                 </para></listitem>
 212                 </varlistentry>
 213
 214                 <varlistentry>
 215                 <term><citerefentry><refentrytitle>log2pcap</refentrytitle>
 216                                 <manvolnum>1</manvolnum></citerefentry></term>
 217                 <listitem><para><command>log2pcap</command> is a utility
 218                                 for generating pcap trace files from Samba log
 219                                 files.</para></listitem>
 220                 </varlistentry>
 221
 222                 <varlistentry>
 223                 <term><citerefentry><refentrytitle>vfstest</refentrytitle>
 224                 <manvolnum>1</manvolnum></citerefentry></term>
 225                 <listitem><para><command>vfstest</command> is a utility
 226                 that can be used to test vfs modules.</para></listitem>
 227                 </varlistentry>
 228
 229                 <varlistentry>
 230                 <term><citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 231                 <manvolnum>1</manvolnum></citerefentry></term>
 232                 <listitem><para><command>ntlm_auth</command> is a helper-utility
 233                 for external programs wanting to do NTLM-authentication.
 234                 </para></listitem></varlistentry>
 235
 236                 <varlistentry>
 237                 <term><citerefentry><refentrytitle>smbcquotas</refentrytitle>
 238                 <manvolnum>1</manvolnum></citerefentry></term>
 239                 <listitem><para><command>smbcquotas</command> is a tool to
 240                 manage quotas on remote SMB servers. </para>
 241                 </listitem>
 242                 </varlistentry>
 243         </variablelist>
 244 </refsect1>
 245
 246 <refsect1>
 247         <title>COMPONENTS</title>
 248
 249         <para>The Samba suite is made up of several components. Each
 250         component is described in a separate manual page. It is strongly
 251         recommended that you read the documentation that comes with Samba
 252         and the manual pages of those components that you use. If the
 253         manual pages and documents aren't clear enough then please visit
 254         <ulink url="https://devel.samba.org/">https://devel.samba.org</ulink>
 255         for information on how to file a bug report or submit a patch.</para>
 256
 257         <para>If you require help, visit the Samba webpage at
 258         <ulink url="https://www.samba.org/">https://www.samba.org/</ulink> and
 259         explore the many option available to you.
 260         </para>
 261 </refsect1>
 262
 263 <refsect1>
 264         <title>AVAILABILITY</title>
 265
 266         <para>The Samba software suite is licensed under the
 267         GNU Public License(GPL). A copy of that license should
 268         have come with the package in the file COPYING. You are
 269         encouraged to distribute copies of the Samba suite, but
 270         please obey the terms of this license.</para>
 271
 272         <para>The latest version of the Samba suite can be
 273         obtained from <ulink url="https://download.samba.org/pub/samba/">
 274         https://download.samba.org/pub/samba/</ulink>.
 275         </para>
 276
 277         <para>The Samba Wiki at
 278         <ulink url="https://wiki.samba.org/">https://wiki.samba.org</ulink>
 279         has also a lot of useful information.
 280         On the Samba mailing list at
 281         <ulink url="https://lists.samba.org/">https://lists.samba.org</ulink>
 282         you can find a lot of information in the archives and you can
 283         subscribe to the samba list and ask for help or discuss things.
 284         </para>
 285 </refsect1>
 286
 287 <refsect1>
 288         <title>VERSION</title>
 289
 290         <para>This man page is part of version &doc.version; of the
 291         Samba suite. </para>
 292 </refsect1>
 293
 294 <refsect1>
 295         <title>CONTRIBUTIONS</title>
 296
 297         <para>If you wish to contribute to the Samba project,
 298         then I suggest you join the Samba mailing list at
 299         <ulink url="https://lists.samba.org/">https://lists.samba.org</ulink>.
 300         </para>
 301
 302         <para>If you have patches to submit, visit
 303         <ulink url="https://devel.samba.org/">https://devel.samba.org/</ulink>
 304         for information on how to do it properly. We prefer patches
 305         in <command>git format-patch</command> format.</para>
 306 </refsect1>
 307
 308 <refsect1>
 309         <title>CONTRIBUTORS</title>
 310
 311         <para>Contributors to the project are now too numerous
 312         to mention here but all deserve the thanks of all Samba
 313         users. To see a full list, look at the
 314         <filename>change-log</filename> in the source package
 315         for the pre-CVS changes and at <ulink
 316         url="https://git.samba.org/">
 317         https://git.samba.org/</ulink>
 318         for the contributors to Samba post-GIT. GIT is the Open Source
 319         source code control system used by the Samba Team to develop
 320         Samba. The project would have been unmanageable without it.</para>
 321 </refsect1>
 322
 323 <refsect1>
 324         <title>AUTHOR</title>
 325
 326         <para>The original Samba software and related utilities
 327         were created by Andrew Tridgell. Samba is now developed
 328         by the Samba Team as an Open Source project similar
 329         to the way the Linux kernel is developed.</para>
 330 </refsect1>
 331
 332 </refentry>