42fb0b38766533bd5d07417af0c5ea80c8c46775
[samba.git] / docs / yodldocs / nmbd.8.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
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) [-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]
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, this program 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 overriden with the bf(-n) option (see em(OPTIONS) below). Thus
34 nmbd will reply to broadcast queries for its own name(s). Additional
35 names for nmbd to respond on can be set via parameters in the
36 bf(smb.conf (5)) configuration file.
37
38 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, 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 dit(bf(-D)) If specified, this parameter causes the server to operate
53 as a daemon. That is, it detaches itself and runs in the background,
54 fielding requests on the appropriate port. By default, the server will
55 NOT operate as a daemon. nmbd can also be operated from the inetd
56 meta-daemon, although this is not recommended.
57
58 dit(bf(-a)) If this parameter is specified, each new connection will
59 append log messages to the log file.  This is the default.
60
61 dit(bf(-o)) If this parameter is specified, the log files will be
62 overwritten when opened.  By default, the log files will be appended
63 to.
64
65 dit(bf(-H filename)) NetBIOS lmhosts file.
66
67 The lmhosts file is a list of NetBIOS names to IP addresses that is
68 loaded by the nmbd server and used via the name resolution mechanism
69 em(name resolve order) described in bf(smbd.conf (5)) to resolve any
70 NetBIOS name queries needed by the server. Note that the contents of
71 this file are em(NOT) used by nmbd to answer any name queries, adding
72 a line to this file affects name NetBIOS resolution from this host
73 em(ONLY).
74
75 The default path to this file is compiled into Samba as part of the
76 build process. Common defaults are em(/usr/local/samba/lib/lmhosts),
77 em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the bf(lmhosts
78 (5)) man page for details on the contents of this file.
79
80 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
81
82 The default value if this parameter is not specified is zero.
83
84 The higher this value, the more detail will be logged to the log files
85 about the activities of the server. At level 0, only critical errors
86 and serious warnings will be logged. Level 1 is a reasonable level for
87 day to day running - it generates a small amount of information about
88 operations carried out.
89
90 Levels above 1 will generate considerable amounts of log data, and
91 should only be used when investigating a problem. Levels above 3 are
92 designed for use only by developers and generate HUGE amounts of log
93 data, most of which is extremely cryptic.
94
95 dit(bf(-l logfile)) The bf(-l) parameter specifies a path and base
96 filename into which operational data from the running nmbd server will
97 be logged.  The actual log file name is generated by appending the
98 extension ".nmb" to the specified base name.  For example, if the name
99 specified was "log" then the file log.nmb would contain the debugging
100 data.
101
102 The default log file path is is compiled into Samba as part of the
103 build process. Common defaults are em(/usr/local/samba/var/log.nmb),
104 em(/usr/samba/var/log.nmb) or em(/var/log/log.nmb).
105
106 dit(bf(-n primary NetBIOS name)) This option allows you to override
107 the NetBIOS name that Samba uses for itself. This is identical to
108 setting the bf(NetBIOS name) parameter in the smb.conf file
109 but will override the setting in the smb.conf file.
110
111 dit(bf(-p UDP port number)) UDP port number is a positive integer value.
112
113 This option changes the default UDP port number (normally 137) that
114 nmbd responds to name queries on. Don't use this option unless you are
115 an expert, in which case you won't need help!
116
117 dit(bf(-s configuration file)) The default configuration file name is
118 set at build time, typically as em(/usr/local/samba/lib/smb.conf), but
119 this may be changed when Samba is autoconfigured.
120
121 The file specified contains the configuration details required by the
122 server.  See bf(smb.conf (5)) for more information.
123
124 dit(bf(-i scope)) This specifies a NetBIOS scope that the server will use
125 to communicate with when generating NetBIOS names. For details on the
126 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
127 are em(very) rarely used, only set this parameter if you are the
128 system administrator in charge of all the NetBIOS systems you
129 communicate with.
130
131 dit(bf(-h)) Prints the help information (usage) for nmbd.
132
133 endit()
134
135 label(FILES)
136 manpagefiles()
137
138 bf(/etc/inetd.conf)
139
140 If the server is to be run by the inetd meta-daemon, this file must
141 contain suitable startup information for the meta-daemon.
142
143 bf(/etc/rc)
144
145 (or whatever initialisation script your system uses).
146
147 If running the server as a daemon at startup, this file will need to
148 contain an appropriate startup sequence for the server.
149
150 bf(/usr/local/samba/lib/smb.conf)
151
152 This is the default location of the em(smb.conf) server configuration
153 file. Other common places that systems install this file are
154 em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
155
156 label(SIGNALS)
157 manpagesection(SIGNALS)
158
159 nmbd will accept SIGHUP, which will cause it to dump out it's
160 namelists into the file namelist.debug in the
161 em(/usr/local/samba/var/locks) directory (or the em(var/locks)
162 directory configured under wherever Samba was configured to install
163 itself). This will also cause nmbd to dump out it's server database in
164 the log.nmb file.  Also new in version 1.9.18 and above is the ability
165 to raise the debug log level of nmbd by sending it a SIGUSR1 (tt(kill
166 -USR1 <nmbd-pid>)) and to lower the nmbd log level by sending it a
167 SIGUSR2 (tt(kill -USR2 <nmbd-pid>)). This is to allow transient
168 problems to be diagnosed, whilst still running at a normally low log
169 level.
170
171 label(VERSION)
172 manpagesection(VERSION)
173
174 This man page is correct for version 2.0 of the Samba suite.
175
176 label(SEEALSO)
177 manpageseealso()
178
179 bf(inetd (8)), url(bf(smbd (8)))(smbd.8.html), url(bf(smb.conf
180 (5)))(smb.conf.5.html), url(bf(smbclient (1)))(smbclient.1.html),
181 url(bf(testparm (1)))(testparm.1.html), url(bf(testprns
182 (1)))(testprns.1.html), and the Internet RFC's bf(rfc1001.txt),
183 bf(rfc1002.txt). In addition the CIFS (formerly SMB) specification is
184 available as a link from the Web page :
185 url(http://samba.anu.edu.au/cifs/)(http://samba.anu.edu.au/cifs/).
186
187 label(AUTHOR)
188 manpageauthor()
189
190 The original Samba software and related utilities were created by
191 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
192 by the Samba Team as an Open Source project similar to the way the
193 Linux kernel is developed.
194
195 The original Samba man pages were written by Karl Auer. The man page
196 sources were converted to YODL format (another excellent piece of Open
197 Source software) and updated for the Samba2.0 release by Jeremy
198 Allison, email(samba-bugs@samba.anu.edu.au).
199
200 See url(bf(samba (7)))(samba.7.html) to find out how to get a full list of contributors
201 and details on how to submit bug reports, comments etc.