get rid of CFLAGS from LDSHFLAGS and WINBIND_NSS_LDSHFLAGS and instead
[Samba.git] / docs / htmldocs / smbtree.1.html
blob6cf24ddf9151647d9e97fe3416c318c665899ee0
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.60.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><div></div></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><tt class="command">smbtree</tt> [-b] [-D] [-S]</p></div></div><div class="refsect1" lang="en"><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><b class="command">smbtree</b> is a smb browser program
3 in text mode. It is similar to the &quot;Network Neighborhood&quot; 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"><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 (domain) 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 version number for
15 <b class="command">smbd</b>.</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 <a href="smb.conf.5.html" target="_top"><tt class="filename">
21 smb.conf(5)</tt></a> for more information.
22 The default configuration file name is determined at
23 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
24 from 0 to 10. The default value if this parameter is
25 not specified is zero.</p><p>The higher this value, the more detail will be
26 logged to the log files about the activities of the
27 server. At level 0, only critical errors and serious
28 warnings will be logged. Level 1 is a reasonable level for
29 day to day running - it generates a small amount of
30 information about operations carried out.</p><p>Levels above 1 will generate considerable
31 amounts of log data, and should only be used when
32 investigating a problem. Levels above 3 are designed for
33 use only by developers and generate HUGE amounts of log
34 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
35 override the <a href="smb.conf.5.html#loglevel" target="_top">log
36 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
37 <tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
38 <tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
39 never removed by the client.
40 </p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
41 password prompt from the client to the user. This is useful when
42 accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
43 this parameter is specified, the client will request a
44 password.</p></dd><dt><span class="term">-k</span></dt><dd><p>
45 Try to authenticate with kerberos. Only useful in
46 an Active Directory environment.
47 </p></dd><dt><span class="term">-A|--authfile=filename</span></dt><dd><p>This option allows
48 you to specify a file from which to read the username and
49 password used in the connection. The format of the file is
50 </p><pre class="programlisting">
51 username = &lt;value&gt;
52 password = &lt;value&gt;
53 domain = &lt;value&gt;
54 </pre><p>Make certain that the permissions on the file restrict
55 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
56 client will first check the <tt class="envar">USER</tt> environment variable, then the
57 <tt class="envar">LOGNAME</tt> variable and if either exists, the
58 string is uppercased. If these environmental variables are not
59 found, the username <tt class="constant">GUEST</tt> is used. </p><p>A third option is to use a credentials file which
60 contains the plaintext of the username and password. This
61 option is mainly provided for scripts where the admin does not
62 wish to pass the credentials on the command line or via environment
63 variables. If this method is used, make certain that the permissions
64 on the file restrict access from unwanted users. See the
65 <i class="parameter"><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
66 many systems the command line of a running process may be seen
67 via the <b class="command">ps</b> command. To be safe always allow
68 <b class="command">rpcclient</b> to prompt for a password and type
69 it in directly. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
70 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba
71 suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
72 were created by Andrew Tridgell. Samba is now developed
73 by the Samba Team as an Open Source project similar
74 to the way the Linux kernel is developed.</p><p>The smbtree man page was written by Jelmer Vernooij. </p></div></div></body></html>