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