source: trunk/samba/docs/manpages/smbtree.1 @ 26

Last change on this file since 26 was 26, checked in by Paul Smedley, 14 years ago

Updated source to 3.0.25rc1

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