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 >smbd</B
  40 >  [-D] [-a] [-o] [-P] [-h] [-V] [-d &#60;debug level&#62;] [-H &#60;lmhosts file&#62;] [-l &#60;log file&#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="AEN23"
  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="AEN40"
 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 >-o</DT
 156 ><DD
 157 ><P
 158 >If this parameter is specified, the
 159                 log files will be overwritten when opened.  By default,
 160                 <B
 161 CLASS="COMMAND"
 162 >smbd</B
 163 > will append entries to the log
 164                 files.</P
 165 ></DD
 166 ><DT
 167 >-h</DT
 168 ><DD
 169 ><P
 170 >Prints the help information (usage)
 171                 for <B
 172 CLASS="COMMAND"
 173 >nmbd</B
 174 >.</P
 175 ></DD
 176 ><DT
 177 >-H &#60;filename&#62;</DT
 178 ><DD
 179 ><P
 180 >NetBIOS lmhosts file.  The lmhosts
 181                 file is a list of NetBIOS names to IP addresses that
 182                 is loaded by the nmbd server and used via the name
 183                 resolution mechanism <A
 184 HREF="smb.conf.5.html#nameresolveorder"
 185 TARGET="_top"
 186 >               name resolve order</A
 187 > described in <A
 188 HREF="smb.conf.5.html"
 189 TARGET="_top"
 190 > <TT
 191 CLASS="FILENAME"
 192 >smb.conf(5)</TT
 193 ></A
 194 >
 195                 to resolve any NetBIOS name queries needed by the server. Note
 196                 that the contents of this file are <EM
 197 >NOT</EM
 198 >
 199                 used by <B
 200 CLASS="COMMAND"
 201 >nmbd</B
 202 > to answer any name queries.
 203                 Adding a line to this file affects name NetBIOS resolution
 204                 from this host <EM
 205 >ONLY</EM
 206 >.</P
 207 ><P
 208 >The default path to this file is compiled into
 209                 Samba as part of the build process. Common defaults
 210                 are <TT
 211 CLASS="FILENAME"
 212 >/usr/local/samba/lib/lmhosts</TT
 213 >,
 214                 <TT
 215 CLASS="FILENAME"
 216 >/usr/samba/lib/lmhosts</TT
 217 > or
 218                 <TT
 219 CLASS="FILENAME"
 220 >/etc/lmhosts</TT
 221 >. See the <A
 222 HREF="lmhosts.5.html"
 223 TARGET="_top"
 224 >               <TT
 225 CLASS="FILENAME"
 226 >lmhosts(5)</TT
 227 ></A
 228 > man page for details on the
 229                 contents of this file.</P
 230 ></DD
 231 ><DT
 232 >-V</DT
 233 ><DD
 234 ><P
 235 >Prints the version number for
 236                 <B
 237 CLASS="COMMAND"
 238 >nmbd</B
 239 >.</P
 240 ></DD
 241 ><DT
 242 >-d &#60;debug level&#62;</DT
 243 ><DD
 244 ><P
 245 >debuglevel is an integer
 246                 from 0 to 10.  The default value if this parameter is
 247                 not specified is zero.</P
 248 ><P
 249 >The higher this value, the more detail will
 250                 be logged to the log files about the activities of the
 251                 server. At level 0, only critical errors and serious
 252                 warnings will be logged. Level 1 is a reasonable level for
 253                 day to day running - it generates a small amount of
 254                 information about operations carried out.</P
 255 ><P
 256 >Levels above 1 will generate considerable amounts
 257                 of log data, and should only be used when investigating
 258                 a problem. Levels above 3 are designed for use only by developers
 259                 and generate HUGE amounts of log data, most of which is extremely
 260                 cryptic.</P
 261 ><P
 262 >Note that specifying this parameter here will override
 263                 the <A
 264 HREF="smb.conf.5.html#loglevel"
 265 TARGET="_top"
 266 >log level</A
 267 >
 268                 parameter in the <A
 269 HREF="smb.conf.5.html"
 270 TARGET="_top"
 271 ><TT
 272 CLASS="FILENAME"
 273 >               smb.conf</TT
 274 ></A
 275 > file.</P
 276 ></DD
 277 ><DT
 278 >-l &#60;log file&#62;</DT
 279 ><DD
 280 ><P
 281 >The -l parameter specifies a path
 282                 and base filename into which operational data from
 283                 the running <B
 284 CLASS="COMMAND"
 285 >nmbd</B
 286 > server will
 287                 be logged.  The actual log file name is generated by
 288                 appending the extension ".nmb" to the specified base
 289                 name.  For example, if the name specified was "log"
 290                 then the file log.nmb would contain the debugging data.</P
 291 ><P
 292 >The default log file path is compiled into Samba as
 293                 part of the build process. Common defaults are <TT
 294 CLASS="FILENAME"
 295 >               /usr/local/samba/var/log.nmb</TT
 296 >, <TT
 297 CLASS="FILENAME"
 298 >               /usr/samba/var/log.nmb</TT
 299 > or
 300                 <TT
 301 CLASS="FILENAME"
 302 >/var/log/log.nmb</TT
 303 >.</P
 304 ></DD
 305 ><DT
 306 >-n &#60;primary NetBIOS name&#62;</DT
 307 ><DD
 308 ><P
 309 >This option allows you to override
 310                 the NetBIOS name that Samba uses for itself. This is identical
 311                 to setting the <A
 312 HREF="smb.conf.5.html#netbiosname"
 313 TARGET="_top"
 314 >               NetBIOS name</A
 315 > parameter in the <A
 316 HREF="smb.conf.5.html"
 317 TARGET="_top"
 318 >
 319                 <TT
 320 CLASS="FILENAME"
 321 >smb.conf</TT
 322 ></A
 323 > file.  However, a command
 324                 line setting will take precedence over settings in
 325                 <TT
 326 CLASS="FILENAME"
 327 >smb.conf</TT
 328 >.</P
 329 ></DD
 330 ><DT
 331 >-p &#60;UDP port number&#62;</DT
 332 ><DD
 333 ><P
 334 >UDP port number is a positive integer value.
 335                 This option changes the default UDP port number (normally 137)
 336                 that <B
 337 CLASS="COMMAND"
 338 >nmbd</B
 339 > responds to name queries on. Don't
 340                 use this option unless you are an expert, in which case you
 341                 won't need help!</P
 342 ></DD
 343 ><DT
 344 >-s &#60;configuration file&#62;</DT
 345 ><DD
 346 ><P
 347 >The default configuration file name
 348                 is set at build time, typically as <TT
 349 CLASS="FILENAME"
 350 >               /usr/local/samba/lib/smb.conf</TT
 351 >, but
 352                 this may be changed when Samba is autoconfigured.</P
 353 ><P
 354 >The file specified contains the configuration details
 355                 required by the server. See <A
 356 HREF="smb.conf.5.html"
 357 TARGET="_top"
 358 >
 359                 <TT
 360 CLASS="FILENAME"
 361 >smb.conf(5)</TT
 362 ></A
 363 > for more information.
 364                 </P
 365 ></DD
 366 ></DL
 367 ></DIV
 368 ></DIV
 369 ><DIV
 370 CLASS="REFSECT1"
 371 ><A
 372 NAME="AEN125"
 373 ></A
 374 ><H2
 375 >FILES</H2
 376 ><P
 377 ></P
 378 ><DIV
 379 CLASS="VARIABLELIST"
 380 ><DL
 381 ><DT
 382 ><TT
 383 CLASS="FILENAME"
 384 >/etc/inetd.conf</TT
 385 ></DT
 386 ><DD
 387 ><P
 388 >If the server is to be run by the
 389                 <B
 390 CLASS="COMMAND"
 391 >inetd</B
 392 > meta-daemon, this file
 393                 must contain suitable startup information for the
 394                 meta-daemon. See the section INSTALLATION below.
 395                 </P
 396 ></DD
 397 ><DT
 398 ><TT
 399 CLASS="FILENAME"
 400 >/etc/rc</TT
 401 ></DT
 402 ><DD
 403 ><P
 404 >or whatever initialization script your
 405                 system uses).</P
 406 ><P
 407 >If running the server as a daemon at startup,
 408                 this file will need to contain an appropriate startup
 409                 sequence for the server. See the section INSTALLATION
 410                 below.</P
 411 ></DD
 412 ><DT
 413 ><TT
 414 CLASS="FILENAME"
 415 >/etc/services</TT
 416 ></DT
 417 ><DD
 418 ><P
 419 >If running the server via the
 420                 meta-daemon <B
 421 CLASS="COMMAND"
 422 >inetd</B
 423 >, this file
 424                 must contain a mapping of service name (e.g., netbios-ssn)
 425                 to service port (e.g., 139) and protocol type (e.g., tcp).
 426                 See the section INSTALLATION below.</P
 427 ></DD
 428 ><DT
 429 ><TT
 430 CLASS="FILENAME"
 431 >/usr/local/samba/lib/smb.conf</TT
 432 ></DT
 433 ><DD
 434 ><P
 435 >This is the default location of the
 436                 <A
 437 HREF="smb.conf.5.html"
 438 TARGET="_top"
 439 ><TT
 440 CLASS="FILENAME"
 441 >smb.conf</TT
 442 ></A
 443 >
 444                 server configuration file. Other common places that systems
 445                 install this file are <TT
 446 CLASS="FILENAME"
 447 >/usr/samba/lib/smb.conf</TT
 448 >
 449                 and <TT
 450 CLASS="FILENAME"
 451 >/etc/smb.conf</TT
 452 >.</P
 453 ><P
 454 >When run as a WINS server (see the
 455                 <A
 456 HREF="smb.conf.5.html#winssupport"
 457 TARGET="_top"
 458 >wins support</A
 459 >
 460                 parameter in the <A
 461 HREF="smb.conf.5.html"
 462 TARGET="_top"
 463 ><TT
 464 CLASS="FILENAME"
 465 >               smb.conf(5)</TT
 466 ></A
 467 > man page), <B
 468 CLASS="COMMAND"
 469 >nmbd</B
 470 >
 471                 will store the WINS database in the file <TT
 472 CLASS="FILENAME"
 473 >wins.dat</TT
 474 >
 475                 in the <TT
 476 CLASS="FILENAME"
 477 >var/locks</TT
 478 > directory configured under
 479                 wherever Samba was configured to install itself.</P
 480 ><P
 481 >If <B
 482 CLASS="COMMAND"
 483 >nmbd</B
 484 > is acting as a <EM
 485 >               browse master</EM
 486 > (see the <A
 487 HREF="smb.conf.5.html#localmaster"
 488 TARGET="_top"
 489 >local master</A
 490 >
 491                 parameter in the <A
 492 HREF="smb.conf.5.html"
 493 TARGET="_top"
 494 ><TT
 495 CLASS="FILENAME"
 496 >               smb.conf(5)</TT
 497 ></A
 498 > man page), <B
 499 CLASS="COMMAND"
 500 >nmbd</B
 501 >
 502                 will store the browsing database in the file <TT
 503 CLASS="FILENAME"
 504 >browse.dat
 505                 </TT
 506 > in the <TT
 507 CLASS="FILENAME"
 508 >var/locks</TT
 509 > directory
 510                 configured under wherever Samba was configured to install itself.
 511                 </P
 512 ></DD
 513 ></DL
 514 ></DIV
 515 ></DIV
 516 ><DIV
 517 CLASS="REFSECT1"
 518 ><A
 519 NAME="AEN171"
 520 ></A
 521 ><H2
 522 >SIGNALS</H2
 523 ><P
 524 >To shut down an <B
 525 CLASS="COMMAND"
 526 >nmbd</B
 527 > process it is recommended
 528         that SIGKILL (-9) <EM
 529 >NOT</EM
 530 > be used, except as a last
 531         resort, as this may leave the name database in an inconsistent state.
 532         The correct way to terminate <B
 533 CLASS="COMMAND"
 534 >nmbd</B
 535 > is to send it
 536         a SIGTERM (-15) signal and wait for it to die on its own.</P
 537 ><P
 538 ><B
 539 CLASS="COMMAND"
 540 >nmbd</B
 541 > will accept SIGHUP, which will cause
 542         it to dump out it's namelists into the file <TT
 543 CLASS="FILENAME"
 544 >namelist.debug
 545         </TT
 546 > in the <TT
 547 CLASS="FILENAME"
 548 >/usr/local/samba/var/locks</TT
 549 >
 550         directory (or the <TT
 551 CLASS="FILENAME"
 552 >var/locks</TT
 553 > directory configured
 554         under wherever Samba was configured to install itself). This will also
 555         cause <B
 556 CLASS="COMMAND"
 557 >nmbd</B
 558 > to dump out it's server database in
 559         the <TT
 560 CLASS="FILENAME"
 561 >log.nmb</TT
 562 > file. In addition, the debug log level
 563         of nmbd may be raised by sending it a SIGUSR1 (<B
 564 CLASS="COMMAND"
 565 >kill -USR1
 566         &#60;nmbd-pid&#62;</B
 567 >) and lowered by sending it a
 568         SIGUSR2 (<B
 569 CLASS="COMMAND"
 570 >kill -USR2 &#60;nmbd-pid&#62;</B
 571 >). This is to
 572         allow transient problems to be diagnosed, whilst still running at a
 573         normally low log level.</P
 574 ></DIV
 575 ><DIV
 576 CLASS="REFSECT1"
 577 ><A
 578 NAME="AEN186"
 579 ></A
 580 ><H2
 581 >VERSION</H2
 582 ><P
 583 >This man page is correct for version 2.2 of
 584         the Samba suite.</P
 585 ></DIV
 586 ><DIV
 587 CLASS="REFSECT1"
 588 ><A
 589 NAME="AEN189"
 590 ></A
 591 ><H2
 592 >SEE ALSO</H2
 593 ><P
 594 ><B
 595 CLASS="COMMAND"
 596 >inetd(8)</B
 597 >, <A
 598 HREF="smbd.8.html"
 599 TARGET="_top"
 600 ><B
 601 CLASS="COMMAND"
 602 >smbd(8)</B
 603 ></A
 604 >,
 605         <A
 606 HREF="smb.conf.5.html"
 607 TARGET="_top"
 608 ><TT
 609 CLASS="FILENAME"
 610 >smb.conf(5)</TT
 611 >
 612         </A
 613 >, <A
 614 HREF="smbclient.1.html"
 615 TARGET="_top"
 616 ><B
 617 CLASS="COMMAND"
 618 >smbclient(1)
 619         </B
 620 ></A
 621 >, <A
 622 HREF="testparm.1.html"
 623 TARGET="_top"
 624 ><B
 625 CLASS="COMMAND"
 626 >       testparm(1)</B
 627 ></A
 628 >, <A
 629 HREF="testprns.1.html"
 630 TARGET="_top"
 631 >       <B
 632 CLASS="COMMAND"
 633 >testprns(1)</B
 634 ></A
 635 >, and the Internet RFC's
 636         <TT
 637 CLASS="FILENAME"
 638 >rfc1001.txt</TT
 639 >, <TT
 640 CLASS="FILENAME"
 641 >rfc1002.txt</TT
 642 >.
 643         In addition the CIFS (formerly SMB) specification is available
 644         as a link from the Web page <A
 645 HREF="http://samba.org/cifs/"
 646 TARGET="_top"
 647 >
 648         http://samba.org/cifs/</A
 649 >.</P
 650 ></DIV
 651 ><DIV
 652 CLASS="REFSECT1"
 653 ><A
 654 NAME="AEN206"
 655 ></A
 656 ><H2
 657 >AUTHOR</H2
 658 ><P
 659 >The original Samba software and related utilities
 660         were created by Andrew Tridgell. Samba is now developed
 661         by the Samba Team as an Open Source project similar
 662         to the way the Linux kernel is developed.</P
 663 ><P
 664 >The original Samba man pages were written by Karl Auer.
 665         The man page sources were converted to YODL format (another
 666         excellent piece of Open Source software, available at
 667         <A
 668 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
 669 TARGET="_top"
 670 >       ftp://ftp.icce.rug.nl/pub/unix/</A
 671 >) and updated for the Samba 2.0
 672         release by Jeremy Allison.  The conversion to DocBook for
 673         Samba 2.2 was done by Gerald Carter</P
 674 ></DIV
 675 ></BODY
 676 ></HTML
 677 >