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