docs-xml/manpages/smbtree.1.xml

   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">
   4
   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">4.0</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>smbtree</refname>
  16         <refpurpose>A text based smb network browser
  17         </refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21         <cmdsynopsis>
  22                 <command>smbtree</command>
  23                 <arg choice="opt">-b</arg>
  24                 <arg choice="opt">-D</arg>
  25                 <arg choice="opt">-S</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  33         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  34
  35         <para><command>smbtree</command> is a smb browser program
  36         in text mode. It is similar to the "Network Neighborhood" found
  37         on Windows computers. It prints a tree with all
  38         the known domains, the servers in those domains and
  39         the shares on the servers.
  40         </para>
  41 </refsect1>
  42
  43
  44 <refsect1>
  45         <title>OPTIONS</title>
  46
  47         <variablelist>
  48                 <varlistentry>
  49                 <term>-b|--broadcast</term>
  50                 <listitem><para>Query network nodes by sending requests
  51                 as broadcasts instead of querying the local master browser.
  52                 </para></listitem>
  53                 </varlistentry>
  54
  55                 <varlistentry>
  56                 <term>-D|--domains</term>
  57                 <listitem><para>Only print a list of all
  58                 the domains known on broadcast or by the
  59                 master browser</para></listitem>
  60                 </varlistentry>
  61
  62                 <varlistentry>
  63                 <term>-S|--servers</term>
  64                 <listitem><para>Only print a list of
  65                 all the domains and servers responding on broadcast or
  66                 known by the master browser.
  67                 </para></listitem>
  68                 </varlistentry>
  69
  70                 &stdarg.server.debug;
  71                 &popt.common.samba;
  72                 &popt.common.credentials;
  73                 &popt.autohelp;
  74
  75         </variablelist>
  76 </refsect1>
  77
  78 <refsect1>
  79         <title>VERSION</title>
  80
  81         <para>This man page is correct for version 3 of the Samba
  82         suite.</para>
  83 </refsect1>
  84
  85 <refsect1>
  86         <title>AUTHOR</title>
  87
  88         <para>The original Samba software and related utilities
  89         were created by Andrew Tridgell. Samba is now developed
  90         by the Samba Team as an Open Source project similar
  91         to the way the Linux kernel is developed.</para>
  92
  93         <para>The smbtree man page was written by Jelmer Vernooij. </para>
  94 </refsect1>
  95
  96 </refentry>