merging some changes from SAMBA_2_2
[jra/samba/.git] / docs / htmldocs / nmbd.8.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >nmbd</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
8 ><BODY
9 CLASS="REFENTRY"
10 BGCOLOR="#FFFFFF"
11 TEXT="#000000"
12 LINK="#0000FF"
13 VLINK="#840084"
14 ALINK="#0000FF"
15 ><H1
16 ><A
17 NAME="NMBD"
18 >nmbd</A
19 ></H1
20 ><DIV
21 CLASS="REFNAMEDIV"
22 ><A
23 NAME="AEN5"
24 ></A
25 ><H2
26 >Name</H2
27 >nmbd&nbsp;--&nbsp;NetBIOS name server to provide NetBIOS 
28         over IP naming services to clients</DIV
29 ><DIV
30 CLASS="REFSYNOPSISDIV"
31 ><A
32 NAME="AEN8"
33 ></A
34 ><H2
35 >Synopsis</H2
36 ><P
37 ><B
38 CLASS="COMMAND"
39 >nmbd</B
40 >  [-D] [-a] [-i] [-o] [-P] [-h] [-V] [-d &#60;debug level&#62;] [-H &#60;lmhosts file&#62;] [-l &#60;log directory&#62;] [-n &#60;primary netbios name&#62;] [-p &#60;port number&#62;] [-s &#60;configuration file&#62;]</P
41 ></DIV
42 ><DIV
43 CLASS="REFSECT1"
44 ><A
45 NAME="AEN24"
46 ></A
47 ><H2
48 >DESCRIPTION</H2
49 ><P
50 >This program is part of the Samba suite.</P
51 ><P
52 ><B
53 CLASS="COMMAND"
54 >nmbd</B
55 > is a server that understands 
56         and can reply to NetBIOS over IP name service requests, like 
57         those produced by SMB/CIFS clients such as Windows 95/98/ME, 
58         Windows NT, Windows 2000, and LanManager clients. It also
59         participates in the browsing protocols which make up the 
60         Windows "Network Neighborhood" view.</P
61 ><P
62 >SMB/CIFS clients, when they start up, may wish to 
63         locate an SMB/CIFS server. That is, they wish to know what 
64         IP number a specified host is using.</P
65 ><P
66 >Amongst other services, <B
67 CLASS="COMMAND"
68 >nmbd</B
69 > will 
70         listen for such requests, and if its own NetBIOS name is 
71         specified it will respond with the IP number of the host it 
72         is running on.  Its "own NetBIOS name" is by
73         default the primary DNS name of the host it is running on, 
74         but this can be overridden with the <EM
75 >-n</EM
76
77         option (see OPTIONS below). Thus <B
78 CLASS="COMMAND"
79 >nmbd</B
80 > will 
81         reply to broadcast queries for its own name(s). Additional
82         names for <B
83 CLASS="COMMAND"
84 >nmbd</B
85 > to respond on can be set 
86         via parameters in the <A
87 HREF="smb.conf.5.html"
88 TARGET="_top"
89 ><TT
90 CLASS="FILENAME"
91 >       smb.conf(5)</TT
92 ></A
93 > configuration file.</P
94 ><P
95 ><B
96 CLASS="COMMAND"
97 >nmbd</B
98 > can also be used as a WINS 
99         (Windows Internet Name Server) server. What this basically means 
100         is that it will act as a WINS database server, creating a 
101         database from name registration requests that it receives and 
102         replying to queries from clients for these names.</P
103 ><P
104 >In addition, <B
105 CLASS="COMMAND"
106 >nmbd</B
107 > can act as a WINS 
108         proxy, relaying broadcast queries from clients that do 
109         not understand how to talk the WINS protocol to a WIN 
110         server.</P
111 ></DIV
112 ><DIV
113 CLASS="REFSECT1"
114 ><A
115 NAME="AEN41"
116 ></A
117 ><H2
118 >OPTIONS</H2
119 ><P
120 ></P
121 ><DIV
122 CLASS="VARIABLELIST"
123 ><DL
124 ><DT
125 >-D</DT
126 ><DD
127 ><P
128 >If specified, this parameter causes 
129                 <B
130 CLASS="COMMAND"
131 >nmbd</B
132 > to operate as a daemon. That is, 
133                 it detaches itself and runs in the background, fielding 
134                 requests on the appropriate port. By default, <B
135 CLASS="COMMAND"
136 >nmbd</B
137
138                 will operate as a daemon if launched from a command shell. 
139                 nmbd can also be operated from the <B
140 CLASS="COMMAND"
141 >inetd</B
142
143                 meta-daemon, although this is not recommended.
144                 </P
145 ></DD
146 ><DT
147 >-a</DT
148 ><DD
149 ><P
150 >If this parameter is specified, each new 
151                 connection will append log messages to the log file.  
152                 This is the default.</P
153 ></DD
154 ><DT
155 >-i</DT
156 ><DD
157 ><P
158 >If this parameter is specified it causes the
159                 server to run "interactively", not as a daemon, even if the
160                 server is executed on the command line of a shell. Setting this
161                 parameter negates the implicit deamon mode when run from the
162                 command line.
163                 </P
164 ></DD
165 ><DT
166 >-o</DT
167 ><DD
168 ><P
169 >If this parameter is specified, the 
170                 log files will be overwritten when opened.  By default, 
171                 <B
172 CLASS="COMMAND"
173 >smbd</B
174 > will append entries to the log 
175                 files.</P
176 ></DD
177 ><DT
178 >-h</DT
179 ><DD
180 ><P
181 >Prints the help information (usage) 
182                 for <B
183 CLASS="COMMAND"
184 >nmbd</B
185 >.</P
186 ></DD
187 ><DT
188 >-H &#60;filename&#62;</DT
189 ><DD
190 ><P
191 >NetBIOS lmhosts file.  The lmhosts 
192                 file is a list of NetBIOS names to IP addresses that 
193                 is loaded by the nmbd server and used via the name 
194                 resolution mechanism <A
195 HREF="smb.conf.5.html#nameresolveorder"
196 TARGET="_top"
197 >               name resolve order</A
198 > described in <A
199 HREF="smb.conf.5.html"
200 TARGET="_top"
201 > <TT
202 CLASS="FILENAME"
203 >smb.conf(5)</TT
204 ></A
205 >
206                 to resolve any NetBIOS name queries needed by the server. Note 
207                 that the contents of this file are <EM
208 >NOT</EM
209
210                 used by <B
211 CLASS="COMMAND"
212 >nmbd</B
213 > to answer any name queries. 
214                 Adding a line to this file affects name NetBIOS resolution 
215                 from this host <EM
216 >ONLY</EM
217 >.</P
218 ><P
219 >The default path to this file is compiled into 
220                 Samba as part of the build process. Common defaults 
221                 are <TT
222 CLASS="FILENAME"
223 >/usr/local/samba/lib/lmhosts</TT
224 >,
225                 <TT
226 CLASS="FILENAME"
227 >/usr/samba/lib/lmhosts</TT
228 > or
229                 <TT
230 CLASS="FILENAME"
231 >/etc/lmhosts</TT
232 >. See the <A
233 HREF="lmhosts.5.html"
234 TARGET="_top"
235 >               <TT
236 CLASS="FILENAME"
237 >lmhosts(5)</TT
238 ></A
239 > man page for details on the 
240                 contents of this file.</P
241 ></DD
242 ><DT
243 >-V</DT
244 ><DD
245 ><P
246 >Prints the version number for 
247                 <B
248 CLASS="COMMAND"
249 >nmbd</B
250 >.</P
251 ></DD
252 ><DT
253 >-d &#60;debug level&#62;</DT
254 ><DD
255 ><P
256 >debuglevel is an integer 
257                 from 0 to 10.  The default value if this parameter is 
258                 not specified is zero.</P
259 ><P
260 >The higher this value, the more detail will 
261                 be logged to the log files about the activities of the 
262                 server. At level 0, only critical errors and serious 
263                 warnings will be logged. Level 1 is a reasonable level for
264                 day to day running - it generates a small amount of 
265                 information about operations carried out.</P
266 ><P
267 >Levels above 1 will generate considerable amounts 
268                 of log data, and should only be used when investigating 
269                 a problem. Levels above 3 are designed for use only by developers 
270                 and generate HUGE amounts of log data, most of which is extremely 
271                 cryptic.</P
272 ><P
273 >Note that specifying this parameter here will override 
274                 the <A
275 HREF="smb.conf.5.html#loglevel"
276 TARGET="_top"
277 >log level</A
278
279                 parameter in the <A
280 HREF="smb.conf.5.html"
281 TARGET="_top"
282 ><TT
283 CLASS="FILENAME"
284 >               smb.conf</TT
285 ></A
286 > file.</P
287 ></DD
288 ><DT
289 >-l &#60;log directory&#62;</DT
290 ><DD
291 ><P
292 >The -l parameter specifies a directory 
293                 into which the "log.nmbd" log file will be created
294                 for operational data from the running
295                 <B
296 CLASS="COMMAND"
297 >nmbd</B
298 > server. The default log directory is compiled into Samba
299                 as part of the build process. Common defaults are <TT
300 CLASS="FILENAME"
301 >               /usr/local/samba/var/log.nmb</TT
302 >, <TT
303 CLASS="FILENAME"
304 >               /usr/samba/var/log.nmb</TT
305 > or
306                 <TT
307 CLASS="FILENAME"
308 >/var/log/log.nmb</TT
309 >.  <EM
310 >Beware:</EM
311 >
312                 If the directory specified does not exist, <B
313 CLASS="COMMAND"
314 >nmbd</B
315 >
316                 will log to the default debug log location defined at compile time.
317                 </P
318 ></DD
319 ><DT
320 >-n &#60;primary NetBIOS name&#62;</DT
321 ><DD
322 ><P
323 >This option allows you to override
324                 the NetBIOS name that Samba uses for itself. This is identical 
325                 to setting the <A
326 HREF="smb.conf.5.html#netbiosname"
327 TARGET="_top"
328 >               NetBIOS name</A
329 > parameter in the <A
330 HREF="smb.conf.5.html"
331 TARGET="_top"
332 >       
333                 <TT
334 CLASS="FILENAME"
335 >smb.conf</TT
336 ></A
337 > file.  However, a command
338                 line setting will take precedence over settings in 
339                 <TT
340 CLASS="FILENAME"
341 >smb.conf</TT
342 >.</P
343 ></DD
344 ><DT
345 >-p &#60;UDP port number&#62;</DT
346 ><DD
347 ><P
348 >UDP port number is a positive integer value.
349                 This option changes the default UDP port number (normally 137)
350                 that <B
351 CLASS="COMMAND"
352 >nmbd</B
353 > responds to name queries on. Don't
354                 use this option unless you are an expert, in which case you
355                 won't need help!</P
356 ></DD
357 ><DT
358 >-s &#60;configuration file&#62;</DT
359 ><DD
360 ><P
361 >The default configuration file name
362                 is set at build time, typically as <TT
363 CLASS="FILENAME"
364 >               /usr/local/samba/lib/smb.conf</TT
365 >, but
366                 this may be changed when Samba is autoconfigured.</P
367 ><P
368 >The file specified contains the configuration details
369                 required by the server. See <A
370 HREF="smb.conf.5.html"
371 TARGET="_top"
372 >               <TT
373 CLASS="FILENAME"
374 >smb.conf(5)</TT
375 ></A
376 > for more information.
377                 </P
378 ></DD
379 ></DL
380 ></DIV
381 ></DIV
382 ><DIV
383 CLASS="REFSECT1"
384 ><A
385 NAME="AEN131"
386 ></A
387 ><H2
388 >FILES</H2
389 ><P
390 ></P
391 ><DIV
392 CLASS="VARIABLELIST"
393 ><DL
394 ><DT
395 ><TT
396 CLASS="FILENAME"
397 >/etc/inetd.conf</TT
398 ></DT
399 ><DD
400 ><P
401 >If the server is to be run by the
402                 <B
403 CLASS="COMMAND"
404 >inetd</B
405 > meta-daemon, this file
406                 must contain suitable startup information for the
407                 meta-daemon. See the <A
408 HREF="UNIX_INSTALL.html"
409 TARGET="_top"
410 >UNIX_INSTALL.html</A
411 > document
412                 for details.
413                 </P
414 ></DD
415 ><DT
416 ><TT
417 CLASS="FILENAME"
418 >/etc/rc</TT
419 ></DT
420 ><DD
421 ><P
422 >or whatever initialization script your
423                 system uses).</P
424 ><P
425 >If running the server as a daemon at startup,
426                 this file will need to contain an appropriate startup
427                 sequence for the server. See the <A
428 HREF="UNIX_INSTALL.html"
429 TARGET="_top"
430 >UNIX_INSTALL.html</A
431 > document
432                 for details.</P
433 ></DD
434 ><DT
435 ><TT
436 CLASS="FILENAME"
437 >/etc/services</TT
438 ></DT
439 ><DD
440 ><P
441 >If running the server via the
442                 meta-daemon <B
443 CLASS="COMMAND"
444 >inetd</B
445 >, this file
446                 must contain a mapping of service name (e.g., netbios-ssn)
447                 to service port (e.g., 139) and protocol type (e.g., tcp).
448                 See the <A
449 HREF="UNIX_INSTALL.html"
450 TARGET="_top"
451 >UNIX_INSTALL.html</A
452 >
453                 document for details.</P
454 ></DD
455 ><DT
456 ><TT
457 CLASS="FILENAME"
458 >/usr/local/samba/lib/smb.conf</TT
459 ></DT
460 ><DD
461 ><P
462 >This is the default location of the
463                 <A
464 HREF="smb.conf.5.html"
465 TARGET="_top"
466 ><TT
467 CLASS="FILENAME"
468 >smb.conf</TT
469 ></A
470 >
471                 server configuration file. Other common places that systems
472                 install this file are <TT
473 CLASS="FILENAME"
474 >/usr/samba/lib/smb.conf</TT
475 >
476                 and <TT
477 CLASS="FILENAME"
478 >/etc/smb.conf</TT
479 >.</P
480 ><P
481 >When run as a WINS server (see the
482                 <A
483 HREF="smb.conf.5.html#WINSSUPPORT"
484 TARGET="_top"
485 >wins support</A
486 >
487                 parameter in the <TT
488 CLASS="FILENAME"
489 >smb.conf(5)</TT
490 > man page),
491                 <B
492 CLASS="COMMAND"
493 >nmbd</B
494 >
495                 will store the WINS database in the file <TT
496 CLASS="FILENAME"
497 >wins.dat</TT
498 >
499                 in the <TT
500 CLASS="FILENAME"
501 >var/locks</TT
502 > directory configured under
503                 wherever Samba was configured to install itself.</P
504 ><P
505 >If <B
506 CLASS="COMMAND"
507 >nmbd</B
508 > is acting as a <EM
509 >               browse master</EM
510 > (see the <A
511 HREF="smb.conf.5.html#LOCALMASTER"
512 TARGET="_top"
513 >local master</A
514 >
515                 parameter in the <TT
516 CLASS="FILENAME"
517 >smb.conf(5)</TT
518 > man page,
519                 <B
520 CLASS="COMMAND"
521 >nmbd</B
522 >
523                 will store the browsing database in the file <TT
524 CLASS="FILENAME"
525 >browse.dat
526                 </TT
527 > in the <TT
528 CLASS="FILENAME"
529 >var/locks</TT
530 > directory
531                 configured under wherever Samba was configured to install itself.
532                 </P
533 ></DD
534 ></DL
535 ></DIV
536 ></DIV
537 ><DIV
538 CLASS="REFSECT1"
539 ><A
540 NAME="AEN178"
541 ></A
542 ><H2
543 >SIGNALS</H2
544 ><P
545 >To shut down an <B
546 CLASS="COMMAND"
547 >nmbd</B
548 > process it is recommended
549         that SIGKILL (-9) <EM
550 >NOT</EM
551 > be used, except as a last
552         resort, as this may leave the name database in an inconsistent state.
553         The correct way to terminate <B
554 CLASS="COMMAND"
555 >nmbd</B
556 > is to send it
557         a SIGTERM (-15) signal and wait for it to die on its own.</P
558 ><P
559 ><B
560 CLASS="COMMAND"
561 >nmbd</B
562 > will accept SIGHUP, which will cause
563         it to dump out its namelists into the file <TT
564 CLASS="FILENAME"
565 >namelist.debug
566         </TT
567 > in the <TT
568 CLASS="FILENAME"
569 >/usr/local/samba/var/locks</TT
570 >
571         directory (or the <TT
572 CLASS="FILENAME"
573 >var/locks</TT
574 > directory configured
575         under wherever Samba was configured to install itself). This will also
576         cause <B
577 CLASS="COMMAND"
578 >nmbd</B
579 > to dump out its server database in
580         the <TT
581 CLASS="FILENAME"
582 >log.nmb</TT
583 > file.</P
584 ><P
585 >The debug log level of nmbd may be raised or lowered using
586         <A
587 HREF="smbcontrol.1.html"
588 TARGET="_top"
589 ><B
590 CLASS="COMMAND"
591 >smbcontrol(1)</B
592 >
593         </A
594 > (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is
595         to allow transient problems to be diagnosed, whilst still running
596         at a normally low log level.</P
597 ></DIV
598 ><DIV
599 CLASS="REFSECT1"
600 ><A
601 NAME="AEN194"
602 ></A
603 ><H2
604 >VERSION</H2
605 ><P
606 >This man page is correct for version 2.2 of 
607         the Samba suite.</P
608 ></DIV
609 ><DIV
610 CLASS="REFSECT1"
611 ><A
612 NAME="AEN197"
613 ></A
614 ><H2
615 >SEE ALSO</H2
616 ><P
617 ><B
618 CLASS="COMMAND"
619 >inetd(8)</B
620 >, <A
621 HREF="smbd.8.html"
622 TARGET="_top"
623 ><B
624 CLASS="COMMAND"
625 >smbd(8)</B
626 ></A
627 >, 
628         <A
629 HREF="smb.conf.5.html"
630 TARGET="_top"
631 ><TT
632 CLASS="FILENAME"
633 >smb.conf(5)</TT
634 >
635         </A
636 >, <A
637 HREF="smbclient.1.html"
638 TARGET="_top"
639 ><B
640 CLASS="COMMAND"
641 >smbclient(1)
642         </B
643 ></A
644 >, <A
645 HREF="testparm.1.html"
646 TARGET="_top"
647 ><B
648 CLASS="COMMAND"
649 >       testparm(1)</B
650 ></A
651 >, <A
652 HREF="testprns.1.html"
653 TARGET="_top"
654 >       <B
655 CLASS="COMMAND"
656 >testprns(1)</B
657 ></A
658 >, and the Internet RFC's
659         <TT
660 CLASS="FILENAME"
661 >rfc1001.txt</TT
662 >, <TT
663 CLASS="FILENAME"
664 >rfc1002.txt</TT
665 >. 
666         In addition the CIFS (formerly SMB) specification is available 
667         as a link from the Web page <A
668 HREF="http://samba.org/cifs/"
669 TARGET="_top"
670
671         http://samba.org/cifs/</A
672 >.</P
673 ></DIV
674 ><DIV
675 CLASS="REFSECT1"
676 ><A
677 NAME="AEN214"
678 ></A
679 ><H2
680 >AUTHOR</H2
681 ><P
682 >The original Samba software and related utilities 
683         were created by Andrew Tridgell. Samba is now developed
684         by the Samba Team as an Open Source project similar 
685         to the way the Linux kernel is developed.</P
686 ><P
687 >The original Samba man pages were written by Karl Auer. 
688         The man page sources were converted to YODL format (another 
689         excellent piece of Open Source software, available at
690         <A
691 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
692 TARGET="_top"
693 >       ftp://ftp.icce.rug.nl/pub/unix/</A
694 >) and updated for the Samba 2.0 
695         release by Jeremy Allison.  The conversion to DocBook for 
696         Samba 2.2 was done by Gerald Carter</P
697 ></DIV
698 ></BODY
699 ></HTML
700 >