7b2371fdb718e5b66d411a1b26f9aa32af81d4c6
[ira/wip.git] / docs / docbook / manpages / findsmb.1.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry id="findsmb">
3
4 <refmeta>
5         <refentrytitle>findsmb</refentrytitle>
6         <manvolnum>1</manvolnum>
7 </refmeta>
8
9
10 <refnamediv>
11         <refname>findsmb</refname>
12         <refpurpose>list info about machines that respond to SMB 
13         name queries on a subnet</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17         <cmdsynopsis>
18                 <command>findsmb</command>
19                 <arg choice="opt">subnet broadcast address</arg>
20         </cmdsynopsis>
21 </refsynopsisdiv>
22
23 <refsect1>
24         <title>DESCRIPTION</title>
25         
26         <para>This perl script is part of the <ulink url="samba.7.html">
27         Samba</ulink> suite.</para>
28
29         <para><command>findsmb</command> is a perl script that
30         prints out several pieces of information about machines 
31         on a subnet that respond to SMB  name query requests.
32         It uses <ulink url="nmblookup.1.html"><command>
33         nmblookup(1)</command></ulink> and <ulink url="smbclient.1.html">
34         <command>smbclient(1)</command></ulink> to obtain this information.
35         </para>
36 </refsect1>             
37
38 <refsect1>
39         <title>OPTIONS</title>
40
41         <variablelist>
42                 <varlistentry>
43                 <term>subnet broadcast address</term>
44                 <listitem><para>Without this option, <command>findsmb
45                 </command> will probe the subnet of the machine where 
46                 <command>findsmb</command> is run. This value is passed 
47                 to <command>nmblookup</command> as part of the 
48                 <constant>-B</constant> option.</para></listitem>
49                 </varlistentry>
50         </variablelist>
51 </refsect1>
52
53 <refsect1>
54         <title>EXAMPLES</title>
55
56         <para>The output of <command>findsmb</command> lists the following 
57         information for all machines that respond to the initial 
58         <command>nmblookup</command> for any name: IP address, NetBIOS name, 
59         Workgroup name, operating system, and SMB server version.</para>
60
61         <para>There will be a '+' in front of the workgroup name for 
62         machines that are local master browsers for that workgroup. There 
63         will be an '*' in front of the workgroup name for 
64         machines that are the domain master browser for that workgroup. 
65         Machines that are running Windows, Windows 95 or Windows 98 will 
66         not show any information about the operating system or server 
67         version.</para>
68
69         <para>The command must be run on a system without <ulink
70         url="nmbd.8.html"><command>nmbd</command></ulink> running. 
71         If <command>nmbd</command> is running on the system, you will 
72         only  get the IP address and the DNS name of the machine. To 
73         get proper responses  from Windows 95 and Windows 98 machines, 
74         the command must be run as root. </para>
75
76         <para>For example, running <command>findsmb</command> on a machine 
77         without <command>nmbd</command> running would yield output similar
78         to the following</para>
79
80         <screen><computeroutput>
81 IP ADDR         NETBIOS NAME   WORKGROUP/OS/VERSION 
82 --------------------------------------------------------------------- 
83 192.168.35.10   MINESET-TEST1  [DMVENGR]
84 192.168.35.55   LINUXBOX      *[MYGROUP] [Unix] [Samba 2.0.6]
85 192.168.35.56   HERBNT2        [HERB-NT]
86 192.168.35.63   GANDALF        [MVENGR] [Unix] [Samba 2.0.5a for IRIX]
87 192.168.35.65   SAUNA          [WORKGROUP] [Unix] [Samba 1.9.18p10]
88 192.168.35.71   FROGSTAR       [ENGR] [Unix] [Samba 2.0.0 for IRIX]
89 192.168.35.78   HERBDHCP1     +[HERB]
90 192.168.35.88   SCNT2         +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0]
91 192.168.35.93   FROGSTAR-PC    [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager]
92 192.168.35.97   HERBNT1       *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0]
93         </computeroutput></screen>
94
95 </refsect1>
96
97
98 <refsect1>
99         <title>VERSION</title>
100
101         <para>This man page is correct for version 2.2 of 
102         the Samba suite.</para>
103 </refsect1>
104
105 <refsect1>
106         <title>SEE ALSO</title>
107         <para><ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>, 
108         <ulink url="smbclient.1.html"><command>smbclient(1)
109         </command></ulink>, and <ulink url="nmblookup.1.html">
110         <command>nmblookup(1)</command></ulink>
111         </para>
112 </refsect1>
113
114 <refsect1>
115         <title>AUTHOR</title>
116         
117         <para>The original Samba software and related utilities 
118         were created by Andrew Tridgell. Samba is now developed
119         by the Samba Team as an Open Source project similar 
120         to the way the Linux kernel is developed.</para>
121         
122         <para>The original Samba man pages were written by Karl Auer. 
123         The man page sources were converted to YODL format (another 
124         excellent piece of Open Source software, available at
125         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
126         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
127         release by Jeremy Allison.  The conversion to DocBook for 
128         Samba 2.2 was done by Gerald Carter</para>
129 </refsect1>
130
131 </refentry>