release/src-rt-6.x.4708/router/samba-3.0.25b/docs/manpages/smbtree.1

   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 "" "" ""
  21 .SH "NAME"
  22 smbtree - A text based smb network browser
  23 .SH "SYNOPSIS"
  24 .HP 1
  25 smbtree [-b] [-D] [-S]
  26 .SH "DESCRIPTION"
  27 .PP
  28 This tool is part of the
  29 \fBsamba\fR(7)
  30 suite.
  31 .PP
  32 smbtree
  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.
  34 .SH "OPTIONS"
  35 .PP
  36 -b
  37 .RS 3n
  38 Query network nodes by sending requests as broadcasts instead of querying the local master browser.
  39 .RE
  40 .PP
  41 -D
  42 .RS 3n
  43 Only print a list of all the domains known on broadcast or by the master browser
  44 .RE
  45 .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.
  49 .RE
  50 .PP
  51 -V
  52 .RS 3n
  53 Prints the program version number.
  54 .RE
  55 .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.
  61 .RE
  62 .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.
  77 .RE
  78 .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.
  84 .RE
  85 .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.
  89 .sp
  90 Unless a password is specified on the command line or this parameter is specified, the client will request a password.
  91 .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.
  93 .RE
  94 .PP
  95 -k
  96 .RS 3n
  97 Try to authenticate with kerberos. Only useful in an Active Directory environment.
  98 .RE
  99 .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
 103 .sp
 104
 105 .sp
 106
 107 .nf
 108
 109 username = <value>
 110 password = <value>
 111 domain   = <value>
 112
 113 .fi
 114
 115 .sp
 116 Make certain that the permissions on the file restrict access from unwanted users.
 117 .RE
 118 .PP
 119 -U|--user=username[%password]
 120 .RS 3n
 121 Sets the SMB username or username and password.
 122 .sp
 123 If %password is not specified, the user will be prompted. The client will first check the
 124 \fBUSER\fR
 125 environment variable, then the
 126 \fBLOGNAME\fR
 127 variable and if either exists, the string is uppercased. If these environmental variables are not found, the username
 128 \fBGUEST\fR
 129 is used.
 130 .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.
 134 .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
 136 ps
 137 command. To be safe always allow
 138 rpcclient
 139 to prompt for a password and type it in directly.
 140 .RE
 141 .PP
 142 -h|--help
 143 .RS 3n
 144 Print a summary of command line options.
 145 .RE
 146 .SH "VERSION"
 147 .PP
 148 This man page is correct for version 3.0 of the Samba suite.
 149 .SH "AUTHOR"
 150 .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.
 152 .PP
 153 The smbtree man page was written by Jelmer Vernooij.
 154