Initial import
[samba] / docs / htmldocs / manpages / smbtree.1.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbtree</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbtree.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbtree &#8212; A text based smb network browser
2         </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">smbtree</code>  [-b] [-D] [-S]</p></div></div><div class="refsect1" lang="en"><a name="id2489049"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><span><strong class="command">smbtree</strong></span> is a smb browser program 
3         in text mode. It is similar to the "Network Neighborhood" found 
4         on Windows computers. It prints a tree with all 
5         the known domains, the servers in those domains and 
6         the shares on the servers.
7         </p></div><div class="refsect1" lang="en"><a name="id2489079"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-b</span></dt><dd><p>Query network nodes by sending requests 
8                 as broadcasts instead of querying the local master browser.
9                 </p></dd><dt><span class="term">-D</span></dt><dd><p>Only print a list of all 
10                 the domains known on broadcast or by the 
11                 master browser</p></dd><dt><span class="term">-S</span></dt><dd><p>Only print a list of 
12                 all the domains and servers responding on broadcast or 
13                 known by the master browser. 
14                 </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
15 </p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
16 configuration details required by the server.  The 
17 information in this file includes server-specific
18 information such as what printcap file to use, as well 
19 as descriptions of all the services that the server is 
20 to provide. See <code class="filename">smb.conf</code> for more information.
21 The default configuration file name is determined at 
22 compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer 
23 from 0 to 10.  The default value if this parameter is 
24 not specified is zero.</p><p>The higher this value, the more detail will be 
25 logged to the log files about the activities of the 
26 server. At level 0, only critical errors and serious 
27 warnings will be logged. Level 1 is a reasonable level for
28 day-to-day running - it generates a small amount of 
29 information about operations carried out.</p><p>Levels above 1 will generate considerable 
30 amounts of log data, and should only be used when 
31 investigating a problem. Levels above 3 are designed for 
32 use only by developers and generate HUGE amounts of log
33 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
34 override the <a class="indexterm" name="id2450706"></a> parameter
35 in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-l|--logfile=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
36 <code class="constant">".progname"</code> will be appended (e.g. log.smbclient, 
37 log.smbd, etc...). The log file is never removed by the client.
38 </p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
39 password prompt from the client to the user. This is useful when
40 accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
41 this parameter is specified, the client will request a
42 password.</p></dd><dt><span class="term">-k</span></dt><dd><p>
43 Try to authenticate with kerberos. Only useful in
44 an Active Directory environment.
45 </p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows
46 you to specify a file from which to read the username and
47 password used in the connection.  The format of the file is
48 </p><pre class="programlisting">
49 username = &lt;value&gt;
50 password = &lt;value&gt;
51 domain   = &lt;value&gt;
52 </pre><p>Make certain that the permissions on the file restrict 
53 access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The
54 client will first check the <code class="envar">USER</code> environment variable, then the
55 <code class="envar">LOGNAME</code> variable and if either exists, the
56 string is uppercased. If these environmental variables are not
57 found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which
58 contains the plaintext of the username and password.  This
59 option is mainly provided for scripts where the admin does not
60 wish to pass the credentials on the command line or via environment
61 variables. If this method is used, make certain that the permissions
62 on the file restrict access from unwanted users.  See the
63 <em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
64 many systems the command line of a running process may be seen
65 via the <span><strong class="command">ps</strong></span> command.  To be safe always allow
66 <span><strong class="command">rpcclient</strong></span> to prompt for a password and type
67 it in directly. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
68 </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2450940"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba 
69         suite.</p></div><div class="refsect1" lang="en"><a name="id2450951"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities 
70         were created by Andrew Tridgell. Samba is now developed
71         by the Samba Team as an Open Source project similar 
72         to the way the Linux kernel is developed.</p><p>The smbtree man page was written by Jelmer Vernooij. </p></div></div></body></html>