Some update and Fixes for typos.
[kai/samba.git] / docs / docbook / manpages / smbtree.1.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
3 ]>
4 <refentry id="smbtree.1">
5
6 <refmeta>
7         <refentrytitle>smbtree</refentrytitle>
8         <manvolnum>1</manvolnum>
9 </refmeta>
10
11
12 <refnamediv>
13         <refname>smbtree</refname>
14         <refpurpose>A text based smb network browser
15         </refpurpose>
16 </refnamediv>
17
18 <refsynopsisdiv>
19         <cmdsynopsis>
20                 <command>smbtree</command>
21                 <arg choice="opt">-b</arg>
22                 <arg choice="opt">-D</arg>
23                 <arg choice="opt">-S</arg>
24         </cmdsynopsis>
25 </refsynopsisdiv>
26
27 <refsect1>
28         <title>DESCRIPTION</title>
29
30         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
31         <manvolnum>7</manvolnum></citerefentry> suite.</para>
32
33         <para><command>smbtree</command> is a smb browser program 
34         in text mode. It is similar to the "Network Neighborhood" found 
35         on Windows computers. It prints a tree with all 
36         the known domains, the servers in those domains and 
37         the shares on the servers.
38         </para>
39 </refsect1>
40
41
42 <refsect1>
43         <title>OPTIONS</title>
44
45         <variablelist>
46                 <varlistentry>
47                 <term>-b</term>
48                 <listitem><para>Query network nodes by sending requests 
49                 as broadcasts instead of querying the (domain) master browser.
50                 </para></listitem>
51                 </varlistentry>
52
53                 <varlistentry>
54                 <term>-D</term>
55                 <listitem><para>Only print a list of all 
56                 the domains known on broadcast or by the 
57                 master browser</para></listitem>
58                 </varlistentry>
59
60                 <varlistentry>
61                 <term>-S</term>
62                 <listitem><para>Only print a list of 
63                 all the domains and servers responding on broadcast or 
64                 known by the master browser. 
65                 </para></listitem>
66                 </varlistentry>
67
68                 &popt.common.samba;
69                 &popt.common.credentials;
70                 &stdarg.help;
71                 
72         </variablelist>
73 </refsect1>
74
75 <refsect1>
76         <title>VERSION</title>
77
78         <para>This man page is correct for version 3.0 of the Samba 
79         suite.</para>
80 </refsect1>
81
82 <refsect1>
83         <title>AUTHOR</title>
84         
85         <para>The original Samba software and related utilities 
86         were created by Andrew Tridgell. Samba is now developed
87         by the Samba Team as an Open Source project similar 
88         to the way the Linux kernel is developed.</para>
89         
90         <para>The smbtree man page was written by Jelmer Vernooij. </para>
91 </refsect1>
92
93 </refentry>