path: root/docs/manpages/samba.7

.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "SAMBA" "7" "17 April 2003" "" ""

.SH NAME
Samba \- A Windows SMB/CIFS fileserver for UNIX
.SH SYNOPSIS

\fBSamba\fR

.SH "DESCRIPTION"
.PP
The Samba software suite is a collection of programs 
that implements the Server Message Block (commonly abbreviated 
as SMB) protocol for UNIX systems. This protocol is sometimes 
also referred to as the Common Internet File System (CIFS). For a
more thorough description, see  http://www.ubiqx.org/cifs/ <URL:http://www.ubiqx.org/cifs/>. Samba also implements the NetBIOS
protocol in nmbd.
.TP
\fBsmbd(8)\fR
The \fBsmbd\fR daemon provides the file and print services to 
SMB clients, such as Windows 95/98, Windows NT, Windows 
for Workgroups or LanManager. The configuration file 
for this daemon is described in \fBsmb.conf\fR(5)
.TP
\fBnmbd(8)\fR
The \fBnmbd\fR
daemon provides NetBIOS nameservice and browsing
support. The configuration file for this daemon 
is described in \fBsmb.conf\fR(5)
.TP
\fBsmbclient(1)\fR
The \fBsmbclient\fR
program implements a simple ftp-like client. This 
is useful for accessing SMB shares on other compatible
servers (such as Windows NT), and can also be used 
to allow a UNIX box to print to a printer attached to 
any SMB server (such as a PC running Windows NT).
.TP
\fBtestparm(1)\fR
The \fBtestparm\fR
utility is a simple syntax checker for Samba's \fBsmb.conf\fR(5) configuration file.
.TP
\fBtestprns(1)\fR
The \fBtestprns\fR
utility supports testing printer names defined 
in your \fIprintcap\fR file used 
by Samba.
.TP
\fBsmbstatus(1)\fR
The \fBsmbstatus\fR
tool provides access to information about the 
current connections to \fBsmbd\fR.
.TP
\fBnmblookup(1)\fR
The \fBnmblookup\fR
tools allows NetBIOS name queries to be made 
from a UNIX host.
.TP
\fBsmbgroupedit(8)\fR
The \fBsmbgroupedit\fR
tool allows for mapping unix groups to NT Builtin,
Domain, or Local groups. Also it allows setting
priviledges for that group, such as saAddUser, etc.
.TP
\fBsmbpasswd(8)\fR
The \fBsmbpasswd\fR
command is a tool for changing LanMan and Windows NT 
password hashes on Samba and Windows NT servers.
.TP
\fBsmbcacls(1)\fR
The \fBsmbcacls\fR command is 
a tool to set ACL's on remote CIFS servers. 
.TP
\fBsmbsh(1)\fR
The \fBsmbsh\fR command is 
a program that allows you to run a unix shell with 
with an overloaded VFS.
.TP
\fBsmbtree(1)\fR
The \fBsmbtree\fR command 
is a text-based network neighborhood tool.
.TP
\fBsmbtar(1)\fR
The \fBsmbtar\fR can make 
backups of data on CIFS/SMB servers.
.TP
\fBsmbspool(8)\fR
\fBsmbspool\fR is a 
helper utility for printing on printers connected 
to CIFS servers. 
.TP
\fBsmbcontrol(1)\fR
\fBsmbcontrol\fR is a utility
that can change the behaviour of running samba daemons.
.TP
\fBrpcclient(1)\fR
\fBrpcclient\fR is a utility
that can be used to execute RPC commands on remote 
CIFS servers.
.TP
\fBpdbedit(8)\fR
The \fBpdbedit\fR command 
can be used to maintain the local user database on 
a samba server.
.TP
\fBfindsmb(1)\fR
The \fBfindsmb\fR command 
can be used to find SMB servers on the local network.
.TP
\fBnet(8)\fR
The \fBnet\fR command 
is supposed to work similar to the DOS/Windows
NET.EXE command.
.TP
\fBswat(8)\fR
\fBswat\fR is a web-based
interface to configuring \fIsmb.conf\fR.
.TP
\fBwinbindd(8)\fR
\fBwinbindd\fR is a daemon 
that is used for integrating authentication and 
the user database into unix.
.TP
\fBwbinfo(1)\fR
\fBwbinfo\fR is a utility 
that retrieves and stores information related to winbind.
.TP
\fBeditreg(1)\fR
\fBeditreg\fR is a command-line
utility that can edit windows registry files.
.TP
\fBprofiles(1)\fR
\fBprofiles\fR is a command-line
utility that can be used to replace all occurences of 
a certain SID with another SID.
.TP
\fBvfstest(1)\fR
\fBvfstest\fR is a utility
that can be used to test vfs modules.
.TP
\fBntlm_auth(1)\fR
\fBntlm_auth\fR is a helper-utility
for external programs wanting to do NTLM-authentication.
.TP
\fBsmbmount(8), smbumount(8), smbmount(8)\fR
\fBsmbmount\fR,\fBsmbmnt\fR and \fBsmbmnt\fR are commands that can be used to 
mount CIFS/SMB shares on Linux.
.TP
\fBsmbcquotas(1)\fR
\fBsmbcquotas\fR is a tool that 
can set remote QUOTA's on server with NTFS 5. 
.SH "COMPONENTS"
.PP
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 
manual pages and documents aren't clear enough then please visit
http://devel.samba.org <URL:http://devel.samba.org/>
for information on how to file a bug report or submit a patch.
.PP
If you require help, visit the Samba webpage at
http://www.samba.org/ <URL:http://samba.org/> and
explore the many option available to you.
.SH "AVAILABILITY"
.PP
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 
please obey the terms of this license.
.PP
The latest version of the Samba suite can be 
obtained via anonymous ftp from samba.org in the
directory pub/samba/. It is also available on several 
mirror sites worldwide.
.PP
You may also find useful information about Samba 
on the newsgroup  comp.protocol.smb <URL:news:comp.protocols.smb> and the Samba mailing 
list. Details on how to join the mailing list are given in 
the README file that comes with Samba.
.PP
If you have access to a WWW viewer (such as Mozilla
or Konqueror) then you will also find lots of useful information, 
including back issues of the Samba mailing list, at
http://lists.samba.org <URL:http://lists.samba.org/>.
.SH "VERSION"
.PP
This man page is correct for version 3.0 of the 
Samba suite. 
.SH "CONTRIBUTIONS"
.PP
If you wish to contribute to the Samba project, 
then I suggest you join the Samba mailing list at 
http://lists.samba.org <URL:http://lists.samba.org/>.
.PP
If you have patches to submit, visit
http://devel.samba.org/ <URL:http://devel.samba.org/>
for information on how to do it properly. We prefer patches 
in \fBdiff -u\fR format.
.SH "CONTRIBUTORS"
.PP
Contributors to the project are now too numerous 
to mention here but all deserve the thanks of all Samba 
users. To see a full list, look at  ftp://samba.org/pub/samba/alpha/change-log <URL:ftp://samba.org/pub/samba/alpha/change-log>
for the pre-CVS changes and at  ftp://samba.org/pub/samba/alpha/cvs.log <URL:ftp://samba.org/pub/samba/alpha/cvs.log>
for the contributors to Samba post-CVS. CVS is the Open Source 
source code control system used by the Samba Team to develop 
Samba. The project would have been unmanageable without it.
.PP
In addition, several commercial organizations now help 
fund the Samba Team with money and equipment. For details see 
the Samba Web pages at  http://samba.org/samba/samba-thanks.html
.SH "AUTHOR"
.PP
The original Samba software and related utilities 
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar 
to the way the Linux kernel is developed.
.PP
The original Samba man pages were written by Karl Auer. 
The man page sources were converted to YODL format (another 
excellent piece of Open Source software, available at  ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
release by Jeremy Allison.  The conversion to DocBook for 
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML
4.2 for Samba 3.0 was done by Alexander Bokovoy.