diff options
Diffstat (limited to 'docs/manpages')
28 files changed, 587 insertions, 23 deletions
diff --git a/docs/manpages/editreg.1 b/docs/manpages/editreg.1 new file mode 100644 index 0000000000..b9b5b673f3 --- /dev/null +++ b/docs/manpages/editreg.1 @@ -0,0 +1,45 @@ +.\" 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 "EDITREG" "1" "17 April 2003" "" "" + +.SH NAME +editreg \- A utility to report and change SIDs in registry files +.SH SYNOPSIS + +\fBeditreg\fR [ \fB-v\fR ] [ \fB-c file\fR ] \fBfile\fR + +.SH "DESCRIPTION" +.PP +This tool is part of the \fBSamba\fR(7) suite. +.PP +\fBeditreg\fR is a utility that +can visualize windows registry files (currently only NT4) and apply +so-called commandfiles to them. +.SH "OPTIONS" +.TP +\fBregistry_file\fR +Registry file to view or edit. +.TP +\fB-v,--verbose\fR +Increases verbosity of messages. +.TP +\fB-c commandfile\fR +Read commands to execute on \fIregistry_file\fR from \fIcommandfile\fR. Currently not yet supported! +.TP +\fB-h|--help\fR +Print a summary of command line options. +.SH "VERSION" +.PP +This man page is correct for version 3.0 of the Samba +suite. +.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 editreg man page was written by Jelmer Vernooij. diff --git a/docs/manpages/manpage.links b/docs/manpages/manpage.links new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/manpages/manpage.links diff --git a/docs/manpages/manpage.refs b/docs/manpages/manpage.refs new file mode 100644 index 0000000000..81323bebe1 --- /dev/null +++ b/docs/manpages/manpage.refs @@ -0,0 +1,39 @@ +{ + '' => '', + 'refentry:SMBGROUPEDIT.8' => 'smbgroupedit(8)', + 'refentry:NET.8' => 'net(8)', + 'refentry:SAMBA.7' => 'samba(7)', + 'refentry:SMBSTATUS.1' => 'smbstatus(1)', + 'refentry:SMBCACLS.1' => 'smbcacls(1)', + 'refentry:WBINFO.1' => 'wbinfo(1)', + 'refentry:NTLM-AUTH.1' => 'ntlm_auth(1)', + 'refentry:SMBPASSWD.8' => 'smbpasswd(8)', + 'refentry:SMB.CONF.5' => 'smb.conf(5)', + 'refentry:FINDSMB.1' => 'findsmb(1)', + 'refentry:SMBCONTROL.1' => 'smbcontrol(1)', + 'refentry:TESTPRNS.1' => 'testprns(1)', + 'refentry:SMBPASSWD.5' => 'smbpasswd(5)', + 'refentry:SMBD.8' => 'smbd(8)', + 'refentry:SMBTREE.1' => 'smbtree(1)', + 'refentry:EDITREG.1' => 'editreg(1)', + 'refentry:SMBCLIENT.1' => 'smbclient(1)', + 'refentry:WINBINDD.8' => 'winbindd(8)', + 'refentry:NMBLOOKUP' => 'nmblookup(1)', + 'refentry:SMBMOUNT.8' => 'smbmount(8)', + 'refentry:SMBCQUOTAS.1' => 'smbcquotas(1)', + 'refentry:PDBEDIT.8' => 'pdbedit(8)', + 'refentry:NTLM_AUTH.1' => 'ntlm_auth(1)', + 'refentry:SWAT.8' => 'swat(8)', + 'refentry:PROFILES.1' => 'profiles(1)', + 'refentry:LMHOSTS.5' => 'lmhosts(5)', + 'refentry:SMBMNT.8' => 'smbmnt(8)', + 'refentry:SMBSH.1' => 'smbsh(1)', + 'refentry:SMBSPOOL.8' => 'smbspool(8)', + 'refentry:RPCCLIENT.1' => 'rpcclient(1)', + 'refentry:VFSTEST.1' => 'vfstest(1)', + 'refentry:NMBD.8' => 'nmbd(8)', + 'refentry:TESTPARM.1' => 'testparm(1)', + 'refentry:SMBUMOUNT.8' => 'smbumount(8)', + 'refentry:SMBTAR.1' => 'smbtar(1)', + '' => '' +} diff --git a/docs/manpages/ntlm_auth.1 b/docs/manpages/ntlm_auth.1 new file mode 100644 index 0000000000..bb562fe964 --- /dev/null +++ b/docs/manpages/ntlm_auth.1 @@ -0,0 +1,109 @@ +.\" 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 "NTLM_AUTH" "1" "17 April 2003" "" "" + +.SH NAME +ntlm_auth \- tool to allow external access to Winbind's NTLM authentication function +.SH SYNOPSIS + +\fBntlm_auth\fR [ \fB-d debuglevel\fR ] [ \fB-l logfile\fR ] [ \fB-s <smb config file>\fR ] + +.SH "DESCRIPTION" +.PP +This tool is part of the \fBSamba\fR(7) suite. +.PP +\fBntlm_auth\fR is a helper utility that authenticates +users using NT/LM authentication. It returns 0 if the users is authenticated +successfully and 1 if access was denied. ntlm_auth uses winbind to access +the user and authentication data for a domain. This utility +is only to be used by other programs (currently squid). +.SH "OPTIONS" +.TP +\fB--helper-protocol=PROTO\fR +Operate as a stdio-based helper +.TP +\fB--username=USERNAME\fR +Specify username of user to authenticate +.TP +\fB--domain=DOMAIN\fR +Specify domain of user to authenticate +.TP +\fB--workstation=WORKSTATION\fR +Specify the workstation the user authenticated from +.TP +\fB--challenge=STRING\fR +challenge (HEX encoded) +.TP +\fB--lm-response=RESPONSE\fR +LM Response to the challenge (HEX encoded) +.TP +\fB--nt-response=RESPONSE\fR +NT or NTLMv2 Response to the challenge (HEX encoded) +.TP +\fB--password=PASSWORD\fR +User's plaintext password +.TP +\fB--request-lm-key\fR +Retreive LM session key +.TP +\fB--request-nt-key\fR +Request NT key +.TP +\fB-V\fR +Prints the version number for +\fBsmbd\fR. +.TP +\fB-s <configuration file>\fR +The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See \fIsmb.conf(5)\fR for more information. +The default configuration file name is determined at +compile time. +.TP +\fB-d|--debug=debuglevel\fR +\fIdebuglevel\fR is an integer +from 0 to 10. The default value if this parameter is +not specified is zero. + +The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out. + +Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic. + +Note that specifying this parameter here will +override the log +level file. +.TP +\fB-l|--logfile=logbasename\fR +File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +.TP +\fB-h|--help\fR +Print a summary of command line options. +.SH "VERSION" +.PP +This man page is correct for version 3.0 of the Samba +suite. +.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 ntlm_auth manpage was written by Jelmer Vernooij. diff --git a/docs/manpages/profiles.1 b/docs/manpages/profiles.1 new file mode 100644 index 0000000000..6ce5478e49 --- /dev/null +++ b/docs/manpages/profiles.1 @@ -0,0 +1,45 @@ +.\" 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 "PROFILES" "1" "17 April 2003" "" "" + +.SH NAME +profiles \- A utility to report and change SIDs in registry files +.SH SYNOPSIS + +\fBprofiles\fR [ \fB-v\fR ] [ \fB-c SID\fR ] [ \fB-n SID\fR ] \fBfile\fR + +.SH "DESCRIPTION" +.PP +This tool is part of the \fBSamba\fR(7) suite. +.PP +\fBprofiles\fR is a utility that +reports and changes SIDs in windows registry files. It currently only +supports NT. +.SH "OPTIONS" +.TP +\fBfile\fR +Registry file to view or edit. +.TP +\fB-v,--verbose\fR +Increases verbosity of messages. +.TP +\fB-c SID1 -n SID2\fR +Change all occurences of SID1 in \fIfile\fR by SID2. +.TP +\fB-h|--help\fR +Print a summary of command line options. +.SH "VERSION" +.PP +This man page is correct for version 3.0 of the Samba +suite. +.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 profiles man page was written by Jelmer Vernooij. diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5 index 70e1731220..64c5547dc5 100644 --- a/docs/manpages/smb.conf.5 +++ b/docs/manpages/smb.conf.5 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMB.CONF" "5" "07 april 2003" "" "" +.TH "SMB.CONF" "5" "17 April 2003" "" "" .SH NAME smb.conf \- The configuration file for the Samba suite @@ -2591,8 +2591,7 @@ This boolean controls whether encrypted passwords will be negotiated with the client. Note that Windows NT 4.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed. To use encrypted passwords in -Samba see the file ENCRYPTION.txt in the Samba documentation -directory \fIdocs/\fR shipped with the source code. +Samba see the chapter User Database in the Samba HOWTO Collection. In order for encrypted passwords to work correctly \fBsmbd\fR(8) must either diff --git a/docs/manpages/smbcacls.1 b/docs/manpages/smbcacls.1 index b82871cd7f..48cac295cc 100644 --- a/docs/manpages/smbcacls.1 +++ b/docs/manpages/smbcacls.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBCACLS" "1" "07 april 2003" "" "" +.TH "SMBCACLS" "1" "17 April 2003" "" "" .SH NAME smbcacls \- Set or get ACLs on an NT file or directory names diff --git a/docs/manpages/smbclient.1 b/docs/manpages/smbclient.1 index 0b6a5a4679..449cd0863e 100644 --- a/docs/manpages/smbclient.1 +++ b/docs/manpages/smbclient.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBCLIENT" "1" "07 april 2003" "" "" +.TH "SMBCLIENT" "1" "17 April 2003" "" "" .SH NAME smbclient \- ftp-like client to access SMB/CIFS resources on servers diff --git a/docs/manpages/smbcontrol.1 b/docs/manpages/smbcontrol.1 index 14ce9f5812..eab84a45ba 100644 --- a/docs/manpages/smbcontrol.1 +++ b/docs/manpages/smbcontrol.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBCONTROL" "1" "07 april 2003" "" "" +.TH "SMBCONTROL" "1" "17 April 2003" "" "" .SH NAME smbcontrol \- send messages to smbd, nmbd or winbindd processes diff --git a/docs/manpages/smbcquotas.1 b/docs/manpages/smbcquotas.1 new file mode 100644 index 0000000000..011cb26ef0 --- /dev/null +++ b/docs/manpages/smbcquotas.1 @@ -0,0 +1,183 @@ +.\" 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 "SMBCQUOTAS" "1" "17 April 2003" "" "" + +.SH NAME +smbcquotas \- Set or get QUOTAs of NTFS 5 shares +.SH SYNOPSIS + +\fBsmbcquotas\fR \fB//server/share\fR [ \fB-u user\fR ] [ \fB-L\fR ] [ \fB-F\fR ] [ \fB-S QUOTA_SET_COMMAND\fR ] [ \fB-n\fR ] [ \fB-t\fR ] [ \fB-v\fR ] [ \fB-d debuglevel\fR ] [ \fB-s configfile\fR ] [ \fB-l logfilebase\fR ] [ \fB-V\fR ] [ \fB-U username\fR ] [ \fB-N\fR ] [ \fB-k\fR ] [ \fB-A\fR ] + +.SH "DESCRIPTION" +.PP +This tool is part of the \fBSamba\fR(7) suite. +.PP +The \fBsmbcquotas\fR program manipulates NT Quotas on SMB file shares. +.SH "OPTIONS" +.PP +The following options are available to the \fBsmbcquotas\fR program. +.TP +\fB-u user\fR +Specifies the user of whom the quotas are get or set. +By default the current user's username will be used. +.TP +\fB-L\fR +Lists all quota records of the share. +.TP +\fB-F\fR +Show the share quota status and default limits. +.TP +\fB-S QUOTA_SET_COMMAND\fR +This command set/modify quotas for a user or on the share, +depending on the QUOTA_SET_COMMAND parameter witch is described later +.TP +\fB-n\fR +This option displays all QUOTA information in numeric +format. The default is to convert SIDs to names and QUOTA limits +to a readable string format. +.TP +\fB-t\fR +Don't actually do anything, only validate the correctness of +the arguments. +.TP +\fB-v\fR +Be verbose. +.TP +\fB-h|--help\fR +Print a summary of command line options. +.TP +\fB-V\fR +Prints the version number for +\fBsmbd\fR. +.TP +\fB-s <configuration file>\fR +The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See \fIsmb.conf(5)\fR for more information. +The default configuration file name is determined at +compile time. +.TP +\fB-d|--debug=debuglevel\fR +\fIdebuglevel\fR is an integer +from 0 to 10. The default value if this parameter is +not specified is zero. + +The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out. + +Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic. + +Note that specifying this parameter here will +override the log +level file. +.TP +\fB-l|--logfile=logbasename\fR +File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +.TP +\fB-N\fR +If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. + +Unless a password is specified on the command line or +this parameter is specified, the client will request a +password. +.TP +\fB-k\fR +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +.TP +\fB-A|--authfile=filename\fR +This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is + + +.nf +username = <value> +password = <value> +domain = <value> +.fi + +Make certain that the permissions on the file restrict +access from unwanted users. +.TP +\fB-U|--user=username[%password]\fR +Sets the SMB username or username and password. + +If %password is not specified, the user will be prompted. The +client will first check the \fBUSER\fR environment variable, then the +\fBLOGNAME\fR variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username GUEST is used. + +A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +\fI-A\fR for more details. + +Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the \fBps\fR command. To be safe always allow +\fBrpcclient\fR to prompt for a password and type +it in directly. +.SH "QUOTA_SET_COMAND" +.PP +The format of an ACL is one or more ACL entries separated by +either commas or newlines. An ACL entry is one of the following: +.PP +for user setting quotas for the specified by -u or the current username: +.PP +\fB UQLIM:<username><softlimit><hardlimit> +\fR +.PP +for setting the share quota defaults limits: +.PP +\fB FSQLIM:<softlimit><hardlimit> +\fR +.PP +for changing the share quota settings: +.PP +\fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT +\fR +.SH "EXIT STATUS" +.PP +The \fBsmbcquotas\fR program sets the exit status +depending on the success or otherwise of the operations performed. +The exit status may be one of the following values. +.PP +If the operation succeeded, smbcquotas returns an exit +status of 0. If \fBsmbcquotas\fR couldn't connect to the specified server, +or when there was an error getting or setting the quota(s), an exit status +of 1 is returned. If there was an error parsing any command line +arguments, an exit status of 2 is returned. +.SH "VERSION" +.PP +This man page is correct for version 3.0 of the Samba suite. +.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 +\fBsmbcacls\fR was written by Stefan Metzmacher. diff --git a/docs/manpages/smbd.8 b/docs/manpages/smbd.8 index e5139967e8..855705f861 100644 --- a/docs/manpages/smbd.8 +++ b/docs/manpages/smbd.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBD" "8" "07 april 2003" "" "" +.TH "SMBD" "8" "17 April 2003" "" "" .SH NAME smbd \- server to provide SMB/CIFS services to clients diff --git a/docs/manpages/smbgroupedit.8 b/docs/manpages/smbgroupedit.8 index cb3ce954c9..c866fef9df 100644 --- a/docs/manpages/smbgroupedit.8 +++ b/docs/manpages/smbgroupedit.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBGROUPEDIT" "8" "07 april 2003" "" "" +.TH "SMBGROUPEDIT" "8" "17 April 2003" "" "" .SH NAME smbgroupedit \- Query/set/change UNIX - Windows NT group mapping diff --git a/docs/manpages/smbmnt.8 b/docs/manpages/smbmnt.8 index c81428e3d7..424193da8c 100644 --- a/docs/manpages/smbmnt.8 +++ b/docs/manpages/smbmnt.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBMNT" "8" "07 april 2003" "" "" +.TH "SMBMNT" "8" "17 April 2003" "" "" .SH NAME smbmnt \- helper utility for mounting SMB filesystems diff --git a/docs/manpages/smbmount.8 b/docs/manpages/smbmount.8 index 2f158c3074..306e580834 100644 --- a/docs/manpages/smbmount.8 +++ b/docs/manpages/smbmount.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBMOUNT" "8" "07 april 2003" "" "" +.TH "SMBMOUNT" "8" "17 April 2003" "" "" .SH NAME smbmount \- mount an smbfs filesystem diff --git a/docs/manpages/smbpasswd.5 b/docs/manpages/smbpasswd.5 index 9d1ee8e275..0d061ef1a8 100644 --- a/docs/manpages/smbpasswd.5 +++ b/docs/manpages/smbpasswd.5 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBPASSWD" "5" "07 april 2003" "" "" +.TH "SMBPASSWD" "5" "17 April 2003" "" "" .SH NAME smbpasswd \- The Samba encrypted password file diff --git a/docs/manpages/smbpasswd.8 b/docs/manpages/smbpasswd.8 index 500c3b37da..bb21a4668b 100644 --- a/docs/manpages/smbpasswd.8 +++ b/docs/manpages/smbpasswd.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBPASSWD" "8" "07 april 2003" "" "" +.TH "SMBPASSWD" "8" "17 April 2003" "" "" .SH NAME smbpasswd \- change a user's SMB password diff --git a/docs/manpages/smbsh.1 b/docs/manpages/smbsh.1 index fb7d7e2495..a10f8d709b 100644 --- a/docs/manpages/smbsh.1 +++ b/docs/manpages/smbsh.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBSH" "1" "07 april 2003" "" "" +.TH "SMBSH" "1" "17 April 2003" "" "" .SH NAME smbsh \- Allows access to Windows NT filesystem using UNIX commands diff --git a/docs/manpages/smbspool.8 b/docs/manpages/smbspool.8 index 3932d696be..c5498ce513 100644 --- a/docs/manpages/smbspool.8 +++ b/docs/manpages/smbspool.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBSPOOL" "8" "07 april 2003" "" "" +.TH "SMBSPOOL" "8" "17 April 2003" "" "" .SH NAME smbspool \- send a print file to an SMB printer diff --git a/docs/manpages/smbstatus.1 b/docs/manpages/smbstatus.1 index a27efef629..13bfab4723 100644 --- a/docs/manpages/smbstatus.1 +++ b/docs/manpages/smbstatus.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBSTATUS" "1" "07 april 2003" "" "" +.TH "SMBSTATUS" "1" "17 April 2003" "" "" .SH NAME smbstatus \- report on current Samba connections diff --git a/docs/manpages/smbtar.1 b/docs/manpages/smbtar.1 index e270cc4b5f..a9e274dda3 100644 --- a/docs/manpages/smbtar.1 +++ b/docs/manpages/smbtar.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBTAR" "1" "07 april 2003" "" "" +.TH "SMBTAR" "1" "17 April 2003" "" "" .SH NAME smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives diff --git a/docs/manpages/smbtree.1 b/docs/manpages/smbtree.1 new file mode 100644 index 0000000000..e2f61207d9 --- /dev/null +++ b/docs/manpages/smbtree.1 @@ -0,0 +1,144 @@ +.\" 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 "SMBTREE" "1" "17 April 2003" "" "" + +.SH NAME +smbtree \- A text based smb network browser +.SH SYNOPSIS + +\fBsmbtree\fR [ \fB-b\fR ] [ \fB-D\fR ] [ \fB-S\fR ] + +.SH "DESCRIPTION" +.PP +This tool is part of the \fBSamba\fR(7) suite. +.PP +\fBsmbtree\fR is a smb browser program +in text mode. It is similar to the "Network Neighborhood" found +on Windows computers. It prints a tree with all +the known domains, the servers in those domains and +the shares on the servers. +.SH "OPTIONS" +.TP +\fB-b\fR +Query network nodes by sending requests +as broadcasts instead of querying the (domain) master browser. +.TP +\fB-D\fR +Only print a list of all +the domains known on broadcast or by the +master browser +.TP +\fB-S\fR +Only print a list of +all the domains and servers responding on broadcast or +known by the master browser. +.TP +\fB-V\fR +Prints the version number for +\fBsmbd\fR. +.TP +\fB-s <configuration file>\fR +The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See \fIsmb.conf(5)\fR for more information. +The default configuration file name is determined at +compile time. +.TP +\fB-d|--debug=debuglevel\fR +\fIdebuglevel\fR is an integer +from 0 to 10. The default value if this parameter is +not specified is zero. + +The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out. + +Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic. + +Note that specifying this parameter here will +override the log +level file. +.TP +\fB-l|--logfile=logbasename\fR +File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +.TP +\fB-N\fR +If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. + +Unless a password is specified on the command line or +this parameter is specified, the client will request a +password. +.TP +\fB-k\fR +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +.TP +\fB-A|--authfile=filename\fR +This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is + + +.nf +username = <value> +password = <value> +domain = <value> +.fi + +Make certain that the permissions on the file restrict +access from unwanted users. +.TP +\fB-U|--user=username[%password]\fR +Sets the SMB username or username and password. + +If %password is not specified, the user will be prompted. The +client will first check the \fBUSER\fR environment variable, then the +\fBLOGNAME\fR variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username GUEST is used. + +A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +\fI-A\fR for more details. + +Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the \fBps\fR command. To be safe always allow +\fBrpcclient\fR to prompt for a password and type +it in directly. +.TP +\fB-h|--help\fR +Print a summary of command line options. +.SH "VERSION" +.PP +This man page is correct for version 3.0 of the Samba +suite. +.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 smbtree man page was written by Jelmer Vernooij. diff --git a/docs/manpages/smbumount.8 b/docs/manpages/smbumount.8 index 9e8daa81be..118bb37d52 100644 --- a/docs/manpages/smbumount.8 +++ b/docs/manpages/smbumount.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBUMOUNT" "8" "07 april 2003" "" "" +.TH "SMBUMOUNT" "8" "17 April 2003" "" "" .SH NAME smbumount \- smbfs umount for normal users diff --git a/docs/manpages/swat.8 b/docs/manpages/swat.8 index b773bb8fa2..a1a313c6ea 100644 --- a/docs/manpages/swat.8 +++ b/docs/manpages/swat.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SWAT" "8" "07 april 2003" "" "" +.TH "SWAT" "8" "17 April 2003" "" "" .SH NAME swat \- Samba Web Administration Tool diff --git a/docs/manpages/testparm.1 b/docs/manpages/testparm.1 index 7646fedde7..43412e12e3 100644 --- a/docs/manpages/testparm.1 +++ b/docs/manpages/testparm.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "TESTPARM" "1" "07 april 2003" "" "" +.TH "TESTPARM" "1" "17 April 2003" "" "" .SH NAME testparm \- check an smb.conf configuration file for internal correctness diff --git a/docs/manpages/testprns.1 b/docs/manpages/testprns.1 index dccd997fc5..3d09445608 100644 --- a/docs/manpages/testprns.1 +++ b/docs/manpages/testprns.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "TESTPRNS" "1" "07 april 2003" "" "" +.TH "TESTPRNS" "1" "17 April 2003" "" "" .SH NAME testprns \- check printer name for validity with smbd diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1 index bb378142dd..5fcbd46a10 100644 --- a/docs/manpages/vfstest.1 +++ b/docs/manpages/vfstest.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "VFSTEST" "1" "07 april 2003" "" "" +.TH "VFSTEST" "1" "17 April 2003" "" "" .SH NAME vfstest \- tool for testing samba VFS modules diff --git a/docs/manpages/wbinfo.1 b/docs/manpages/wbinfo.1 index 9e11e47133..a23b08ab65 100644 --- a/docs/manpages/wbinfo.1 +++ b/docs/manpages/wbinfo.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "WBINFO" "1" "07 april 2003" "" "" +.TH "WBINFO" "1" "17 April 2003" "" "" .SH NAME wbinfo \- Query information from winbind daemon diff --git a/docs/manpages/winbindd.8 b/docs/manpages/winbindd.8 index a1e39fa172..7341746cde 100644 --- a/docs/manpages/winbindd.8 +++ b/docs/manpages/winbindd.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "WINBINDD" "8" "07 april 2003" "" "" +.TH "WINBINDD" "8" "17 April 2003" "" "" .SH NAME winbindd \- Name Service Switch daemon for resolving names from NT servers |