summaryrefslogtreecommitdiffstats
path: root/docs/manpages/nmbd.8
blob: be9fd6bf0e9439be20705fac10b831d58381d4d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
.TH NMBD 8 "31 Aug 1998" "nmbd 2.0.0-alpha1"
.SH NAME
nmbd \- provide netbios nameserver support to clients
.SH SYNOPSIS
.B nmbd
[
.B \-D
] [
.B \-H
.I netbios hosts file
] [
.B \-d
.I debuglevel
] [
.B \-l
.I log basename
] [
.B \-n
.I netbios name
] [
.B \-p
.I port number
] [
.B \-s
.I configuration file
]
.SH DESCRIPTION
This program is part of the Samba suite.

.B nmbd
is a server that understands and can reply to netbios
name service requests, like those produced by LanManager
clients. It also controls browsing.

LanManager clients, when they start up, may wish to locate a LanManager server.
That is, they wish to know what IP number a specified host is using.

This program simply listens for such requests, and if its own name is specified
it will respond with the IP number of the host it is running on.
Its "own name" is by default the name of the host it is running on,
but this can be overriden with the
.B \-n
option (see "OPTIONS" below).

.B nmbd 
can also be used as a WINS (Windows Internet Name Server) server. 
What this basically means is that it will respond to all name requests that 
it receives that are not broadcasts, as long as it can resolve the name.
Resolvable names include all names in the netbios hosts file (if any, see 
.B \-H
below), its own name, and any other names that it may have learned about
from other browsers on the network.
A change to previous versions is that nmbd will now no longer
do this automatically by default.
.SH OPTIONS
.B \-B

.RS 3
This option is obsolete. Please use the "interfaces" option in smb.conf instead.
.RE

.B \-I

.RS 3
This option is obsolete. Please use the "interfaces" option in smb.conf instead.
.RE

.B \-D

.RS 3
If specified, this parameter causes the server to operate as a daemon. That is,
it detaches itself and runs in the background, fielding requests on the 
appropriate port.

By default, the server will NOT operate as a daemon.
.RE

.B \-C comment string

.RS 3
This option is obsolete. Please use the "server string" option in smb.conf 
instead.
.RE

.B \-G

.RS 3
This option is obsolete. Please use the "workgroup" option in smb.conf instead.
.RE

.B \-H
.I netbios hosts file

.RS 3
It may be useful in some situations to be able to specify a list of
netbios names for which the server should send a reply if queried.  
This option allows you to specify a file containing such a list. 
The syntax of the hosts file is similar to the standard /etc/hosts file
format, but has some extensions.

The file contains three columns. Lines beginning with a # are ignored
as comments. The first column is an IP address, or a hostname. If it
is a hostname then it is interpreted as the IP address returned by
gethostbyname() when read. An IP address of 0.0.0.0 will be
interpreted as the server's own IP address.

The second column is a netbios name. This is the name that the server
will respond to. It must be less than 20 characters long.

The third column is optional, and is intended for flags. Currently the
only flag supported is M, which means that this name is the default 
netbios name for this machine. This has the same effect as specifying the
.B \-n
option to
.BR nmbd .

NOTE: The G and S flags are now obsolete and are replaced by the
"interfaces" and "remote announce" options in smb.conf.

The default hosts file name is set at compile time, typically as
.I /etc/lmhosts,
but this may be changed in the Samba Makefile.

After startup the server waits for queries, and will answer queries for
any name known to it. This includes all names in the netbios hosts file, 
its own name, and any other names it may have learned about from other 
browsers on the network.

The primary intention of the
.B \-H
option is to allow a mapping from netbios names to internet domain names.

.B Example:

        # This is a sample netbios hosts file

        # DO NOT USE THIS FILE AS-IS
        # YOU MAY INCONVENIENCE THE OWNERS OF THESE IPs
        # if you want to include a name with a space in it then 
        # use double quotes.

        # next add a netbios alias for a faraway host
        arvidsjaur.anu.edu.au ARVIDSJAUR

        # finally put in an IP for a hard to find host
        130.45.3.213 FREDDY

.RE
.B \-N

.RS 3
This option is obsolete. Please use the "interfaces" option in smb.conf instead.
.RE

.B \-d
.I debuglevel

.RS 3
This option sets the debug level. See
.BR smb.conf (5).
.RE

.B \-l
.I log file

.RS 3
The
.I log file
parameter specifies a path and base filename into which operational data 
from the running 
.B nmbd
server will be logged.
The actual log file name is generated by appending the extension ".nmb" to 
the specified base name.
For example, if the name specified was "log" then the file log.nmb would
contain the debugging data.

The default log file is specified at compile time, typically as
.I /var/log/log.nmb.
.RE

.B \-n
.I netbios name

.RS 3
This option allows you to override the Netbios name that Samba uses for itself. 
.RE

.B \-a

.RS 3
If this parameter is specified, the log files will be appended to with each 
new connection.  This is the default.
.RE

.B \-o

.RS 3
Overwrite existing log files instead of appending to them.  (This was the
default until version 2.0.0.)
.RE

.B \-p
.I port number
.RS 3

port number is a positive integer value.

Don't use this option unless you are an expert, in which case you
won't need help!
.RE

.B \-s
.I configuration file

.RS 3
The default configuration file name is set at compile time, typically as
.I /etc/smb.conf,
but this may be changed in the Samba Makefile.

The file specified contains the configuration details required by the server.
See
.BR smb.conf (5)
for more information.
.RE
.SH SIGNALS

In version 1.9.18 and above, nmbd will accept SIGHUP, which will cause it to dump out
it's namelists into the file namelist.debug in the SAMBA/var/locks directory. This
will also cause nmbd to dump out it's server database in the log.nmb file.
Also new in version 1.9.18 and above is the ability to raise the debug log
level of nmbd by sending it a SIGUSR1 (kill -USR1 <nmbd-pid>) and to lower
the nmbd log level by sending it a SIGUSR2 (kill -USR2 <nmbd-pid>). This
is to allow transient problems to be diagnosed, whilst still running at
a normally low log level.

.SH VERSION

This man page is (mostly) correct for version 1.9.16 of the Samba
suite, plus some of the recent patches to it. These notes will
necessarily lag behind development of the software, so it is possible
that your version of the server has extensions or parameter semantics
that differ from or are not covered by this man page. Please notify
these to the address below for rectification.
.SH SEE ALSO
.BR inetd (8),
.BR smbd (8), 
.BR smb.conf (5),
.BR smbclient (1),
.BR testparm (1), 
.BR testprns (1)
.SH CREDITS
The original Samba software and related utilities were created by 
Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
of the Source for this project.