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