Debian Codegraph @

upstream/opensuse-tumbleweed/man8/nmbd.8

raw
1 '\" t
2 .\" Title: nmbd
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "NMBD" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 nmbd [\-D|\-\-daemon] [\-i|\-\-interactive] [\-F|\-\-foreground] [\-\-no\-process\-group] [\-b|\-\-build\-options] [\-p\ <port\ number(s)>] [\-P\ <profiling\ level>] [\-d\ <debug\ level>] [\-\-debug\-stdout] [\-\-configfile=<configuration\ file>] [\-\-option=<name>=<value>] [\-l|\-\-log\-basename\ <log\ directory>] [\-\-leak\-report] [\-\-leak\-report\-full] [\-V|\-\-version]
35 .SH "DESCRIPTION"
36 .PP
37 This program is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 nmbd
42 is a server that understands and can reply to NetBIOS over IP name service requests, like those produced by SMB/CIFS clients such as Windows 95/98/ME, Windows NT, Windows 2000, Windows XP and LanManager clients\&. It also participates in the browsing protocols which make up the Windows "Network Neighborhood" view\&.
43 .PP
44 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\&.
45 .PP
46 Amongst other services,
47 nmbd
48 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 overridden by the
49 \m[blue]\fBnetbios name\fR\m[]
50 in
51 /etc/samba/smb\&.conf\&. Thus
52 nmbd
53 will reply to broadcast queries for its own name(s)\&. Additional names for
54 nmbd
55 to respond on can be set via parameters in the
56 \fBsmb.conf\fR(5)
57 configuration file\&.
58 .PP
59 nmbd
60 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, creating a database from name registration requests that it receives and replying to queries from clients for these names\&.
61 .PP
62 In addition,
63 nmbd
64 can act as a WINS proxy, relaying broadcast queries from clients that do not understand how to talk the WINS protocol to a WINS server\&.
65 .SH "OPTIONS"
66 .PP
67 \-D|\-\-daemon
68 .RS 4
69 If specified, this parameter causes
70 nmbd
71 to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. By default,
72 nmbd
73 will operate as a daemon if launched from a command shell\&. nmbd can also be operated from the
74 inetd
75 meta\-daemon, although this is not recommended\&.
76 .RE
77 .PP
78 \-F|\-\-foreground
79 .RS 4
80 If specified, this parameter causes the main
81 nmbd
82 process to not daemonize, i\&.e\&. double\-fork and disassociate with the terminal\&. Child processes are still created as normal to service each connection request, but the main process does not exit\&. This operation mode is suitable for running
83 nmbd
84 under process supervisors such as
85 supervise
86 and
87 svscan
88 from Daniel J\&. Bernstein\*(Aqs
89 daemontools
90 package, or the AIX process monitor\&.
91 .RE
92 .PP
93 \-i|\-\-interactive
94 .RS 4
95 If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell\&. Setting this parameter negates the implicit daemon mode when run from the command line\&.
96 nmbd
97 also logs to standard output, as if the
98 \fB\-S\fR
99 parameter had been given\&.
100 .RE
101 .PP
102 \-H|\-\-hosts <filename>
103 .RS 4
104 NetBIOS lmhosts file\&. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name resolution mechanism
105 \m[blue]\fBname resolve order\fR\m[]
106 described in
107 \fBsmb.conf\fR(5)
108 to resolve any NetBIOS name queries needed by the server\&. Note that the contents of this file are
109 \fINOT\fR
110 used by
111 nmbd
112 to answer any name queries\&. Adding a line to this file affects name NetBIOS resolution from this host
113 \fIONLY\fR\&.
114 .sp
115 The default path to this file is compiled into Samba as part of the build process\&. Common defaults are
116 /usr/local/samba/lib/lmhosts,
117 /usr/samba/lib/lmhosts
118 or
119 /etc/samba/lmhosts\&. See the
120 \fBlmhosts\fR(5)
121 man page for details on the contents of this file\&.
122 .RE
123 .PP
124 \-p|\-\-port <UDP port number>
125 .RS 4
126 UDP port number is a positive integer value\&. This option changes the default UDP port number (normally 137) that
127 nmbd
128 responds to name queries on\&. Don\*(Aqt use this option unless you are an expert, in which case you won\*(Aqt need help!
129 .RE
130 .PP
131 \-\-no\-process\-group
132 .RS 4
133 Do not create a new process group for nmbd\&.
134 .RE
135 .PP
136 \-d|\-\-debuglevel=level
137 .RS 4
138 \fIlevel\fR
139 is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
140 .sp
141 The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
142 .sp
143 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
144 .sp
145 Note that specifying this parameter here will override the
146 \m[blue]\fBlog level\fR\m[]
147 parameter in the
148 /etc/samba/smb\&.conf
149 file\&.
150 .RE
151 .PP
152 \-\-debug\-stdout
153 .RS 4
154 This will redirect debug output to STDOUT\&. By default server daemons are logging to a log file\&.
155 .RE
156 .PP
157 \-\-configfile=CONFIGFILE
158 .RS 4
159 The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See
160 /etc/samba/smb\&.conf
161 for more information\&. The default configuration file name is determined at compile time\&.
162 .RE
163 .PP
164 \-\-option=<name>=<value>
165 .RS 4
166 Set the
167 \fBsmb.conf\fR(5)
168 option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&.
169 .RE
170 .PP
171 \-l|\-\-log\-basename=logdirectory
172 .RS 4
173 Base directory name for log/debug files\&. The extension
174 \fB"\&.progname"\fR
175 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
176 .RE
177 .PP
178 \-\-leak\-report
179 .RS 4
180 Enable talloc leak reporting on exit\&.
181 .RE
182 .PP
183 \-\-leak\-report\-full
184 .RS 4
185 Enable full talloc leak reporting on exit\&.
186 .RE
187 .PP
188 \-V|\-\-version
189 .RS 4
190 Prints the program version number\&.
191 .RE
192 .PP
193 \-?|\-\-help
194 .RS 4
195 Print a summary of command line options\&.
196 .RE
197 .PP
198 \-\-usage
199 .RS 4
200 Display brief usage message\&.
201 .RE
202 .SH "FILES"
203 .PP
204 /etc/inetd\&.conf
205 .RS 4
206 If the server is to be run by the
207 inetd
208 meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&.
209 .RE
210 .PP
211 /etc/rc
212 .RS 4
213 or whatever initialization script your system uses)\&.
214 .sp
215 If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\&.
216 .RE
217 .PP
218 /etc/services
219 .RS 4
220 If running the server via the meta\-daemon
221 inetd, this file must contain a mapping of service name (e\&.g\&., netbios\-ssn) to service port (e\&.g\&., 139) and protocol type (e\&.g\&., tcp)\&.
222 .RE
223 .PP
224 /usr/local/samba/lib/smb\&.conf
225 .RS 4
226 This is the default location of the
227 \fBsmb.conf\fR(5)
228 server configuration file\&. Other common places that systems install this file are
229 /usr/samba/lib/smb\&.conf
230 and
231 /etc/samba/smb\&.conf\&.
232 .sp
233 When run as a WINS server (see the
234 \m[blue]\fBwins support\fR\m[]
235 parameter in the
236 \fBsmb.conf\fR(5)
237 man page),
238 nmbd
239 will store the WINS database in the file
240 wins\&.dat
241 in the
242 var/locks
243 directory configured under wherever Samba was configured to install itself\&.
244 .sp
245 If
246 nmbd
247 is acting as a
248 \fI browse master\fR
249 (see the
250 \m[blue]\fBlocal master\fR\m[]
251 parameter in the
252 \fBsmb.conf\fR(5)
253 man page,
254 nmbd
255 will store the browsing database in the file
256 browse\&.dat
257 in the
258 var/locks
259 directory configured under wherever Samba was configured to install itself\&.
260 .RE
261 .SH "SIGNALS"
262 .PP
263 To shut down an
264 nmbd
265 process it is recommended that SIGKILL (\-9)
266 \fINOT\fR
267 be used, except as a last resort, as this may leave the name database in an inconsistent state\&. The correct way to terminate
268 nmbd
269 is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&.
270 .PP
271 nmbd
272 will accept SIGHUP, which will cause it to dump out its namelists into the file
273 namelist\&.debug
274 in the
275 /usr/local/samba/var/locks
276 directory (or the
277 var/locks
278 directory configured under wherever Samba was configured to install itself)\&. This will also cause
279 nmbd
280 to dump out its server database in the
281 log\&.nmb
282 file\&. Additionally, the signal will cause reloading
283 nmbd
284 configuration\&.
285 .PP
286 Instead of sending a SIGHUP signal, a request to dump namelists into the file and reload a configuration file may be sent using
287 \fBsmbcontrol\fR(1)
288 program\&.
289 .PP
290 The debug log level of nmbd may be raised or lowered using
291 \fBsmbcontrol\fR(1)
292 (SIGUSR[1|2] signals are no longer used since Samba 2\&.2)\&. This is to allow transient problems to be diagnosed, whilst still running at a normally low log level\&.
293 .SH "VERSION"
294 .PP
295 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
296 .SH "SEE ALSO"
297 .PP
298 \fBinetd\fR(8),
299 \fBsmbd\fR(8),
300 \fBsmb.conf\fR(5),
301 \fBsmbclient\fR(1),
302 \fBtestparm\fR(1), and the Internet RFC\*(Aqs
303 rfc1001\&.txt,
304 rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
305 https://www\&.samba\&.org/cifs/\&.
306 .SH "AUTHOR"
307 .PP
308 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.