docs/yodldocs/nmbd.8.yo

   1 mailto(samba-bugs@samba.org)
   2
   3 manpage(nmbd)(8)(23 Oct 1998)(Samba)(SAMBA)
   4
   5 label(NAME)
   6 manpagename(nmbd)(NetBIOS name server to provide NetBIOS over IP
   7 naming services to clients)
   8
   9 label(SYNOPSIS)
  10 manpagesynopsis()
  11
  12 bf(nmbd) [link(-D)(minusD)] [link(-a)(minusa)] [link(-o)(minuso)] [link(-h)(minush)] [link(-V)(minusV)] [link(-H lmhosts file)(minusH)] [link(-d debuglevel)(minusd)] [link(-l log file basename)(minusl)] [link(-n primary NetBIOS name)(minusn)] [link(-p port number)(minusp)] [link(-s configuration file)(minuss)] [link(-i NetBIOS scope)(minusi)]
  13
  14 label(DESCRIPTION)
  15 manpagedescription()
  16
  17 This program is part of the bf(Samba) suite.
  18
  19 bf(nmbd) is a server that understands and can reply to NetBIOS over IP
  20 name service requests, like those produced by SMBD/CIFS clients such
  21 as Windows 95/98, Windows NT and LanManager clients. It also
  22 participates in the browsing protocols which make up the Windows
  23 "Network Neighborhood" view.
  24
  25 SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS
  26 server. That is, they wish to know what IP number a specified host is
  27 using.
  28
  29 Amongst other services, bf(nmbd) will listen for such requests,
  30 and if its own NetBIOS name is specified it will respond with the IP
  31 number of the host it is running on.  Its "own NetBIOS name" is by
  32 default the primary DNS name of the host it is running on, but this
  33 can be overridden with the bf(-n) option (see link(OPTIONS)(OPTIONS) below). Thus
  34 bf(nmbd) will reply to broadcast queries for its own name(s). Additional
  35 names for bf(nmbd) to respond on can be set via parameters in the
  36 url(bf(smb.conf(5)))(smb.conf.5.html) configuration file.
  37
  38 bf(nmbd) can also be used as a WINS (Windows Internet Name Server)
  39 server. What this basically means is that it will act as a WINS
  40 database server, creating a database from name registration requests
  41 that it receives and replying to queries from clients for these names.
  42
  43 In addition, bf(nmbd) can act as a WINS proxy, relaying broadcast queries
  44 from clients that do not understand how to talk the WINS protocol to a
  45 WIN server.
  46
  47 label(OPTIONS)
  48 manpageoptions()
  49
  50 startdit()
  51
  52 label(minusD)
  53 dit(bf(-D)) If specified, this parameter causes bf(nmbd) to operate
  54 as a daemon. That is, it detaches itself and runs in the background,
  55 fielding requests on the appropriate port. By default, bf(nmbd) will
  56 NOT operate as a daemon. nmbd can also be operated from the inetd
  57 meta-daemon, although this is not recommended.
  58
  59 label(minusa)
  60 dit(bf(-a)) If this parameter is specified, each new connection will
  61 append log messages to the log file.  This is the default.
  62
  63 label(minuso)
  64 dit(bf(-o)) If this parameter is specified, the log files will be
  65 overwritten when opened.  By default, the log files will be appended
  66 to.
  67
  68 label(minush)
  69 dit(bf(-h)) Prints the help information (usage) for bf(nmbd).
  70
  71 label(minusV)
  72 dit(bf(-V)) Prints the version number for bf(nmbd).
  73
  74 label(minusH)
  75 dit(bf(-H filename)) NetBIOS lmhosts file.
  76
  77 The lmhosts file is a list of NetBIOS names to IP addresses that is
  78 loaded by the nmbd server and used via the name resolution mechanism
  79 url(bf(name resolve order))(smb.conf.5.html#nameresolveorder) described in
  80 url(bf(smb.conf (5)))(smb.conf.5.html) to resolve any
  81 NetBIOS name queries needed by the server. Note that the contents of
  82 this file are em(NOT) used by bf(nmbd) to answer any name queries. Adding
  83 a line to this file affects name NetBIOS resolution from this host
  84 em(ONLY).
  85
  86 The default path to this file is compiled into Samba as part of the
  87 build process. Common defaults are em(/usr/local/samba/lib/lmhosts),
  88 em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the
  89 url(bf(lmhosts (5)))(lmhosts.5.html) man page for details on the contents of this file.
  90
  91 label(minusd)
  92 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
  93
  94 The default value if this parameter is not specified is zero.
  95
  96 The higher this value, the more detail will be logged to the log files
  97 about the activities of the server. At level 0, only critical errors
  98 and serious warnings will be logged. Level 1 is a reasonable level for
  99 day to day running - it generates a small amount of information about
 100 operations carried out.
 101
 102 Levels above 1 will generate considerable amounts of log data, and
 103 should only be used when investigating a problem. Levels above 3 are
 104 designed for use only by developers and generate HUGE amounts of log
 105 data, most of which is extremely cryptic.
 106
 107 Note that specifying this parameter here will override the url(bf(log
 108 level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf
 109 (5)))(smb.conf.5.html) file.
 110
 111 label(minusl)
 112 dit(bf(-l logfile)) The bf(-l) parameter specifies a path and base
 113 filename into which operational data from the running nmbd server will
 114 be logged.  The actual log file name is generated by appending the
 115 extension ".nmb" to the specified base name.  For example, if the name
 116 specified was "log" then the file log.nmb would contain the debugging
 117 data.
 118
 119 The default log file path is compiled into Samba as part of the
 120 build process. Common defaults are em(/usr/local/samba/var/log.nmb),
 121 em(/usr/samba/var/log.nmb) or em(/var/log/log.nmb).
 122
 123 label(minusn)
 124 dit(bf(-n primary NetBIOS name)) This option allows you to override
 125 the NetBIOS name that Samba uses for itself. This is identical to
 126 setting the url(bf(NetBIOS name))(smb.conf.5.html#netbiosname) parameter
 127 in the url(bf(smb.conf))(smb.conf.5.html) file
 128 but will override the setting in the url(bf(smb.conf))(smb.conf.5.html) file.
 129
 130 label(minusp)
 131 dit(bf(-p UDP port number)) UDP port number is a positive integer value.
 132
 133 This option changes the default UDP port number (normally 137) that
 134 bf(nmbd) responds to name queries on. Don't use this option unless you are
 135 an expert, in which case you won't need help!
 136
 137 label(minuss)
 138 dit(bf(-s configuration file)) The default configuration file name is
 139 set at build time, typically as em(/usr/local/samba/lib/smb.conf), but
 140 this may be changed when Samba is autoconfigured.
 141
 142 The file specified contains the configuration details required by the
 143 server. See url(bf(smb.conf (5)))(smb.conf.5.html) for more information.
 144
 145 label(minusi)
 146 dit(bf(-i scope)) This specifies a NetBIOS scope that bf(nmbd) will use
 147 to communicate with when generating NetBIOS names. For details on the
 148 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
 149 are em(very) rarely used, only set this parameter if you are the
 150 system administrator in charge of all the NetBIOS systems you
 151 communicate with.
 152
 153 endit()
 154
 155 label(FILES)
 156 manpagefiles()
 157
 158 bf(/etc/inetd.conf)
 159
 160 If the server is to be run by the inetd meta-daemon, this file must
 161 contain suitable startup information for the meta-daemon.
 162
 163 bf(/etc/rc)
 164
 165 (or whatever initialization script your system uses).
 166
 167 If running the server as a daemon at startup, this file will need to
 168 contain an appropriate startup sequence for the server.
 169
 170 bf(/usr/local/samba/lib/smb.conf)
 171
 172 This is the default location of the
 173 url(bf(smb.conf))(smb.conf.5.html) server configuration
 174 file. Other common places that systems install this file are
 175 em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
 176
 177 When run as a bf(WINS) server (see the url(bf(wins support))(smb.conf.5.html#winssupport)
 178 parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) man page), bf(nmbd) will
 179 store the WINS database in the file tt(wins.dat) in the tt(var/locks) directory
 180 configured under wherever Samba was configured to install itself.
 181
 182 If bf(nmbd) is acting as a bf(browse master) (see the url(bf(local master))(smb.conf.5.html#localmaster)
 183 parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) man page), bf(nmbd) will
 184 store the browsing database in the file tt(browse.dat) in the tt(var/locks) directory
 185 configured under wherever Samba was configured to install itself.
 186
 187 label(SIGNALS)
 188 manpagesection(SIGNALS)
 189
 190 To shut down an bf(nmbd) process it is recommended that SIGKILL (-9)
 191 em(NOT) be used, except as a last resort, as this may leave the name
 192 database in an inconsistent state. The correct way to terminate
 193 bf(nmbd) is to send it a SIGTERM (-15) signal and wait for it to die on
 194 its own.
 195
 196 bf(nmbd) will accept SIGHUP, which will cause it to dump out it's
 197 namelists into the file tt(namelist.debug) in the
 198 em(/usr/local/samba/var/locks) directory (or the em(var/locks)
 199 directory configured under wherever Samba was configured to install
 200 itself). This will also cause bf(nmbd) to dump out it's server database in
 201 the log.nmb file. In addition, the debug log level of nmbd may be raised
 202 by sending it a SIGUSR1 (tt(kill -USR1 <nmbd-pid>)) and lowered by sending it a
 203 SIGUSR2 (tt(kill -USR2 <nmbd-pid>)). This is to allow transient
 204 problems to be diagnosed, whilst still running at a normally low log
 205 level.
 206
 207 label(VERSION)
 208 manpagesection(VERSION)
 209
 210 This man page is correct for version 2.0 of the Samba suite.
 211
 212 label(SEEALSO)
 213 manpageseealso()
 214
 215 bf(inetd (8)), url(bf(smbd (8)))(smbd.8.html), url(bf(smb.conf
 216 (5)))(smb.conf.5.html), url(bf(smbclient (1)))(smbclient.1.html),
 217 url(bf(testparm (1)))(testparm.1.html), url(bf(testprns
 218 (1)))(testprns.1.html), and the Internet RFC's bf(rfc1001.txt),
 219 bf(rfc1002.txt). In addition the CIFS (formerly SMB) specification is
 220 available as a link from the Web page :
 221 url(http://samba.org/cifs/)(http://samba.org/cifs/).
 222
 223 label(AUTHOR)
 224 manpageauthor()
 225
 226 The original Samba software and related utilities were created by
 227 Andrew Tridgell email(samba-bugs@samba.org). Samba is now developed
 228 by the Samba Team as an Open Source project similar to the way the
 229 Linux kernel is developed.
 230
 231 The original Samba man pages were written by Karl Auer. The man page
 232 sources were converted to YODL format (another excellent piece of Open
 233 Source software, available at
 234 url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
 235 and updated for the Samba2.0 release by Jeremy Allison.
 236 email(samba-bugs@samba.org).
 237
 238 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
 239 list of contributors and details on how to submit bug reports,
 240 comments etc.