summaryrefslogtreecommitdiff
path: root/docs/manpages/smbtree.1
diff options
context:
space:
mode:
authorAlexander Bokovoy <ab@samba.org>2003-04-30 22:52:23 +0000
committerAlexander Bokovoy <ab@samba.org>2003-04-30 22:52:23 +0000
commit94f33628d8251b614d47b75fd4fd19d1a9965ffa (patch)
tree227349f40958db9cd63c92fd247edef6da2e5434 /docs/manpages/smbtree.1
parent721195f77b49e7c341970ad78834a71641ae9577 (diff)
downloadsamba-94f33628d8251b614d47b75fd4fd19d1a9965ffa.tar.gz
samba-94f33628d8251b614d47b75fd4fd19d1a9965ffa.tar.bz2
samba-94f33628d8251b614d47b75fd4fd19d1a9965ffa.zip
Rebuild docs
(This used to be commit 7cafdf9e9576f7988d72fccbc2fad3fbcd3c67df)
Diffstat (limited to 'docs/manpages/smbtree.1')
-rw-r--r--docs/manpages/smbtree.1221
1 files changed, 110 insertions, 111 deletions
diff --git a/docs/manpages/smbtree.1 b/docs/manpages/smbtree.1
index b4a1870dd8..0cc984c24a 100644
--- a/docs/manpages/smbtree.1
+++ b/docs/manpages/smbtree.1
@@ -1,144 +1,143 @@
-.\" 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" "19 april 2003" "" ""
-
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "SMBTREE" 1 "" "" ""
.SH NAME
smbtree \- A text based smb network browser
-.SH SYNOPSIS
+.SH "SYNOPSIS"
-\fBsmbtree\fR [ \fB-b\fR ] [ \fB-D\fR ] [ \fB-S\fR ]
+.nf
+\fBsmbtree\fR [-b] [-D] [-S]
+.fi
.SH "DESCRIPTION"
+
.PP
-This tool is part of the \fBSamba\fR(7) suite.
+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.
+\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.
+-b
+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
+-D
+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.
+-S
+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.
+-V
+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.
+-s <configuration file>
+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 \fI smb\&.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.
+-d|--debug=debuglevel
+\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 parameter in the \fIsmb\&.conf(5)\fR 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.
+-l|--logfile=logbasename
+File name for log/debug files\&. The extension \fB"\&.client"\fR 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.
+-N
+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.
+-k
+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
+-A|--authfile=filename
+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.
+
+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.
+-U|--user=username[%password]
+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 \fBGUEST\fR 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.
+-h|--help
+Print a summary of command line options\&.
+
+
.SH "VERSION"
+
.PP
-This man page is correct for version 3.0 of the Samba
-suite.
+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.
+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.
+The smbtree man page was written by Jelmer Vernooij\&.
+