s3:script: Remove findsmb from default installation
[bbaumbach/samba-autobuild/.git] / examples / scripts / nmb / findsmb.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="findsmb.1">
4
5 <refmeta>
6         <refentrytitle>findsmb</refentrytitle>
7         <manvolnum>1</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">User Commands</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
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>
19
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>findsmb</command>
23                 <arg choice="opt">subnet broadcast address</arg>
24         </cmdsynopsis>
25 </refsynopsisdiv>
26
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>
33
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>
42
43 <refsect1>
44         <title>OPTIONS</title>
45
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>
67
68 <refsect1>
69         <title>EXAMPLES</title>
70
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>
75
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 for Workgroups, Windows 95 or
81         Windows 98 will
82         not show any information about the operating system or server
83         version.</para>
84
85         <para>The command with <constant>-r</constant> option
86         must be run on a system without <citerefentry>
87         <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum>
88         </citerefentry> running.
89
90         If <command>nmbd</command> is running on the system, you will
91         only  get the IP address and the DNS name of the machine. To
92         get proper responses  from Windows 95 and Windows 98 machines,
93         the command must be run as root and with <constant>-r</constant>
94         option on a machine without <command>nmbd</command> running.</para>
95
96         <para>For example, running <command>findsmb</command>
97         without <constant>-r</constant> option set would yield output similar
98         to the following</para>
99
100 <programlisting>
101 IP ADDR         NETBIOS NAME   WORKGROUP/OS/VERSION
102 ---------------------------------------------------------------------
103 192.168.35.10   MINESET-TEST1  [DMVENGR]
104 192.168.35.55   LINUXBOX      *[MYGROUP] [Unix] [Samba 2.0.6]
105 192.168.35.56   HERBNT2        [HERB-NT]
106 192.168.35.63   GANDALF        [MVENGR] [Unix] [Samba 2.0.5a for IRIX]
107 192.168.35.65   SAUNA          [WORKGROUP] [Unix] [Samba 1.9.18p10]
108 192.168.35.71   FROGSTAR       [ENGR] [Unix] [Samba 2.0.0 for IRIX]
109 192.168.35.78   HERBDHCP1     +[HERB]
110 192.168.35.88   SCNT2         +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0]
111 192.168.35.93   FROGSTAR-PC    [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager]
112 192.168.35.97   HERBNT1       *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0]
113 </programlisting>
114
115 </refsect1>
116
117
118 <refsect1>
119         <title>VERSION</title>
120
121         <para>This man page is part of version &doc.version; of
122         the Samba suite.</para>
123 </refsect1>
124
125 <refsect1>
126         <title>SEE ALSO</title>
127         <para><citerefentry>
128         <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum>
129         </citerefentry>,
130         <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
131         </citerefentry>, and <citerefentry><refentrytitle>nmblookup</refentrytitle>
132         <manvolnum>1</manvolnum></citerefentry>
133         </para>
134 </refsect1>
135
136 <refsect1>
137         <title>AUTHOR</title>
138
139         <para>The original Samba software and related utilities
140         were created by Andrew Tridgell. Samba is now developed
141         by the Samba Team as an Open Source project similar
142         to the way the Linux kernel is developed.</para>
143 </refsect1>
144
145 </refentry>