| blob | 8d52587c3f4a51b0e2b4764a4fa2e3971272dda7 |
1 .TH NMBD 8 "30 Jan 2001" "nmbd 2.2.0-alpha2"
2 .PP
3 .SH "NAME"
4 nmbd \- NetBIOS name server to provide NetBIOS over IP
5 naming services to clients
6 .PP
7 .SH "SYNOPSIS"
8 .PP
9 \fBnmbd\fP [-D] [-a] [-o] [-h] [-V] [-H lmhosts file] [-d debuglevel] [-l log file basename] [-n primary NetBIOS name] [-p port number] [-s configuration file]
10 .PP
11 .SH "DESCRIPTION"
12 .PP
13 This program is part of the \fBSamba\fP suite\&.
14 .PP
15 \fBnmbd\fP is a server that understands and can reply to NetBIOS over IP
16 name service requests, like those produced by SMBD/CIFS clients such
17 as Windows 95/98, Windows NT and LanManager clients\&. It also
18 participates in the browsing protocols which make up the Windows
19 "Network Neighborhood" view\&.
20 .PP
21 SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS
22 server\&. That is, they wish to know what IP number a specified host is
23 using\&.
24 .PP
25 Amongst other services, \fBnmbd\fP will listen for such requests,
26 and if its own NetBIOS name is specified it will respond with the IP
27 number of the host it is running on\&. Its "own NetBIOS name" is by
28 default the primary DNS name of the host it is running on, but this
29 can be overridden with the \fB-n\fP option (see OPTIONS below)\&. Thus
30 \fBnmbd\fP will reply to broadcast queries for its own name(s)\&. Additional
31 names for \fBnmbd\fP to respond on can be set via parameters in the
32 \fBsmb\&.conf(5)\fP configuration file\&.
33 .PP
34 \fBnmbd\fP can also be used as a WINS (Windows Internet Name Server)
35 server\&. What this basically means is that it will act as a WINS
36 database server, creating a database from name registration requests
37 that it receives and replying to queries from clients for these names\&.
38 .PP
39 In addition, \fBnmbd\fP can act as a WINS proxy, relaying broadcast queries
40 from clients that do not understand how to talk the WINS protocol to a
41 WIN server\&.
42 .PP
43 .SH "OPTIONS"
44 .PP
45 .IP
46 .IP "\fB-D\fP"
47 If specified, this parameter causes \fBnmbd\fP to operate
48 as a daemon\&. That is, it detaches itself and runs in the background,
49 fielding requests on the appropriate port\&. By default, \fBnmbd\fP will
50 NOT operate as a daemon\&. nmbd can also be operated from the inetd
51 meta-daemon, although this is not recommended\&.
52 .IP
53 .IP "\fB-a\fP"
54 If this parameter is specified, each new connection will
55 append log messages to the log file\&. This is the default\&.
56 .IP
57 .IP "\fB-o\fP"
58 If this parameter is specified, the log files will be
59 overwritten when opened\&. By default, the log files will be appended
60 to\&.
61 .IP
62 .IP "\fB-h\fP"
63 Prints the help information (usage) for \fBnmbd\fP\&.
64 .IP
65 .IP "\fB-V\fP"
66 Prints the version number for \fBnmbd\fP\&.
67 .IP
68 .IP "\fB-H filename\fP"
69 NetBIOS lmhosts file\&.
70 .IP
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 \fBname resolve order\fP described in
74 \fBsmb\&.conf (5)\fP to resolve any
75 NetBIOS name queries needed by the server\&. Note that the contents of
76 this file are \fINOT\fP used by \fBnmbd\fP to answer any name queries\&. Adding
77 a line to this file affects name NetBIOS resolution from this host
78 \fIONLY\fP\&.
79 .IP
80 The default path to this file is compiled into Samba as part of the
81 build process\&. Common defaults are \fI/usr/local/samba/lib/lmhosts\fP,
82 \fI/usr/samba/lib/lmhosts\fP or \fI/etc/lmhosts\fP\&. See the
83 \fBlmhosts (5)\fP man page for details on the contents of this file\&.
84 .IP
85 .IP "\fB-d debuglevel\fP"
86 debuglevel is an integer from 0 to 10\&.
87 .IP
88 The default value if this parameter is not specified is zero\&.
89 .IP
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 .IP
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 .IP
101 Note that specifying this parameter here will override the \fBlog
102 level\fP parameter in the \fBsmb\&.conf
103 (5)\fP file\&.
104 .IP
105 .IP "\fB-l logfile\fP"
106 The \fB-l\fP 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 .IP
113 The default log file path is compiled into Samba as part of the
114 build process\&. Common defaults are \fI/usr/local/samba/var/log\&.nmb\fP,
115 \fI/usr/samba/var/log\&.nmb\fP or \fI/var/log/log\&.nmb\fP\&.
116 .IP
117 .IP "\fB-n primary NetBIOS name\fP"
118 This option allows you to override
119 the NetBIOS name that Samba uses for itself\&. This is identical to
120 setting the \fBNetBIOS name\fP parameter
121 in the \fBsmb\&.conf\fP file
122 but will override the setting in the \fBsmb\&.conf\fP file\&.
123 .IP
124 .IP "\fB-p UDP port number\fP"
125 UDP port number is a positive integer value\&.
126 .IP
127 This option changes the default UDP port number (normally 137) that
128 \fBnmbd\fP 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 .IP
131 .IP "\fB-s configuration file\fP"
132 The default configuration file name is
133 set at build time, typically as \fI/usr/local/samba/lib/smb\&.conf\fP, but
134 this may be changed when Samba is autoconfigured\&.
135 .IP
136 The file specified contains the configuration details required by the
137 server\&. See \fBsmb\&.conf (5)\fP for more information\&.
138 .IP
139 .PP
140 .SH "FILES"
141 .PP
142 \fB/etc/inetd\&.conf\fP
143 .PP
144 If the server is to be run by the inetd meta-daemon, this file must
145 contain suitable startup information for the meta-daemon\&.
146 .PP
147 \fB/etc/rc\fP
148 .PP
149 (or whatever initialization script your system uses)\&.
150 .PP
151 If running the server as a daemon at startup, this file will need to
152 contain an appropriate startup sequence for the server\&.
153 .PP
154 \fB/usr/local/samba/lib/smb\&.conf\fP
155 .PP
156 This is the default location of the
157 \fBsmb\&.conf\fP server configuration
158 file\&. Other common places that systems install this file are
159 \fI/usr/samba/lib/smb\&.conf\fP and \fI/etc/smb\&.conf\fP\&.
160 .PP
161 When run as a \fBWINS\fP server (see the \fBwins support\fP
162 parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
163 store the WINS database in the file \f(CWwins\&.dat\fP in the \f(CWvar/locks\fP directory
164 configured under wherever Samba was configured to install itself\&.
165 .PP
166 If \fBnmbd\fP is acting as a \fBbrowse master\fP (see the \fBlocal master\fP
167 parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
168 store the browsing database in the file \f(CWbrowse\&.dat\fP in the \f(CWvar/locks\fP directory
169 configured under wherever Samba was configured to install itself\&.
170 .PP
171 .SH "SIGNALS"
172 .PP
173 To shut down an \fBnmbd\fP process it is recommended that SIGKILL (-9)
174 \fINOT\fP be used, except as a last resort, as this may leave the name
175 database in an inconsistent state\&. The correct way to terminate
176 \fBnmbd\fP is to send it a SIGTERM (-15) signal and wait for it to die on
177 its own\&.
178 .PP
179 \fBnmbd\fP will accept SIGHUP, which will cause it to dump out it\'s
180 namelists into the file \f(CWnamelist\&.debug\fP in the
181 \fI/usr/local/samba/var/locks\fP directory (or the \fIvar/locks\fP
182 directory configured under wherever Samba was configured to install
183 itself)\&. This will also cause \fBnmbd\fP to dump out it\'s server database in
184 the log\&.nmb file\&. In addition, the debug log level of nmbd may be raised
185 by sending it a SIGUSR1 (\f(CWkill -USR1 <nmbd-pid>\fP) and lowered by sending it a
186 SIGUSR2 (\f(CWkill -USR2 <nmbd-pid>\fP)\&. This is to allow transient
187 problems to be diagnosed, whilst still running at a normally low log
188 level\&.
189 .PP
190 .SH "VERSION"
191 .PP
192 This man page is correct for version 2\&.0 of the Samba suite\&.
193 .PP
194 .SH "SEE ALSO"
195 .PP
196 \fBinetd (8)\fP, \fBsmbd (8)\fP, \fBsmb\&.conf
197 (5)\fP, \fBsmbclient (1)\fP,
198 \fBtestparm (1)\fP, \fBtestprns
199 (1)\fP, and the Internet RFC\'s \fBrfc1001\&.txt\fP,
200 \fBrfc1002\&.txt\fP\&. In addition the CIFS (formerly SMB) specification is
201 available as a link from the Web page :
202 http://samba\&.org/cifs/\&.
203 .PP
204 .SH "AUTHOR"
205 .PP
206 The original Samba software and related utilities were created by
207 Andrew Tridgell samba@samba\&.org\&. Samba is now developed
208 by the Samba Team as an Open Source project similar to the way the
209 Linux kernel is developed\&.
210 .PP
211 The original Samba man pages were written by Karl Auer\&. The man page
212 sources were converted to YODL format (another excellent piece of Open
213 Source software, available at
214 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
215 and updated for the Samba2\&.0 release by Jeremy Allison\&.
216 samba@samba\&.org\&.
217 .PP
218 See \fBsamba (7)\fP to find out how to get a full
219 list of contributors and details on how to submit bug reports,
220 comments etc\&.