2004-04-07 14:15:11 +04:00
<?xml version="1.0" encoding="iso-8859-1"?>
2005-03-12 22:33:59 +03:00
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
2004-04-07 14:15:11 +04:00
<refentry id= "samba.7" >
<refmeta >
<refentrytitle > samba</refentrytitle>
<manvolnum > 7</manvolnum>
2008-04-07 00:26:45 +04:00
<refmiscinfo class= "source" > Samba</refmiscinfo>
<refmiscinfo class= "manual" > Miscellanea</refmiscinfo>
2017-12-12 11:08:06 +03:00
<refmiscinfo class= "version" > &doc.version; </refmiscinfo>
2004-04-07 14:15:11 +04:00
</refmeta>
<refnamediv >
<refname > samba</refname>
2012-11-30 14:37:33 +04:00
<refpurpose > A Windows AD and SMB/CIFS fileserver for UNIX</refpurpose>
2004-04-07 14:15:11 +04:00
</refnamediv>
<refsynopsisdiv >
2004-04-27 18:43:44 +04:00
<cmdsynopsis > <command > samba</command> </cmdsynopsis>
2004-04-07 14:15:11 +04:00
</refsynopsisdiv>
<refsect1 >
<title > DESCRIPTION</title>
2012-11-30 14:37:33 +04:00
<para > The Samba software suite is a collection of programs
that implements the Server Message Block (commonly abbreviated
as SMB) protocol for UNIX systems and provides Active Directory
2018-05-04 23:22:53 +03:00
services. The first version of the SMB protocol is sometimes also
2017-12-08 23:06:56 +03:00
referred to as the Common Internet File System (CIFS). For a more
thorough description, see <ulink url= "http://www.ubiqx.org/cifs/" >
2004-04-07 14:15:11 +04:00
http://www.ubiqx.org/cifs/</ulink> . Samba also implements the NetBIOS
protocol in nmbd.</para>
2012-11-30 14:37:33 +04:00
2004-04-07 14:15:11 +04:00
<variablelist >
2012-11-30 14:37:33 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > samba</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > samba</command> daemon provides the
Active Directory services and file and print services to
SMB clients. The configuration file
for this daemon is described in <citerefentry > <refentrytitle > smb.conf</refentrytitle>
<manvolnum > 5</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
2004-04-07 14:15:11 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > smbd</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > The <command > smbd</command> daemon provides the file and print services to
2017-12-08 23:06:56 +03:00
SMB clients. The configuration file
2004-04-07 14:15:11 +04:00
for this daemon is described in <citerefentry > <refentrytitle > smb.conf</refentrytitle>
2012-11-30 14:37:33 +04:00
<manvolnum > 5</manvolnum> </citerefentry> .
2004-04-07 14:15:11 +04:00
</para> </listitem>
</varlistentry>
2012-11-30 14:37:33 +04:00
2004-04-07 14:15:11 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > nmbd</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > nmbd</command>
daemon provides NetBIOS nameservice and browsing
2012-11-30 14:37:33 +04:00
support. The configuration file for this daemon
2004-04-07 14:15:11 +04:00
is described in <citerefentry > <refentrytitle > smb.conf</refentrytitle>
2012-11-30 14:37:33 +04:00
<manvolnum > 5</manvolnum> </citerefentry> .</para>
2004-04-07 14:15:11 +04:00
</listitem>
</varlistentry>
2012-11-30 14:37:33 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > winbindd</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
<listitem > <para > <command > winbindd</command> is a daemon
that is used for integrating authentication and
the user database into unix.</para> </listitem>
</varlistentry>
2004-04-07 14:15:11 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > smbclient</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > smbclient</command>
2012-11-30 14:37:33 +04:00
program implements a simple ftp-like client. This
2004-04-07 14:15:11 +04:00
is useful for accessing SMB shares on other compatible
2017-12-08 23:06:56 +03:00
SMB servers, and can also be used
2012-11-30 14:37:33 +04:00
to allow a UNIX box to print to a printer attached to
2017-12-08 23:06:56 +03:00
any SMB server.</para>
2004-04-07 14:15:11 +04:00
</listitem>
</varlistentry>
2012-11-30 14:37:33 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > samba-tool</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > samba-tool</command>
is the main Samba Administration tool regarding
2013-07-10 01:23:33 +04:00
Active Directory services.</para>
2012-11-30 14:37:33 +04:00
</listitem>
</varlistentry>
2004-04-07 14:15:11 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > testparm</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > testparm</command>
utility is a simple syntax checker for Samba's <citerefentry > <refentrytitle > smb.conf</refentrytitle>
2017-12-08 23:06:56 +03:00
<manvolnum > 5</manvolnum> </citerefentry> configuration file.
In AD server mode <command > samba-tool testparm</command>
should be used though.</para>
2004-04-07 14:15:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbstatus</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > smbstatus</command>
2012-11-30 14:37:33 +04:00
tool provides access to information about the
2004-04-07 14:15:11 +04:00
current connections to <command > smbd</command> .</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > nmblookup</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > nmblookup</command>
2017-12-08 23:06:56 +03:00
tool allows NetBIOS name queries to be made.</para>
2004-04-07 14:15:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbpasswd</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
<listitem > <para > The <command > smbpasswd</command>
2017-12-08 23:06:56 +03:00
command is a tool for setting passwords on local Samba but
also on remote SMB servers.</para>
2004-04-07 14:15:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbcacls</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > The <command > smbcacls</command> command is
2017-12-08 23:06:56 +03:00
a tool to set ACL's on remote SMB servers.</para>
2004-04-07 14:15:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbtree</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > The <command > smbtree</command> command
2004-04-07 14:15:11 +04:00
is a text-based network neighborhood tool.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbtar</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > The <command > smbtar</command> can make
2017-12-08 23:06:56 +03:00
backups of data directly from SMB servers.</para> </listitem>
2004-04-07 14:15:11 +04:00
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbspool</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > <command > smbspool</command> is a
helper utility for printing on printers connected
2017-12-08 23:06:56 +03:00
to SMB servers. </para> </listitem>
2004-04-07 14:15:11 +04:00
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbcontrol</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > <command > smbcontrol</command> is a utility
2012-11-30 14:37:33 +04:00
that can change the behaviour of running
<command > smbd</command> , <command > nmbd</command> and
<command > winbindd</command> daemons.
2004-04-07 14:15:11 +04:00
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > rpcclient</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > <command > rpcclient</command> is a utility
2012-11-30 14:37:33 +04:00
that can be used to execute RPC commands on remote
2017-12-08 23:06:56 +03:00
SMB servers.</para> </listitem>
2004-04-07 14:15:11 +04:00
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > pdbedit</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > The <command > pdbedit</command> command
can be used to maintain the local user database on
2017-12-08 23:06:56 +03:00
a Samba server.</para> </listitem> </varlistentry>
2004-04-07 14:15:11 +04:00
<varlistentry >
<term > <citerefentry > <refentrytitle > findsmb</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > The <command > findsmb</command> command
2004-04-07 14:15:11 +04:00
can be used to find SMB servers on the local network.
</para> </listitem> </varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > net</refentrytitle>
<manvolnum > 8</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > The <command > net</command> command
2017-12-08 23:06:56 +03:00
is the main administration tool for Samba member and
standalone servers.</para> </listitem>
2004-04-07 14:15:11 +04:00
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > wbinfo</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > <command > wbinfo</command> is a utility
2004-04-07 14:15:11 +04:00
that retrieves and stores information related to winbind.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > profiles</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > <command > profiles</command> is a command-line
2011-10-08 22:54:37 +04:00
utility that can be used to replace all occurrences of
2004-04-07 14:15:11 +04:00
a certain SID with another SID.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > log2pcap</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
2012-11-30 14:37:33 +04:00
<listitem > <para > <command > log2pcap</command> is a utility
for generating pcap trace files from Samba log
2004-04-07 14:15:11 +04:00
files.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > vfstest</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > <command > vfstest</command> is a utility
that can be used to test vfs modules.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > ntlm_auth</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
<listitem > <para > <command > ntlm_auth</command> is a helper-utility
for external programs wanting to do NTLM-authentication.
</para> </listitem> </varlistentry>
<varlistentry >
<term > <citerefentry > <refentrytitle > smbcquotas</refentrytitle>
<manvolnum > 1</manvolnum> </citerefentry> </term>
2017-12-08 23:06:56 +03:00
<listitem > <para > <command > smbcquotas</command> is a tool to
manage quotas on remote SMB servers. </para>
2004-04-07 14:15:11 +04:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > COMPONENTS</title>
2012-11-30 14:37:33 +04:00
<para > The Samba suite is made up of several components. Each
component is described in a separate manual page. It is strongly
recommended that you read the documentation that comes with Samba
and the manual pages of those components that you use. If the
2004-04-07 14:15:11 +04:00
manual pages and documents aren't clear enough then please visit
2017-12-08 23:06:56 +03:00
<ulink url= "https://devel.samba.org/" > https://devel.samba.org</ulink>
2004-04-07 14:15:11 +04:00
for information on how to file a bug report or submit a patch.</para>
<para > If you require help, visit the Samba webpage at
2017-12-08 23:06:56 +03:00
<ulink url= "https://www.samba.org/" > https://www.samba.org/</ulink> and
2004-04-07 14:15:11 +04:00
explore the many option available to you.
</para>
</refsect1>
<refsect1 >
<title > AVAILABILITY</title>
2012-11-30 14:37:33 +04:00
<para > The Samba software suite is licensed under the
GNU Public License(GPL). A copy of that license should
have come with the package in the file COPYING. You are
encouraged to distribute copies of the Samba suite, but
2004-04-07 14:15:11 +04:00
please obey the terms of this license.</para>
2012-11-30 14:37:33 +04:00
<para > The latest version of the Samba suite can be
2017-12-08 23:06:56 +03:00
obtained from <ulink url= "https://download.samba.org/pub/samba/" >
https://download.samba.org/pub/samba/</ulink> .
</para>
<para > The Samba Wiki at
<ulink url= "https://wiki.samba.org/" > https://wiki.samba.org</ulink>
has also a lot of useful information.
On the Samba mailing list at
<ulink url= "https://lists.samba.org/" > https://lists.samba.org</ulink>
you can find a lot of information in the archives and you can
subscribe to the samba list and ask for help or discuss things.
</para>
2004-04-07 14:15:11 +04:00
</refsect1>
<refsect1 >
<title > VERSION</title>
2012-11-30 14:37:33 +04:00
2017-12-13 03:38:25 +03:00
<para > This man page is part of version &doc.version; of the
2004-04-07 14:15:11 +04:00
Samba suite. </para>
</refsect1>
<refsect1 >
<title > CONTRIBUTIONS</title>
2012-11-30 14:37:33 +04:00
<para > If you wish to contribute to the Samba project,
then I suggest you join the Samba mailing list at
2017-12-08 23:06:56 +03:00
<ulink url= "https://lists.samba.org/" > https://lists.samba.org</ulink> .
2004-04-07 14:15:11 +04:00
</para>
<para > If you have patches to submit, visit
2017-12-08 23:06:56 +03:00
<ulink url= "https://devel.samba.org/" > https://devel.samba.org/</ulink>
2012-11-30 14:37:33 +04:00
for information on how to do it properly. We prefer patches
in <command > git format-patch</command> format.</para>
2004-04-07 14:15:11 +04:00
</refsect1>
<refsect1 >
<title > CONTRIBUTORS</title>
2012-11-30 14:37:33 +04:00
<para > Contributors to the project are now too numerous
to mention here but all deserve the thanks of all Samba
2004-04-07 14:15:11 +04:00
users. To see a full list, look at the
2012-11-30 14:37:33 +04:00
<filename > change-log</filename> in the source package
for the pre-CVS changes and at <ulink
2017-12-08 23:06:56 +03:00
url="https://git.samba.org/">
https://git.samba.org/</ulink>
2012-11-30 14:37:33 +04:00
for the contributors to Samba post-GIT. GIT is the Open Source
source code control system used by the Samba Team to develop
2004-04-07 14:15:11 +04:00
Samba. The project would have been unmanageable without it.</para>
</refsect1>
<refsect1 >
<title > AUTHOR</title>
2012-11-30 14:37:33 +04:00
<para > The original Samba software and related utilities
2004-04-07 14:15:11 +04:00
were created by Andrew Tridgell. Samba is now developed
2012-11-30 14:37:33 +04:00
by the Samba Team as an Open Source project similar
2004-04-07 14:15:11 +04:00
to the way the Linux kernel is developed.</para>
</refsect1>
</refentry>