Ignore:
Timestamp:
May 23, 2008, 6:56:41 AM (17 years ago)
Author:
Paul Smedley
Message:

Update source to 3.0.29

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/samba-3.0/docs/manpages/smbtree.1

    r44 r134  
    1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
    2 .de Sh \" Subsection
    3 .br
    4 .if t .Sp
    5 .ne 5
    6 .PP
    7 \fB\\$1\fR
    8 .PP
    9 ..
    10 .de Sp \" Vertical space (when we can't use .PP)
    11 .if t .sp .5v
    12 .if n .sp
    13 ..
    14 .de Ip \" List item
    15 .br
    16 .ie \\n(.$>=3 .ne \\$3
    17 .el .ne 3
    18 .IP "\\$1" \\$2
    19 ..
    20 .TH "SMBTREE" 1 "" "" ""
     1.\"     Title: smbtree
     2.\"    Author:
     3.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
     4.\"      Date: 05/21/2008
     5.\"    Manual: User Commands
     6.\"    Source: Samba 3.0
     7.\"
     8.TH "SMBTREE" "1" "05/21/2008" "Samba 3\.0" "User Commands"
     9.\" disable hyphenation
     10.nh
     11.\" disable justification (adjust text to left margin only)
     12.ad l
    2113.SH "NAME"
    2214smbtree - A text based smb network browser
    2315.SH "SYNOPSIS"
    2416.HP 1
    25 smbtree [-b] [-D] [-S]
     17smbtree [\-b] [\-D] [\-S]
    2618.SH "DESCRIPTION"
    2719.PP
    2820This tool is part of the
    2921\fBsamba\fR(7)
    30 suite.
     22suite\.
    3123.PP
    3224smbtree
    33 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.
     25is 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\.
    3426.SH "OPTIONS"
    3527.PP
    36 -b
    37 .RS 3n
    38 Query network nodes by sending requests as broadcasts instead of querying the local master browser.
     28\-b
     29.RS 4
     30Query network nodes by sending requests as broadcasts instead of querying the local master browser\.
    3931.RE
    4032.PP
    41 -D
    42 .RS 3n
     33\-D
     34.RS 4
    4335Only print a list of all the domains known on broadcast or by the master browser
    4436.RE
    4537.PP
    46 -S
    47 .RS 3n
    48 Only print a list of all the domains and servers responding on broadcast or known by the master browser.
     38\-S
     39.RS 4
     40Only print a list of all the domains and servers responding on broadcast or known by the master browser\.
    4941.RE
    5042.PP
    51 -V
    52 .RS 3n
    53 Prints the program version number.
     43\-d|\-\-debuglevel=level
     44.RS 4
     45\fIlevel\fR
     46is an integer from 0 to 10\. The default value if this parameter is not specified is 0\.
     47.sp
     48The 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\.
     49.sp
     50Levels 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\.
     51.sp
     52Note that specifying this parameter here will override the
     53\fIlog level\fR
     54parameter in the
     55\fIsmb\.conf\fR
     56file\.
    5457.RE
    5558.PP
    56 -s <configuration file>
    57 .RS 3n
    58 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
    59 \fIsmb.conf\fR
    60 for more information. The default configuration file name is determined at compile time.
     59\-V
     60.RS 4
     61Prints the program version number\.
    6162.RE
    6263.PP
    63 -d|--debuglevel=level
    64 .RS 3n
    65 \fIlevel\fR
    66 is an integer from 0 to 10. The default value if this parameter is not specified is zero.
    67 .sp
    68 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.
    69 .sp
    70 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.
    71 .sp
    72 Note that specifying this parameter here will override the
    73 
    74 parameter in the
    75 \fIsmb.conf\fR
    76 file.
     64\-s <configuration file>
     65.RS 4
     66The 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
     67\fIsmb\.conf\fR
     68for more information\. The default configuration file name is determined at compile time\.
    7769.RE
    7870.PP
    79 -l|--logfile=logdirectory
    80 .RS 3n
    81 Base directory name for log/debug files. The extension
    82 \fB".progname"\fR
    83 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.
     71\-l|\-\-log\-basename=logdirectory
     72.RS 4
     73Base directory name for log/debug files\. The extension
     74\fB"\.progname"\fR
     75will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\.
    8476.RE
    8577.PP
    86 -N
    87 .RS 3n
    88 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.
     78\-N
     79.RS 4
     80If 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\.
    8981.sp
    90 Unless a password is specified on the command line or this parameter is specified, the client will request a password.
     82Unless a password is specified on the command line or this parameter is specified, the client will request a password\.
    9183.sp
    92 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.
     84If 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\.
    9385.RE
    9486.PP
    95 -k
    96 .RS 3n
    97 Try to authenticate with kerberos. Only useful in an Active Directory environment.
     87\-k
     88.RS 4
     89Try to authenticate with kerberos\. Only useful in an Active Directory environment\.
    9890.RE
    9991.PP
    100 -A|--authentication-file=filename
    101 .RS 3n
    102 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
     92\-A|\-\-authentication\-file=filename
     93.RS 4
     94This 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
    10395.sp
    104 
    10596.sp
    106 
     97.RS 4
    10798.nf
    108 
    10999username = <value>
    110100password = <value>
    111101domain   = <value>
    112 
    113102.fi
    114 
     103.RE
    115104.sp
    116 Make certain that the permissions on the file restrict access from unwanted users.
     105Make certain that the permissions on the file restrict access from unwanted users\.
    117106.RE
    118107.PP
    119 -U|--user=username[%password]
    120 .RS 3n
    121 Sets the SMB username or username and password.
     108\-U|\-\-user=username[%password]
     109.RS 4
     110Sets the SMB username or username and password\.
    122111.sp
    123 If %password is not specified, the user will be prompted. The client will first check the
     112If %password is not specified, the user will be prompted\. The client will first check the
    124113\fBUSER\fR
    125114environment variable, then the
    126115\fBLOGNAME\fR
    127 variable and if either exists, the string is uppercased. If these environmental variables are not found, the username
     116variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username
    128117\fBGUEST\fR
    129 is used.
     118is used\.
    130119.sp
    131 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
    132 \fI-A\fR
    133 for more details.
     120A 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
     121\fI\-A\fR
     122for more details\.
    134123.sp
    135 Be cautious about including passwords in scripts. Also, on many systems the command line of a running process may be seen via the
     124Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the
    136125ps
    137 command. To be safe always allow
     126command\. To be safe always allow
    138127rpcclient
    139 to prompt for a password and type it in directly.
     128to prompt for a password and type it in directly\.
    140129.RE
    141130.PP
    142 -h|--help
    143 .RS 3n
    144 Print a summary of command line options.
     131\-h|\-\-help
     132.RS 4
     133Print a summary of command line options\.
    145134.RE
    146135.SH "VERSION"
    147136.PP
    148 This man page is correct for version 3.0 of the Samba suite.
     137This man page is correct for version 3\.0 of the Samba suite\.
    149138.SH "AUTHOR"
    150139.PP
    151 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.
     140The 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\.
    152141.PP
    153 The smbtree man page was written by Jelmer Vernooij.
    154 
     142The smbtree man page was written by Jelmer Vernooij\.
Note: See TracChangeset for help on using the changeset viewer.