docs/htmldocs/nmbd.8.html

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