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(-o)(minuso)] [link(-a)(minusa)] [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)] [link(-h)(minush)]
  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 filename)) NetBIOS lmhosts file.
  70
  71 The lmhosts file is a list of NetBIOS names to IP addresses that is
  72 loaded by the nmbd server and used via the name resolution mechanism
  73 url(bf(name resolve order))(smb.conf.5.html#nameresolveorder) described in
  74 url(bf(smb.conf (5)))(smb.conf.5.html) to resolve any
  75 NetBIOS name queries needed by the server. Note that the contents of
  76 this file are em(NOT) used by bf(nmbd) to answer any name queries. Adding
  77 a line to this file affects name NetBIOS resolution from this host
  78 em(ONLY).
  79
  80 The default path to this file is compiled into Samba as part of the
  81 build process. Common defaults are em(/usr/local/samba/lib/lmhosts),
  82 em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the
  83 url(bf(lmhosts (5)))(lmhosts.5.html) man page for details on the contents of this file.
  84
  85 label(minusd)
  86 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
  87
  88 The default value if this parameter is not specified is zero.
  89
  90 The higher this value, the more detail will be logged to the log files
  91 about the activities of the server. At level 0, only critical errors
  92 and serious warnings will be logged. Level 1 is a reasonable level for
  93 day to day running - it generates a small amount of information about
  94 operations carried out.
  95
  96 Levels above 1 will generate considerable amounts of log data, and
  97 should only be used when investigating a problem. Levels above 3 are
  98 designed for use only by developers and generate HUGE amounts of log
  99 data, most of which is extremely cryptic.
 100
 101 Note that specifying this parameter here will override the url(bf(log
 102 level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf
 103 (5)))(smb.conf.5.html) file.
 104
 105 label(minusl)
 106 dit(bf(-l logfile)) The bf(-l) parameter specifies a path and base
 107 filename into which operational data from the running nmbd server will
 108 be logged.  The actual log file name is generated by appending the
 109 extension ".nmb" to the specified base name.  For example, if the name
 110 specified was "log" then the file log.nmb would contain the debugging
 111 data.
 112
 113 The default log file path is compiled into Samba as part of the
 114 build process. Common defaults are em(/usr/local/samba/var/log.nmb),
 115 em(/usr/samba/var/log.nmb) or em(/var/log/log.nmb).
 116
 117 label(minusn)
 118 dit(bf(-n primary NetBIOS name)) This option allows you to override
 119 the NetBIOS name that Samba uses for itself. This is identical to
 120 setting the url(bf(NetBIOS name))(smb.conf.5.html#netbiosname) parameter
 121 in the url(bf(smb.conf))(smb.conf.5.html) file
 122 but will override the setting in the url(bf(smb.conf))(smb.conf.5.html) file.
 123
 124 label(minusp)
 125 dit(bf(-p UDP port number)) UDP port number is a positive integer value.
 126
 127 This option changes the default UDP port number (normally 137) that
 128 bf(nmbd) responds to name queries on. Don't use this option unless you are
 129 an expert, in which case you won't need help!
 130
 131 label(minuss)
 132 dit(bf(-s configuration file)) The default configuration file name is
 133 set at build time, typically as em(/usr/local/samba/lib/smb.conf), but
 134 this may be changed when Samba is autoconfigured.
 135
 136 The file specified contains the configuration details required by the
 137 server. See url(bf(smb.conf (5)))(smb.conf.5.html) for more information.
 138
 139 label(minusi)
 140 dit(bf(-i scope)) This specifies a NetBIOS scope that bf(nmbd) will use
 141 to communicate with when generating NetBIOS names. For details on the
 142 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
 143 are em(very) rarely used, only set this parameter if you are the
 144 system administrator in charge of all the NetBIOS systems you
 145 communicate with.
 146
 147 label(minush)
 148 dit(bf(-h)) Prints the help information (usage) for bf(nmbd).
 149
 150 endit()
 151
 152 label(FILES)
 153 manpagefiles()
 154
 155 bf(/etc/inetd.conf)
 156
 157 If the server is to be run by the inetd meta-daemon, this file must
 158 contain suitable startup information for the meta-daemon.
 159
 160 bf(/etc/rc)
 161
 162 (or whatever initialization script your system uses).
 163
 164 If running the server as a daemon at startup, this file will need to
 165 contain an appropriate startup sequence for the server.
 166
 167 bf(/usr/local/samba/lib/smb.conf)
 168
 169 This is the default location of the
 170 url(bf(smb.conf))(smb.conf.5.html) server configuration
 171 file. Other common places that systems install this file are
 172 em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
 173
 174 When run as a bf(WINS) server (see the url(bf(wins support))(smb.conf.5.html#winssupport)
 175 parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) man page), bf(nmbd) will
 176 store the WINS database in the file tt(wins.dat) in the tt(var/locks) directory
 177 configured under wherever Samba was configured to install itself.
 178
 179 If bf(nmbd) is acting as a bf(browse master) (see the url(bf(local master))(smb.conf.5.html#localmaster)
 180 parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) man page), bf(nmbd) will
 181 store the browsing database in the file tt(browse.dat) in the tt(var/locks) directory
 182 configured under wherever Samba was configured to install itself.
 183
 184 label(SIGNALS)
 185 manpagesection(SIGNALS)
 186
 187 To shut down an bf(nmbd) process it is recommended that SIGKILL (-9)
 188 em(NOT) be used, except as a last resort, as this may leave the name
 189 database in an inconsistent state. The correct way to terminate
 190 bf(nmbd) is to send it a SIGTERM (-15) signal and wait for it to die on
 191 its own.
 192
 193 bf(nmbd) will accept SIGHUP, which will cause it to dump out it's
 194 namelists into the file tt(namelist.debug) in the
 195 em(/usr/local/samba/var/locks) directory (or the em(var/locks)
 196 directory configured under wherever Samba was configured to install
 197 itself). This will also cause bf(nmbd) to dump out it's server database in
 198 the log.nmb file. In addition, the debug log level of nmbd may be raised
 199 by sending it a SIGUSR1 (tt(kill -USR1 <nmbd-pid>)) and lowered by sending it a
 200 SIGUSR2 (tt(kill -USR2 <nmbd-pid>)). This is to allow transient
 201 problems to be diagnosed, whilst still running at a normally low log
 202 level.
 203
 204 label(VERSION)
 205 manpagesection(VERSION)
 206
 207 This man page is correct for version 2.0 of the Samba suite.
 208
 209 label(SEEALSO)
 210 manpageseealso()
 211
 212 bf(inetd (8)), url(bf(smbd (8)))(smbd.8.html), url(bf(smb.conf
 213 (5)))(smb.conf.5.html), url(bf(smbclient (1)))(smbclient.1.html),
 214 url(bf(testparm (1)))(testparm.1.html), url(bf(testprns
 215 (1)))(testprns.1.html), and the Internet RFC's bf(rfc1001.txt),
 216 bf(rfc1002.txt). In addition the CIFS (formerly SMB) specification is
 217 available as a link from the Web page :
 218 url(http://samba.org/cifs/)(http://samba.org/cifs/).
 219
 220 label(AUTHOR)
 221 manpageauthor()
 222
 223 The original Samba software and related utilities were created by
 224 Andrew Tridgell email(samba-bugs@samba.org). Samba is now developed
 225 by the Samba Team as an Open Source project similar to the way the
 226 Linux kernel is developed.
 227
 228 The original Samba man pages were written by Karl Auer. The man page
 229 sources were converted to YODL format (another excellent piece of Open
 230 Source software, available at
 231 url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
 232 and updated for the Samba2.0 release by Jeremy Allison.
 233 email(samba-bugs@samba.org).
 234
 235 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
 236 list of contributors and details on how to submit bug reports,
 237 comments etc.