From b7f66b43c512932e5265b974012e48d5631767b0 Mon Sep 17 00:00:00 2001 From: Karolin Seeger Date: Fri, 30 Nov 2012 11:37:33 +0100 Subject: docs: Update man 7 samba. Update man 7 samba. Still incomplete, but at least a bit more up to date. Karolin Reviewed-by: Andreas Schneider --- docs-xml/manpages/samba.7.xml | 195 +++++++++++++++++++++++------------------- 1 file changed, 109 insertions(+), 86 deletions(-) (limited to 'docs-xml') diff --git a/docs-xml/manpages/samba.7.xml b/docs-xml/manpages/samba.7.xml index aa7684bfff..9299660d2e 100644 --- a/docs-xml/manpages/samba.7.xml +++ b/docs-xml/manpages/samba.7.xml @@ -13,7 +13,7 @@ samba - A Windows SMB/CIFS fileserver for UNIX + A Windows AD and SMB/CIFS fileserver for UNIX @@ -22,50 +22,79 @@ DESCRIPTION - - 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 + + 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 + services. 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/. Samba also implements the NetBIOS protocol in nmbd. - + + + samba + 8 + The samba daemon provides the + Active Directory services and file and print services to + SMB clients. The configuration file + for this daemon is described in smb.conf + 5. + + + smbd 8 - The smbd 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 + The smbd 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 smb.conf - 5 + 5. - + nmbd 8 The nmbd daemon provides NetBIOS nameservice and browsing - support. The configuration file for this daemon + support. The configuration file for this daemon is described in smb.conf - 5 + 5. + + winbindd + 8 + winbindd is a daemon + that is used for integrating authentication and + the user database into unix. + + smbclient 1 The smbclient - program implements a simple ftp-like client. This + 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 + 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). + + samba-tool + 8 + The samba-tool + is the main Samba Administration tool regarding + Acitive Directory services. + + + testparm 1 @@ -79,7 +108,7 @@ smbstatus 1 The smbstatus - tool provides access to information about the + tool provides access to information about the current connections to smbd. @@ -88,7 +117,7 @@ nmblookup 1 The nmblookup - tools allows NetBIOS name queries to be made + tools allows NetBIOS name queries to be made from a UNIX host. @@ -97,7 +126,7 @@ smbpasswd 8 The smbpasswd - command is a tool for changing LanMan and Windows NT + command is a tool for changing LanMan and Windows NT password hashes on Samba and Windows NT servers. @@ -105,7 +134,7 @@ smbcacls 1 - The smbcacls command is + The smbcacls command is a tool to set ACL's on remote CIFS servers. @@ -113,22 +142,22 @@ smbtree 1 - The smbtree command + The smbtree command is a text-based network neighborhood tool. smbtar 1 - The smbtar can make + The smbtar can make backups of data on CIFS/SMB servers. smbspool 8 - smbspool is a - helper utility for printing on printers connected + smbspool is a + helper utility for printing on printers connected to CIFS servers. @@ -136,7 +165,9 @@ smbcontrol 1 smbcontrol is a utility - that can change the behaviour of running samba daemons. + that can change the behaviour of running + smbd, nmbd and + winbindd daemons. @@ -144,28 +175,28 @@ rpcclient 1 rpcclient is a utility - that can be used to execute RPC commands on remote + that can be used to execute RPC commands on remote CIFS servers. pdbedit 8 - The pdbedit command - can be used to maintain the local user database on + The pdbedit command + can be used to maintain the local user database on a samba server. findsmb 1 - The findsmb command + The findsmb command can be used to find SMB servers on the local network. net 8 - The net command + The net command is supposed to work similar to the DOS/Windows NET.EXE command. @@ -178,18 +209,10 @@ - - winbindd - 8 - winbindd is a daemon - that is used for integrating authentication and - the user database into unix. - - wbinfo 1 - wbinfo is a utility + wbinfo is a utility that retrieves and stores information related to winbind. @@ -206,8 +229,8 @@ log2pcap 1 - log2pcap is a utility - for generating pcap trace files from Samba log + log2pcap is a utility + for generating pcap trace files from Samba log files. @@ -228,7 +251,7 @@ smbcquotas 1 - smbcquotas is a tool that + smbcquotas is a tool that can set remote QUOTA's on server with NTFS 5. @@ -237,11 +260,11 @@ COMPONENTS - - 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 + + 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 for information on how to file a bug report or submit a patch. @@ -254,79 +277,79 @@ AVAILABILITY - - 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 + + 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. - The latest version of the Samba suite can be + 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 + directory pub/samba/. It is also available on several mirror sites worldwide. - - You may also find useful information about Samba + + You may also find useful information about Samba on the newsgroup - comp.protocol.smb and the Samba mailing - list. Details on how to join the mailing list are given in + comp.protocol.smb and the Samba mailing + list. Details on how to join the mailing list are given in the README file that comes with Samba. - + If you have access to a WWW viewer (such as Mozilla - or Konqueror) then you will also find lots of useful information, + or Konqueror) then you will also find lots of useful information, including back issues of the Samba mailing list, at http://lists.samba.org. VERSION - - This man page is correct for version 3 of the + + This man page is correct for version 4 of the Samba suite. CONTRIBUTIONS - - If you wish to contribute to the Samba project, - then I suggest you join the Samba mailing list at + + If you wish to contribute to the Samba project, + then I suggest you join the Samba mailing list at http://lists.samba.org. If you have patches to submit, visit http://devel.samba.org/ - for information on how to do it properly. We prefer patches - in diff -u format. + for information on how to do it properly. We prefer patches + in git format-patch format. CONTRIBUTORS - - Contributors to the project are now too numerous - to mention here but all deserve the thanks of all Samba + + 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 the - change-log in the source package - for the pre-CVS changes and at - http://cvs.samba.org/ - for the contributors to Samba post-CVS. CVS is the Open Source - source code control system used by the Samba Team to develop + change-log in the source package + for the pre-CVS changes and at + http://git.samba.org/ + for the contributors to Samba post-GIT. GIT is the Open Source + source code control system used by the Samba Team to develop Samba. The project would have been unmanageable without it. AUTHOR - - The original Samba software and related utilities + + 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 + by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. - - The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another + + 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/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for + 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. -- cgit