ctdb: setup $CTDB_BASE for deterministic ip alloc tests
[Samba.git] / docs-xml / manpages / smbtree.1.xml
blobb1ba700292bc71b1a3f176519c1970f2b0e9ec1f
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="smbtree.1">
5 <refmeta>
6         <refentrytitle>smbtree</refentrytitle>
7         <manvolnum>1</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">User Commands</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>smbtree</refname>
16         <refpurpose>A text based smb network browser
17         </refpurpose>
18 </refnamediv>
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>smbtree</command>
23                 <arg choice="opt">-D|--domains</arg>
24                 <arg choice="opt">-S|--servers</arg>
25                 <arg choice="opt">-?|--help</arg>
26                 <arg choice="opt">--usage</arg>
27                 <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
28                 <arg choice="opt">--debug-stdout</arg>
29                 <arg choice="opt">--configfile=CONFIGFILE</arg>
30                 <arg choice="opt">--option=name=value</arg>
31                 <arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
32                 <arg choice="opt">--leak-report</arg>
33                 <arg choice="opt">--leak-report-full</arg>
34                 <arg choice="opt">-U|--user=[DOMAIN/]USERNAME[%PASSWORD]</arg>
35                 <arg choice="opt">-N|--no-pass</arg>
36                 <arg choice="opt">--password=STRING</arg>
37                 <arg choice="opt">--pw-nt-hash</arg>
38                 <arg choice="opt">-A|--authentication-file=FILE</arg>
39                 <arg choice="opt">-P|--machine-pass</arg>
40                 <arg choice="opt">--simple-bind-dn=DN</arg>
41                 <arg choice="opt">--use-kerberos=desired|required|off</arg>
42                 <arg choice="opt">--use-krb5-ccache=CCACHE</arg>
43                 <arg choice="opt">--use-winbind-ccache</arg>
44                 <arg choice="opt">--client-protection=sign|encrypt|off</arg>
45                 <arg choice="opt">-V|--version</arg>
46         </cmdsynopsis>
47 </refsynopsisdiv>
49 <refsect1>
50         <title>DESCRIPTION</title>
52         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
53         <manvolnum>7</manvolnum></citerefentry> suite.</para>
55         <para><command>smbtree</command> is a smb browser program 
56         in text mode. It is similar to the "Network Neighborhood" found 
57         on Windows computers. It prints a tree with all 
58         the known domains, the servers in those domains and 
59         the shares on the servers.
60         </para>
61 </refsect1>
64 <refsect1>
65         <title>OPTIONS</title>
67         <variablelist>
68                 <varlistentry>
69                 <term>-D|--domains</term>
70                 <listitem><para>Only print a list of all 
71                 the domains known on broadcast or by the 
72                 master browser</para></listitem>
73                 </varlistentry>
75                 <varlistentry>
76                 <term>-S|--servers</term>
77                 <listitem><para>Only print a list of 
78                 all the domains and servers responding on broadcast or 
79                 known by the master browser. 
80                 </para></listitem>
81                 </varlistentry>
83                 &popt.autohelp;
84                 &cmdline.common.samba.client;
85                 &cmdline.common.credentials;
86         </variablelist>
87 </refsect1>
89 <refsect1>
90         <title>VERSION</title>
92         <para>This man page is part of version &doc.version; of the Samba
93         suite.</para>
94 </refsect1>
96 <refsect1>
97         <title>AUTHOR</title>
98         
99         <para>The original Samba software and related utilities 
100         were created by Andrew Tridgell. Samba is now developed
101         by the Samba Team as an Open Source project similar 
102         to the way the Linux kernel is developed.</para>
103         
104         <para>The smbtree man page was written by Jelmer Vernooij. </para>
105 </refsect1>
107 </refentry>