source: branches/samba-3.2.x/docs/manpages/smbtree.1@ 205

Last change on this file since 205 was 205, checked in by Herwig Bauernfeind, 16 years ago

Update 3.2 branch to 3.2.5

File size: 5.0 KB
Line 
1.\" Title: smbtree
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
4.\" Date: 11/20/2008
5.\" Manual: User Commands
6.\" Source: Samba 3.2
7.\"
8.TH "SMBTREE" "1" "11/20/2008" "Samba 3\.2" "User Commands"
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14smbtree - A text based smb network browser
15.SH "SYNOPSIS"
16.HP 1
17smbtree [\-b] [\-D] [\-S]
18.SH "DESCRIPTION"
19.PP
20This tool is part of the
21\fBsamba\fR(7)
22suite\.
23.PP
24smbtree
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\.
26.SH "OPTIONS"
27.PP
28\-b
29.RS 4
30Query network nodes by sending requests as broadcasts instead of querying the local master browser\.
31.RE
32.PP
33\-D
34.RS 4
35Only print a list of all the domains known on broadcast or by the master browser
36.RE
37.PP
38\-S
39.RS 4
40Only print a list of all the domains and servers responding on broadcast or known by the master browser\.
41.RE
42.PP
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\.
57.RE
58.PP
59\-V
60.RS 4
61Prints the program version number\.
62.RE
63.PP
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\.
69.RE
70.PP
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\.
76.RE
77.PP
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\.
81.sp
82Unless a password is specified on the command line or this parameter is specified, the client will request a password\.
83.sp
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\.
85.RE
86.PP
87\-k
88.RS 4
89Try to authenticate with kerberos\. Only useful in an Active Directory environment\.
90.RE
91.PP
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
95.sp
96.sp
97.RS 4
98.nf
99username = <value>
100password = <value>
101domain = <value>
102.fi
103.RE
104.sp
105Make certain that the permissions on the file restrict access from unwanted users\.
106.RE
107.PP
108\-U|\-\-user=username[%password]
109.RS 4
110Sets the SMB username or username and password\.
111.sp
112If %password is not specified, the user will be prompted\. The client will first check the
113\fBUSER\fR
114environment variable, then the
115\fBLOGNAME\fR
116variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username
117\fBGUEST\fR
118is used\.
119.sp
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\.
123.sp
124Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the
125ps
126command\. To be safe always allow
127rpcclient
128to prompt for a password and type it in directly\.
129.RE
130.PP
131\-h|\-\-help
132.RS 4
133Print a summary of command line options\.
134.RE
135.SH "VERSION"
136.PP
137This man page is correct for version 3 of the Samba suite\.
138.SH "AUTHOR"
139.PP
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\.
141.PP
142The smbtree man page was written by Jelmer Vernooij\.
Note: See TracBrowser for help on using the repository browser.