diff options
| -rw-r--r-- | docs/yodldocs/nmbd.8.yo | 243 |
1 files changed, 243 insertions, 0 deletions
diff --git a/docs/yodldocs/nmbd.8.yo b/docs/yodldocs/nmbd.8.yo new file mode 100644 index 0000000000..9e6347770c --- /dev/null +++ b/docs/yodldocs/nmbd.8.yo @@ -0,0 +1,243 @@ +mailto(samba-bugs@samba.anu.edu.au) + +manpage(nmbd)(8)(23 Oct 1998)(Samba)(SAMBA) + +manpagename(nmbd)(NetBIOS name server to provide NetBIOS over IP +naming services to clients) + +manpagesynopsis() + +bf(nmbd) [-D] [-o] [-a] [-H lmhosts file] [-d debuglevel] [-l log file basename] [-n primary NetBIOS name] [-p port number] [-s configuration file] [-i NetBIOS scope] [-h] + +manpagedescription() + +This program is part of the bf(Samba) suite. + +bf(nmbd) is a server that understands and can reply to NetBIOS over IP +name service requests, like those produced by SMBD/CIFS clients such +as Windows 95/98, Windows NT and LanManager clients. It also +participates in the browsing protocols which make up the Windows +"Network Neighborhood" view. + +SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS +server. That is, they wish to know what IP number a specified host is +using. + +Amongst other services, this program will listen for such requests, +and if its own NetBIOS name is specified it will respond with the IP +number of the host it is running on. Its "own NetBIOS name" is by +default the primary DNS name of the host it is running on, but this +can be overriden with the bf(-n) option (see em(OPTIONS) below). Thus +nmbd will reply to broadcast queries for its own name(s). + +bf(nmbd) can also be used as a WINS (Windows Internet Name Server) +server. What this basically means is that it will act as a WINS database +server, responding to all name registration requests that it receives that are not broadcasts, as long as it can +resolve the name. Resolvable names include all names in the NetBIOS +hosts file (if any, see .B \-H below), its own name, and any other +names that it may have learned about from other browsers on the +network. A change to previous versions is that nmbd will now no +longer do this automatically by default. + +.SH OPTIONS +.B \-B + +.RS 3 +This option is obsolete. Please use the "interfaces" option in smb.conf instead. +.RE + +.B \-I + +.RS 3 +This option is obsolete. Please use the "interfaces" option in smb.conf instead. +.RE + +.B \-D + +.RS 3 +If specified, this parameter causes the server to operate as a daemon. That is, +it detaches itself and runs in the background, fielding requests on the +appropriate port. + +By default, the server will NOT operate as a daemon. +.RE + +.B \-C comment string + +.RS 3 +This option is obsolete. Please use the "server string" option in smb.conf +instead. +.RE + +.B \-G + +.RS 3 +This option is obsolete. Please use the "workgroup" option in smb.conf instead. +.RE + +.B \-H +.I NetBIOS hosts file + +.RS 3 +It may be useful in some situations to be able to specify a list of +NetBIOS names for which the server should send a reply if queried. +This option allows you to specify a file containing such a list. +The syntax of the hosts file is similar to the standard /etc/hosts file +format, but has some extensions. + +The file contains three columns. Lines beginning with a # are ignored +as comments. The first column is an IP address, or a hostname. If it +is a hostname then it is interpreted as the IP address returned by +gethostbyname() when read. An IP address of 0.0.0.0 will be +interpreted as the server's own IP address. + +The second column is a NetBIOS name. This is the name that the server +will respond to. It must be less than 20 characters long. + +The third column is optional, and is intended for flags. Currently the +only flag supported is M, which means that this name is the default +NetBIOS name for this machine. This has the same effect as specifying the +.B \-n +option to +.BR nmbd . + +NOTE: The G and S flags are now obsolete and are replaced by the +"interfaces" and "remote announce" options in smb.conf. + +The default hosts file name is set at compile time, typically as +.I /etc/lmhosts, +but this may be changed in the Samba Makefile. + +After startup the server waits for queries, and will answer queries for +any name known to it. This includes all names in the NetBIOS hosts file, +its own name, and any other names it may have learned about from other +browsers on the network. + +The primary intention of the +.B \-H +option is to allow a mapping from NetBIOS names to internet domain names. + +.B Example: + + # This is a sample NetBIOS hosts file + + # DO NOT USE THIS FILE AS-IS + # YOU MAY INCONVENIENCE THE OWNERS OF THESE IPs + # if you want to include a name with a space in it then + # use double quotes. + + # next add a NetBIOS alias for a faraway host + arvidsjaur.anu.edu.au ARVIDSJAUR + + # finally put in an IP for a hard to find host + 130.45.3.213 FREDDY + +.RE +.B \-N + +.RS 3 +This option is obsolete. Please use the "interfaces" option in smb.conf instead. +.RE + +.B \-d +.I debuglevel + +.RS 3 +This option sets the debug level. See +.BR smb.conf (5). +.RE + +.B \-l +.I log file + +.RS 3 +The +.I log file +parameter specifies a path and base filename into which operational data +from the running +.B nmbd +server will be logged. +The actual log file name is generated by appending the extension ".nmb" to +the specified base name. +For example, if the name specified was "log" then the file log.nmb would +contain the debugging data. + +The default log file is specified at compile time, typically as +.I /var/log/log.nmb. +.RE + +.B \-n +.I NetBIOS name + +.RS 3 +This option allows you to override the NetBIOS name that Samba uses for itself. +.RE + +.B \-a + +.RS 3 +If this parameter is specified, the log files will be appended to with each +new connection. This is the default. +.RE + +.B \-o + +.RS 3 +Overwrite existing log files instead of appending to them. (This was the +default until version 2.0.0.) +.RE + +.B \-p +.I port number +.RS 3 + +port number is a positive integer value. + +Don't use this option unless you are an expert, in which case you +won't need help! +.RE + +.B \-s +.I configuration file + +.RS 3 +The default configuration file name is set at compile time, typically as +.I /etc/smb.conf, +but this may be changed in the Samba Makefile. + +The file specified contains the configuration details required by the server. +See +.BR smb.conf (5) +for more information. +.RE +.SH SIGNALS + +In version 1.9.18 and above, nmbd will accept SIGHUP, which will cause it to dump out +it's namelists into the file namelist.debug in the SAMBA/var/locks directory. This +will also cause nmbd to dump out it's server database in the log.nmb file. +Also new in version 1.9.18 and above is the ability to raise the debug log +level of nmbd by sending it a SIGUSR1 (kill -USR1 <nmbd-pid>) and to lower +the nmbd log level by sending it a SIGUSR2 (kill -USR2 <nmbd-pid>). This +is to allow transient problems to be diagnosed, whilst still running at +a normally low log level. + +.SH VERSION + +This man page is (mostly) correct for version 1.9.16 of the Samba +suite, plus some of the recent patches to it. These notes will +necessarily lag behind development of the software, so it is possible +that your version of the server has extensions or parameter semantics +that differ from or are not covered by this man page. Please notify +these to the address below for rectification. +.SH SEE ALSO +.BR inetd (8), +.BR smbd (8), +.BR smb.conf (5), +.BR smbclient (1), +.BR testparm (1), +.BR testprns (1) +.SH CREDITS +The original Samba software and related utilities were created by +Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper +of the Source for this project. + |