78212ebef6551ac73d0b7b637debf2cd23ddf494
[kai/samba.git] / docs / manpages / nmbd.8
1 .TH NMBD 8 17/1/1995 nmbd nmbd
2 .SH NAME
3 nmbd \- provide netbios nameserver support to clients
4 .SH SYNOPSIS
5 .B nmbd
6 [
7 .B \-D
8 ] [
9 .B \-H
10 .I netbios hosts file
11 ] [
12 .B \-d
13 .I debuglevel
14 ] [
15 .B \-l
16 .I log basename
17 ] [
18 .B \-n
19 .I netbios name
20 ] [
21 .B \-p
22 .I port number
23 ] [
24 .B \-s
25 .I configuration file
26 ]
27 .SH DESCRIPTION
28 This program is part of the Samba suite.
29
30 .B nmbd
31 is a server that understands and can reply to netbios
32 name service requests, like those produced by LanManager
33 clients. It also controls browsing.
34
35 LanManager clients, when they start up, may wish to locate a LanManager server.
36 That is, they wish to know what IP number a specified host is using.
37
38 This program simply listens for such requests, and if its own name is specified
39 it will respond with the IP number of the host it is running on. "Its own name"
40 is by default the name of the host it is running on, but this can be overriden
41 with the
42 .B \-n
43 option (see "OPTIONS" below). Using the
44
45 Nmbd can also be used as a WINS (Windows Internet Name Server)
46 server. It will do this automatically by default. What this basically
47 means is that it will respond to all name requests that it receives
48 that are not broadcasts, as long as it can resolve the name.
49 .SH OPTIONS
50 .B \-B
51
52 .RS 3
53 This option is obsolete. Please use the interfaces option in smb.conf
54 .RE
55 .B \-I
56
57 .RS 3
58 This option is obsolete. Please use the interfaces option in smb.conf
59 .RE
60
61 .B \-D
62
63 .RS 3
64 If specified, this parameter causes the server to operate as a daemon. That is,
65 it detaches itself and runs in the background, fielding requests on the 
66 appropriate port.
67
68 By default, the server will NOT operate as a daemon.
69 .RE
70
71 .B \-C comment string
72
73 .RS 3
74 This option is obsolete. Please use the "server string" option in smb.conf
75 .RE
76
77 .B \-G
78
79 .RS 3
80 This option is obsolete. Please use the "workgroup" option in smb.conf
81 .RE
82
83 .B \-H
84 .I netbios hosts file
85
86 .RS 3
87 It may be useful in some situations to be able to specify a list of
88 netbios names for which the server should send a reply if
89 queried. This option allows that. The syntax is similar to the
90 standard /etc/hosts file format, but has some extensions.
91
92 The file contains three columns. Lines beginning with a # are ignored
93 as comments. The first column is an IP address, or a hostname. If it
94 is a hostname then it is interpreted as the IP address returned by
95 gethostbyname() when read. Any IP address of 0.0.0.0 will be
96 interpreted as the server's own IP address.
97
98 The second column is a netbios name. This is the name that the server
99 will respond to. It must be less than 20 characters long.
100
101 The third column is optional, and is intended for flags. Currently the
102 only flag supported is M. 
103
104 An M means that this name is the default netbios name for this
105 machine. This has the same affect as specifying the
106 .B \-n
107 option to
108 .BR nmbd .
109
110 NOTE: The G and S flags are now obsolete and are replaced by the
111 "interfaces" and "remote announce" options in smb.conf.
112
113 After startup the server waits for queries, and will answer queries to
114 any name known to it. This includes all names in the netbios hosts
115 file (if any) and its own name.
116
117 The primary intention of the
118 .B \-H
119 option is to allow a mapping from
120 netbios names to internet domain names.
121
122 .B Example:
123
124         # This is a sample netbios hosts file
125
126         # DO NOT USE THIS FILE AS-IS
127         # YOU MAY INCONVENIENCE THE OWNERS OF THESE IPs
128         # if you want to include a name with a space in it then 
129         # use double quotes.
130
131         # next add a netbios alias for a faraway host
132         arvidsjaur.anu.edu.au ARVIDSJAUR
133
134         # finally put in an IP for a hard to find host
135         130.45.3.213 FREDDY
136
137 .RE
138 .B \-N
139
140 .RS 3
141 This option is obsolete. Please use the "interfaces" option in
142 smb.conf instead.
143 .RE
144
145 .B \-d
146 .I debuglevel
147 .RS 3
148 This option sets the debug level. See
149 .BR smb.conf (5).
150 .RE
151
152 .B \-l
153 .I log file
154
155 .RS 3
156 If specified,
157 .I log file
158 specifies a base filename into which operational data from the running server
159 will be logged.
160
161 The default base name is specified at compile time.
162
163 The base name is used to generate actual log file names. For example, if the
164 name specified was "log" then the file log.nmb would contain debug
165 info.
166 .RE
167
168 .B \-n
169 .I netbios name
170
171 .RS 3
172 This option allows you to override the Netbios name that Samba uses
173 for itself. 
174 .RE
175
176 .B \-p
177 .I port number
178 .RS 3
179
180 port number is a positive integer value.
181
182 Don't use this option unless you are an expert, in which case you
183 won't need help!
184
185 .B \-s
186 .I configuration file
187
188 .RS 3
189 The default configuration file name is determined at compile time.
190
191 The file specified contains the configuration details required by the server.
192 See
193 .BR smb.conf (5)
194 for more information.
195 .RE
196 .SH VERSION
197
198 This man page is (mostly) correct for version 1.9.16 of the Samba
199 suite, plus some of the recent patches to it. These notes will
200 necessarily lag behind development of the software, so it is possible
201 that your version of the server has extensions or parameter semantics
202 that differ from or are not covered by this man page. Please notify
203 these to the address below for rectification.
204 .SH SEE ALSO
205 .BR inetd (8),
206 .BR smbd (8), 
207 .BR smb.conf (5),
208 .BR smbclient (1),
209 .BR testparm (1), 
210 .BR testprns (1)
211 .SH CREDITS
212 The original Samba software and related utilities were created by 
213 Andrew Tridgell (samba-bugs@anu.edu.au). Andrew is also the Keeper
214 of the Source for this project.
215
216 This man page was originally written by Karl Auer (Karl.Auer@anu.edu.au).