Changeset 286 for branches/samba-3.0/docs/manpages/smbtree.1

Timestamp:

Jun 24, 2009, 5:09:21 PM (16 years ago)

Author:

Herwig Bauernfeind

Message:

Update 3.0 to 3.0.35

File:

• branches/samba-3.0/docs/manpages/smbtree.1 (modified) (3 diffs)

branches/samba-3.0/docs/manpages/smbtree.1

@@ -1 +1 @@
 .\"     Title: smbtree
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 08/25/2008
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 06/22/2009
 .\"    Manual: User Commands
 .\"    Source: Samba 3.0
+.\"  Language: English
 .\"
-.TH "SMBTREE" "1" "08/25/2008" "Samba 3\.0" "User Commands"
+.TH "SMBTREE" "1" "06/22/2009" "Samba 3\&.0" "User Commands"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
-.SH "NAME"
-smbtree - A text based smb network browser
-.SH "SYNOPSIS"
-.HP 1
-smbtree [\-b] [\-D] [\-S]
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+smbtree \- A text based smb network browser
+.SH "Synopsis"
+.fam C
+.HP \w'\ 'u
+\FCsmbtree\F[] [\-b] [\-D] [\-S]
+.fam
 .SH "DESCRIPTION"
 .PP
 This tool is part of the
 \fBsamba\fR(7)
-suite\.
-.PP
-smbtree
-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\.
+suite\&.
+.PP
+\FCsmbtree\F[]
+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"
 .PP
 \-b
 .RS 4
-Query network nodes by sending requests as broadcasts instead of querying the local master browser\.
+Query network nodes by sending requests as broadcasts instead of querying the local master browser\&.
 .RE
 .PP
@@ -38 +196 @@
 \-S
 .RS 4
-Only print a list of all the domains and servers responding on broadcast or known by the master browser\.
+Only print a list of all the domains and servers responding on broadcast or known by the master browser\&.
 .RE
 .PP
@@ -44 +202 @@
 .RS 4
 \fIlevel\fR
-is an integer from 0 to 10\. The default value if this parameter is not specified is 0\.
-.sp
-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\.
-.sp
-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\.
+is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
+.sp
+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\&.
+.sp
+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\&.
 .sp
 Note that specifying this parameter here will override the
-\fIlog level\fR
+\m[blue]\fBlog level\fR\m[]
 parameter in the
-\fIsmb\.conf\fR
-file\.
+\FCsmb\&.conf\F[]
+file\&.
 .RE
 .PP
 \-V
 .RS 4
-Prints the program version number\.
+Prints the program version number\&.
 .RE
 .PP
 \-s <configuration file>
 .RS 4
-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\fR
-for more information\. The default configuration file name is determined at compile time\.
+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
+\FCsmb\&.conf\F[]
+for more information\&. The default configuration file name is determined at compile time\&.
 .RE
 .PP
 \-l|\-\-log\-basename=logdirectory
 .RS 4
-Base directory name for log/debug files\. The extension
-\fB"\.progname"\fR
-will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\.
+Base directory name for log/debug files\&. The extension
+\fB"\&.progname"\fR
+will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
 .RE
 .PP
 \-N
 .RS 4
-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\.
-.sp
-Unless a password is specified on the command line or this parameter is specified, the client will request a password\.
-.sp
-If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\.
+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\&.
+.sp
+Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
+.sp
+If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\&.
 .RE
 .PP
 \-k
 .RS 4
-Try to authenticate with kerberos\. Only useful in an Active Directory environment\.
+Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
 .RE
 .PP
 \-A|\-\-authentication\-file=filename
 .RS 4
-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
-.sp
-.sp
-.RS 4
+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
+.sp
+.if n \{\
+.RS 4
+.\}
+.fam C
+.ps -1
 .nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
 username = <value>
 password = <value>
 domain   = <value>
-.fi
-.RE
-.sp
-Make certain that the permissions on the file restrict access from unwanted users\.
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
+.if n \{\
+.RE
+.\}
+.sp
+Make certain that the permissions on the file restrict access from unwanted users\&.
 .RE
 .PP
 \-U|\-\-user=username[%password]
 .RS 4
-Sets the SMB username or username and password\.
-.sp
-If %password is not specified, the user will be prompted\. The client will first check the
+Sets the SMB username or username and password\&.
+.sp
+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
+variable and if either exists, the string is uppercased\&. If these environmental variables are not found, the username
 \fBGUEST\fR
-is used\.
-.sp
-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
+is used\&.
+.sp
+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\.
-.sp
-Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the
-ps
-command\. To be safe always allow
-rpcclient
-to prompt for a password and type it in directly\.
+for more details\&.
+.sp
+Be cautious about including passwords in scripts\&. Also, on many systems the command line of a running process may be seen via the
+\FCps\F[]
+command\&. To be safe always allow
+\FCrpcclient\F[]
+to prompt for a password and type it in directly\&.
 .RE
 .PP
 \-h|\-\-help
 .RS 4
-Print a summary of command line options\.
+Print a summary of command line options\&.
 .RE
 .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\.
-.PP
-The smbtree man page was written by Jelmer Vernooij\.
+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\&.