syncing docs from 3.0 tree (thanks jelmer).
[Samba.git] / docs / docbook / manpages / findsmb.1.xml
blob8a89b2ce24acc37436cfb9ef021b541df58e9a01
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
3                                   
4 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
5 ]>
6 <refentry id="findsmb.1">
8 <refmeta>
9         <refentrytitle>findsmb</refentrytitle>
10         <manvolnum>1</manvolnum>
11 </refmeta>
14 <refnamediv>
15         <refname>findsmb</refname>
16         <refpurpose>list info about machines that respond to SMB 
17         name queries on a subnet</refpurpose>
18 </refnamediv>
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>findsmb</command>
23                 <arg choice="opt">subnet broadcast address</arg>
24         </cmdsynopsis>
25 </refsynopsisdiv>
27 <refsect1>
28         <title>DESCRIPTION</title>
29         
30         <para>This perl script is part of the <citerefentry>
31         <refentrytitle>Samba</refentrytitle><manvolnum>7</manvolnum></citerefentry>
32         suite.</para>
34         <para><command>findsmb</command> is a perl script that
35         prints out several pieces of information about machines 
36         on a subnet that respond to SMB  name query requests.
37         It uses <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry>
38         and <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry>
39         to obtain this information.
40         </para>
41 </refsect1>             
43 <refsect1>
44         <title>OPTIONS</title>
46         <variablelist>
47                 <varlistentry>
48                 <term>-r</term>
49                 <listitem><para>Controls whether <command>findsmb</command> takes
50                 bugs in Windows95 into account when trying to find a Netbios name
51                 registered of the remote machine. This option is disabled by default
52                 because it is specific to Windows 95 and Windows 95 machines only. 
53                 If set, <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry>
54                 will be called with <constant>-B</constant> option.</para></listitem>
55                 </varlistentry>
56                 <varlistentry>
57                 <term>subnet broadcast address</term>
58                 <listitem><para>Without this option, <command>findsmb
59                 </command> will probe the subnet of the machine where 
60                 <citerefentry><refentrytitle>findsmb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
61                 is run. This value is passed to 
62                 <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry>
63                 as part of the <constant>-B</constant> option.</para></listitem>
64                 </varlistentry>
65         </variablelist>
66 </refsect1>
68 <refsect1>
69         <title>EXAMPLES</title>
71         <para>The output of <command>findsmb</command> lists the following 
72         information for all machines that respond to the initial 
73         <command>nmblookup</command> for any name: IP address, NetBIOS name, 
74         Workgroup name, operating system, and SMB server version.</para>
76         <para>There will be a '+' in front of the workgroup name for 
77         machines that are local master browsers for that workgroup. There 
78         will be an '*' in front of the workgroup name for 
79         machines that are the domain master browser for that workgroup. 
80         Machines that are running Windows, Windows 95 or Windows 98 will 
81         not show any information about the operating system or server 
82         version.</para>
84         <para>The command with <constant>-r</constant> option
85         must be run on a system without <citerefentry>
86         <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum>
87         </citerefentry> running. 
89         If <command>nmbd</command> is running on the system, you will 
90         only  get the IP address and the DNS name of the machine. To 
91         get proper responses  from Windows 95 and Windows 98 machines, 
92         the command must be run as root and with <constant>-r</constant>
93         option on a machine without <command>nmbd</command> running.</para>
95         <para>For example, running <command>findsmb</command> 
96         without <constant>-r</constant> option set would yield output similar
97         to the following</para>
99 <screen>
100 IP ADDR         NETBIOS NAME   WORKGROUP/OS/VERSION 
101 --------------------------------------------------------------------- 
102 192.168.35.10   MINESET-TEST1  [DMVENGR]
103 192.168.35.55   LINUXBOX      *[MYGROUP] [Unix] [Samba 2.0.6]
104 192.168.35.56   HERBNT2        [HERB-NT]
105 192.168.35.63   GANDALF        [MVENGR] [Unix] [Samba 2.0.5a for IRIX]
106 192.168.35.65   SAUNA          [WORKGROUP] [Unix] [Samba 1.9.18p10]
107 192.168.35.71   FROGSTAR       [ENGR] [Unix] [Samba 2.0.0 for IRIX]
108 192.168.35.78   HERBDHCP1     +[HERB]
109 192.168.35.88   SCNT2         +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0]
110 192.168.35.93   FROGSTAR-PC    [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager]
111 192.168.35.97   HERBNT1       *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0]
112 </screen>
114 </refsect1>
117 <refsect1>
118         <title>VERSION</title>
120         <para>This man page is correct for version 3.0 of 
121         the Samba suite.</para>
122 </refsect1>
124 <refsect1>
125         <title>SEE ALSO</title>
126         <para><citerefentry>
127         <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum>
128         </citerefentry>,
129         <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
130         </citerefentry>, and <citerefentry><refentrytitle>nmblookup</refentrytitle>
131         <manvolnum>1</manvolnum></citerefentry>
132         </para>
133 </refsect1>
135 <refsect1>
136         <title>AUTHOR</title>
137         
138         <para>The original Samba software and related utilities 
139         were created by Andrew Tridgell. Samba is now developed
140         by the Samba Team as an Open Source project similar 
141         to the way the Linux kernel is developed.</para>
142         
143         <para>The original Samba man pages were written by Karl Auer. 
144         The man page sources were converted to YODL format (another 
145         excellent piece of Open Source software, available at <ulink 
146         url="ftp://ftp.icce.rug.nl/pub/unix/">ftp://ftp.icce.rug.nl/pub/unix/</ulink>) 
147         and updated for the Samba 2.0 release by Jeremy Allison.  The conversion to DocBook for 
148         Samba 2.2 was done by Gerald Carter. The conversion to DocBook
149         XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
150 </refsect1>
152 </refentry>