source: vendor/current/docs/manpages/nmbd.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 8.7 KB
Line 
1'\" t
2.\" Title: nmbd
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "NMBD" "8" "10/25/2016" "Samba 4\&.4" "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"
31nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34nmbd [\-D|\-\-daemon] [\-F|\-\-foreground] [\-S|\-\-log\-stdout] [\-i|\-\-interactive] [\-V] [\-d\ <debug\ level>] [\-H|\-\-hosts\ <lmhosts\ file>] [\-l\ <log\ directory>] [\-p|\-\-port\ <port\ number>] [\-s\ <configuration\ file>] [\-\-no\-process\-group]
35.SH "DESCRIPTION"
36.PP
37This program is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41nmbd
42is 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
44SMB/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
46Amongst other services,
47nmbd
48will 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[]
50in \&. Thus
51nmbd
52will reply to broadcast queries for its own name(s)\&. Additional names for
53nmbd
54to respond on can be set via parameters in the
55\fBsmb.conf\fR(5)
56configuration file\&.
57.PP
58nmbd
59can 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\&.
60.PP
61In addition,
62nmbd
63can act as a WINS proxy, relaying broadcast queries from clients that do not understand how to talk the WINS protocol to a WINS server\&.
64.SH "OPTIONS"
65.PP
66\-D|\-\-daemon
67.RS 4
68If specified, this parameter causes
69nmbd
70to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. By default,
71nmbd
72will operate as a daemon if launched from a command shell\&. nmbd can also be operated from the
73inetd
74meta\-daemon, although this is not recommended\&.
75.RE
76.PP
77\-F|\-\-foreground
78.RS 4
79If specified, this parameter causes the main
80nmbd
81process 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
82nmbd
83under process supervisors such as
84supervise
85and
86svscan
87from Daniel J\&. Bernstein\*(Aqs
88daemontools
89package, or the AIX process monitor\&.
90.RE
91.PP
92\-S|\-\-log\-stdout
93.RS 4
94If specified, this parameter causes
95nmbd
96to log to standard output rather than a file\&.
97.RE
98.PP
99\-i|\-\-interactive
100.RS 4
101If 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\&.
102nmbd
103also logs to standard output, as if the
104\fB\-S\fR
105parameter had been given\&.
106.RE
107.PP
108\-H|\-\-hosts <filename>
109.RS 4
110NetBIOS 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
111\m[blue]\fBname resolve order\fR\m[]
112described in
113\fBsmb.conf\fR(5)
114to resolve any NetBIOS name queries needed by the server\&. Note that the contents of this file are
115\fINOT\fR
116used by
117nmbd
118to answer any name queries\&. Adding a line to this file affects name NetBIOS resolution from this host
119\fIONLY\fR\&.
120.sp
121The default path to this file is compiled into Samba as part of the build process\&. Common defaults are
122/usr/local/samba/lib/lmhosts,
123/usr/samba/lib/lmhosts
124or
125/etc/samba/lmhosts\&. See the
126\fBlmhosts\fR(5)
127man page for details on the contents of this file\&.
128.RE
129.PP
130\-p|\-\-port <UDP port number>
131.RS 4
132UDP port number is a positive integer value\&. This option changes the default UDP port number (normally 137) that
133nmbd
134responds to name queries on\&. Don\*(Aqt use this option unless you are an expert, in which case you won\*(Aqt need help!
135.RE
136.PP
137\-\-no\-process\-group
138.RS 4
139Do not create a new process group for nmbd\&.
140.RE
141.SH "FILES"
142.PP
143/etc/inetd\&.conf
144.RS 4
145If the server is to be run by the
146inetd
147meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&.
148.RE
149.PP
150/etc/rc
151.RS 4
152or whatever initialization script your system uses)\&.
153.sp
154If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\&.
155.RE
156.PP
157/etc/services
158.RS 4
159If running the server via the meta\-daemon
160inetd, 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)\&.
161.RE
162.PP
163/usr/local/samba/lib/smb\&.conf
164.RS 4
165This is the default location of the
166\fBsmb.conf\fR(5)
167server configuration file\&. Other common places that systems install this file are
168/usr/samba/lib/smb\&.conf
169and
170/etc/samba/smb\&.conf\&.
171.sp
172When run as a WINS server (see the
173\m[blue]\fBwins support\fR\m[]
174parameter in the
175\fBsmb.conf\fR(5)
176man page),
177nmbd
178will store the WINS database in the file
179wins\&.dat
180in the
181var/locks
182directory configured under wherever Samba was configured to install itself\&.
183.sp
184If
185nmbd
186is acting as a
187\fI browse master\fR
188(see the
189\m[blue]\fBlocal master\fR\m[]
190parameter in the
191\fBsmb.conf\fR(5)
192man page,
193nmbd
194will store the browsing database in the file
195browse\&.dat
196in the
197var/locks
198directory configured under wherever Samba was configured to install itself\&.
199.RE
200.SH "SIGNALS"
201.PP
202To shut down an
203nmbd
204process it is recommended that SIGKILL (\-9)
205\fINOT\fR
206be used, except as a last resort, as this may leave the name database in an inconsistent state\&. The correct way to terminate
207nmbd
208is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&.
209.PP
210nmbd
211will accept SIGHUP, which will cause it to dump out its namelists into the file
212namelist\&.debug
213in the
214/usr/local/samba/var/locks
215directory (or the
216var/locks
217directory configured under wherever Samba was configured to install itself)\&. This will also cause
218nmbd
219to dump out its server database in the
220log\&.nmb
221file\&.
222.PP
223The debug log level of nmbd may be raised or lowered using
224\fBsmbcontrol\fR(1)
225(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\&.
226.SH "VERSION"
227.PP
228This man page is correct for version 3 of the Samba suite\&.
229.SH "SEE ALSO"
230.PP
231\fBinetd\fR(8),
232\fBsmbd\fR(8),
233\fBsmb.conf\fR(5),
234\fBsmbclient\fR(1),
235\fBtestparm\fR(1), and the Internet RFC\*(Aqs
236rfc1001\&.txt,
237rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
238http://samba\&.org/cifs/\&.
239.SH "AUTHOR"
240.PP
241The 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\&.
242.PP
243The original Samba man pages were written by Karl Auer\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at
244ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
Note: See TracBrowser for help on using the repository browser.