This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[kai/samba.git] / docs / docbook / manpages / lmhosts.5.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry id="lmhosts">
3
4 <refmeta>
5         <refentrytitle>lmhosts</refentrytitle>
6         <manvolnum>5</manvolnum>
7 </refmeta>
8
9
10 <refnamediv>
11         <refname>lmhosts</refname>
12         <refpurpose>The Samba NetBIOS hosts file</refpurpose>
13 </refnamediv>
14
15 <refsynopsisdiv>
16         <para><filename>lmhosts</filename> is the <ulink url="samba.7.html">
17         Samba</ulink> NetBIOS name to IP address mapping file.</para> 
18 </refsynopsisdiv>
19
20 <refsect1>
21         <title>DESCRIPTION</title>
22         
23         <para>This file is part of the <ulink url="samba.7.html">
24         Samba</ulink> suite.</para>
25
26         <para><filename>lmhosts</filename> is the <emphasis>Samba
27         </emphasis> NetBIOS name to IP address mapping file.  It 
28         is very similar to the <filename>/etc/hosts</filename> file 
29         format, except that the hostname component must correspond 
30         to the NetBIOS naming format.</para>
31 </refsect1>
32
33 <refsect1>
34         <title>FILE FORMAT</title>
35         <para>It is an ASCII file containing one line for NetBIOS name. 
36         The two fields on each line are separated from each other by 
37         white space. Any entry beginning with '#' is ignored. Each line 
38         in the lmhosts file contains the following information :</para>
39
40         <itemizedlist>
41                 <listitem><para>IP Address - in dotted decimal format.</para>
42                 </listitem>
43
44                 <listitem><para>NetBIOS Name - This name format is a 
45                 maximum fifteen character host name, with an optional 
46                 trailing '#' character followed by the NetBIOS name type 
47                 as two hexadecimal digits.</para>
48
49                 <para>If the trailing '#' is omitted then the given IP 
50                 address will be returned for all names that match the given 
51                 name, whatever the NetBIOS name type in the lookup.</para>
52                 </listitem>
53         </itemizedlist>
54
55         <para>An example follows :</para>
56         
57         <para><programlisting>
58 #
59 # Sample Samba lmhosts file.
60 #
61 192.9.200.1     TESTPC
62 192.9.200.20    NTSERVER#20
63 192.9.200.21    SAMBASERVER
64         </programlisting></para>
65         
66         <para>Contains three IP to NetBIOS name mappings. The first 
67         and third will be returned for any queries for the names "TESTPC" 
68         and "SAMBASERVER" respectively, whatever the type component of 
69         the NetBIOS name requested.</para>
70
71         <para>The second mapping will be returned only when the "0x20" name 
72         type for a name "NTSERVER" is queried. Any other name type will not 
73         be resolved.</para>
74
75         <para>The default location of the <filename>lmhosts</filename> file 
76         is in the same directory as the <ulink url="smb.conf.5.html">           
77         smb.conf(5)></ulink> file.</para>
78         
79 </refsect1>
80
81 <refsect1>
82         <title>VERSION</title>
83
84         <para>This man page is correct for version 2.2 of 
85         the Samba suite.</para>
86 </refsect1>
87
88 <refsect1>
89         <title>SEE ALSO</title>
90         <para><ulink url="smbclient.1.html"><command>smbclient(1)
91         </command></ulink>, <ulink url="smb.conf.5.html#NAMERESOLVEORDER">
92         smb.conf(5)</ulink>, and <ulink url="smbpasswd.8.html"><command>
93         smbpasswd(8)</command></ulink>
94         </para>
95 </refsect1>
96
97 <refsect1>
98         <title>AUTHOR</title>
99         
100         <para>The original Samba software and related utilities 
101         were created by Andrew Tridgell. Samba is now developed
102         by the Samba Team as an Open Source project similar 
103         to the way the Linux kernel is developed.</para>
104         
105         <para>The original Samba man pages were written by Karl Auer. 
106         The man page sources were converted to YODL format (another 
107         excellent piece of Open Source software, available at
108         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
109         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
110         release by Jeremy Allison.  The conversion to DocBook for 
111         Samba 2.2 was done by Gerald Carter</para>
112 </refsect1>
113
114 </refentry>