summaryrefslogtreecommitdiffstats
path: root/docs-xml/manpages/smbtree.1.xml
blob: b1ba700292bc71b1a3f176519c1970f2b0e9ec1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smbtree.1">

<refmeta>
	<refentrytitle>smbtree</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
	<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>smbtree</refname>
	<refpurpose>A text based smb network browser
	</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbtree</command>
		<arg choice="opt">-D|--domains</arg>
		<arg choice="opt">-S|--servers</arg>
		<arg choice="opt">-?|--help</arg>
		<arg choice="opt">--usage</arg>
		<arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
		<arg choice="opt">--debug-stdout</arg>
		<arg choice="opt">--configfile=CONFIGFILE</arg>
		<arg choice="opt">--option=name=value</arg>
		<arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
		<arg choice="opt">--leak-report</arg>
		<arg choice="opt">--leak-report-full</arg>
		<arg choice="opt">-U|--user=[DOMAIN/]USERNAME[%PASSWORD]</arg>
		<arg choice="opt">-N|--no-pass</arg>
		<arg choice="opt">--password=STRING</arg>
		<arg choice="opt">--pw-nt-hash</arg>
		<arg choice="opt">-A|--authentication-file=FILE</arg>
		<arg choice="opt">-P|--machine-pass</arg>
		<arg choice="opt">--simple-bind-dn=DN</arg>
		<arg choice="opt">--use-kerberos=desired|required|off</arg>
		<arg choice="opt">--use-krb5-ccache=CCACHE</arg>
		<arg choice="opt">--use-winbind-ccache</arg>
		<arg choice="opt">--client-protection=sign|encrypt|off</arg>
		<arg choice="opt">-V|--version</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para><command>smbtree</command> is 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.
	</para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-D|--domains</term>
		<listitem><para>Only print a list of all 
		the domains known on broadcast or by the 
		master browser</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-S|--servers</term>
		<listitem><para>Only print a list of 
		all the domains and servers responding on broadcast or 
		known by the master browser. 
		</para></listitem>
		</varlistentry>

		&popt.autohelp;
		&cmdline.common.samba.client;
		&cmdline.common.credentials;
	</variablelist>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is part of version &doc.version; of the Samba
	suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>The 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.</para>
	
	<para>The smbtree man page was written by Jelmer Vernooij. </para>
</refsect1>

</refentry>