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
  25 .nf
  26 \fBsmbtree\fR [-b] [-D] [-S]
  27 .fi
  28
  29 .SH "DESCRIPTION"
  30
  31 .PP
  32 This tool is part of the \fBSamba\fR(7) suite\&.
  33
  34 .PP
  35 \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\&.
  36
  37 .SH "OPTIONS"
  38
  39 .TP
  40 -b
  41 Query network nodes by sending requests as broadcasts instead of querying the (domain) master browser\&.
  42
  43
  44 .TP
  45 -D
  46 Only print a list of all the domains known on broadcast or by the master browser
  47
  48
  49 .TP
  50 -S
  51 Only print a list of all the domains and servers responding on broadcast or known by the master browser\&.
  52
  53
  54 .TP
  55 -V
  56 Prints the version number for \fBsmbd\fR\&.
  57
  58
  59 .TP
  60 -s <configuration file>
  61 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\&.
  62
  63
  64 .TP
  65 -d|--debug=debuglevel
  66 \fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
  67
  68
  69 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\&.
  70
  71
  72 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\&.
  73
  74
  75 Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
  76
  77
  78 .TP
  79 -l|--logfile=logbasename
  80 File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
  81
  82
  83 .TP
  84 -N
  85 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\&.
  86
  87
  88 Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
  89
  90
  91 .TP
  92 -k
  93 Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
  94
  95
  96 .TP
  97 -A|--authfile=filename
  98 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
  99
 100
 101 .nf
 102
 103 username = <value>
 104 password = <value>
 105 domain   = <value>
 106 .fi
 107
 108
 109 Make certain that the permissions on the file restrict access from unwanted users\&.
 110
 111
 112 .TP
 113 -U|--user=username[%password]
 114 Sets the SMB username or username and password\&.
 115
 116
 117 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\&.
 118
 119
 120 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\&.
 121
 122
 123 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\&.
 124
 125
 126 .TP
 127 -h|--help
 128 Print a summary of command line options\&.
 129
 130
 131 .SH "VERSION"
 132
 133 .PP
 134 This man page is correct for version 3\&.0 of the Samba suite\&.
 135
 136 .SH "AUTHOR"
 137
 138 .PP
 139 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\&.
 140
 141 .PP
 142 The smbtree man page was written by Jelmer Vernooij\&.
 143