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

Last change on this file was 860, checked in by Silvan Scherrer, 11 years ago

Samba 3.6: updated vendor to latest version

File size: 10.1 KB
Line 
1'\" t
2.\" Title: nmbd
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5.\" Date: 09/18/2013
6.\" Manual: System Administration tools
7.\" Source: Samba 3.6
8.\" Language: English
9.\"
10.TH "NMBD" "8" "09/18/2013" "Samba 3\&.6" "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] [\-F] [\-S] [\-a] [\-i] [\-o] [\-h] [\-V] [\-d\ <debug\ level>] [\-H\ <lmhosts\ file>] [\-l\ <log\ directory>] [\-p\ <port\ number>] [\-s\ <configuration\ file>]
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
51smb\&.conf\&. Thus
52nmbd
53will reply to broadcast queries for its own name(s)\&. Additional names for
54nmbd
55to respond on can be set via parameters in the
56\fBsmb.conf\fR(5)
57configuration file\&.
58.PP
59nmbd
60can 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
62In addition,
63nmbd
64can 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
68.RS 4
69If specified, this parameter causes
70nmbd
71to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. By default,
72nmbd
73will operate as a daemon if launched from a command shell\&. nmbd can also be operated from the
74inetd
75meta\-daemon, although this is not recommended\&.
76.RE
77.PP
78\-F
79.RS 4
80If specified, this parameter causes the main
81nmbd
82process 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
83nmbd
84under process supervisors such as
85supervise
86and
87svscan
88from Daniel J\&. Bernstein\*(Aqs
89daemontools
90package, or the AIX process monitor\&.
91.RE
92.PP
93\-S
94.RS 4
95If specified, this parameter causes
96nmbd
97to log to standard output rather than a file\&.
98.RE
99.PP
100\-i
101.RS 4
102If 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\&.
103nmbd
104also logs to standard output, as if the
105\fB\-S\fR
106parameter had been given\&.
107.RE
108.PP
109\-h|\-\-help
110.RS 4
111Print a summary of command line options\&.
112.RE
113.PP
114\-H <filename>
115.RS 4
116NetBIOS 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
117\m[blue]\fBname resolve order\fR\m[]
118described in
119\fBsmb.conf\fR(5)
120to resolve any NetBIOS name queries needed by the server\&. Note that the contents of this file are
121\fINOT\fR
122used by
123nmbd
124to answer any name queries\&. Adding a line to this file affects name NetBIOS resolution from this host
125\fIONLY\fR\&.
126.sp
127The default path to this file is compiled into Samba as part of the build process\&. Common defaults are
128/usr/local/samba/lib/lmhosts,
129/usr/samba/lib/lmhosts
130or
131/etc/samba/lmhosts\&. See the
132\fBlmhosts\fR(5)
133man page for details on the contents of this file\&.
134.RE
135.PP
136\-d|\-\-debuglevel=level
137.RS 4
138\fIlevel\fR
139is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
140.sp
141The 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
143Levels 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
145Note that specifying this parameter here will override the
146\m[blue]\fBlog level\fR\m[]
147parameter in the
148smb\&.conf
149file\&.
150.RE
151.PP
152\-V|\-\-version
153.RS 4
154Prints the program version number\&.
155.RE
156.PP
157\-s|\-\-configfile <configuration file>
158.RS 4
159The 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
160smb\&.conf
161for more information\&. The default configuration file name is determined at compile time\&.
162.RE
163.PP
164\-l|\-\-log\-basename=logdirectory
165.RS 4
166Base directory name for log/debug files\&. The extension
167\fB"\&.progname"\fR
168will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
169.RE
170.PP
171\-p <UDP port number>
172.RS 4
173UDP port number is a positive integer value\&. This option changes the default UDP port number (normally 137) that
174nmbd
175responds to name queries on\&. Don\*(Aqt use this option unless you are an expert, in which case you won\*(Aqt need help!
176.RE
177.SH "FILES"
178.PP
179/etc/inetd\&.conf
180.RS 4
181If the server is to be run by the
182inetd
183meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&.
184.RE
185.PP
186/etc/rc
187.RS 4
188or whatever initialization script your system uses)\&.
189.sp
190If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\&.
191.RE
192.PP
193/etc/services
194.RS 4
195If running the server via the meta\-daemon
196inetd, 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)\&.
197.RE
198.PP
199/usr/local/samba/lib/smb\&.conf
200.RS 4
201This is the default location of the
202\fBsmb.conf\fR(5)
203server configuration file\&. Other common places that systems install this file are
204/usr/samba/lib/smb\&.conf
205and
206/etc/samba/smb\&.conf\&.
207.sp
208When run as a WINS server (see the
209\m[blue]\fBwins support\fR\m[]
210parameter in the
211\fBsmb.conf\fR(5)
212man page),
213nmbd
214will store the WINS database in the file
215wins\&.dat
216in the
217var/locks
218directory configured under wherever Samba was configured to install itself\&.
219.sp
220If
221nmbd
222is acting as a
223\fI browse master\fR
224(see the
225\m[blue]\fBlocal master\fR\m[]
226parameter in the
227\fBsmb.conf\fR(5)
228man page,
229nmbd
230will store the browsing database in the file
231browse\&.dat
232in the
233var/locks
234directory configured under wherever Samba was configured to install itself\&.
235.RE
236.SH "SIGNALS"
237.PP
238To shut down an
239nmbd
240process it is recommended that SIGKILL (\-9)
241\fINOT\fR
242be used, except as a last resort, as this may leave the name database in an inconsistent state\&. The correct way to terminate
243nmbd
244is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&.
245.PP
246nmbd
247will accept SIGHUP, which will cause it to dump out its namelists into the file
248namelist\&.debug
249in the
250/usr/local/samba/var/locks
251directory (or the
252var/locks
253directory configured under wherever Samba was configured to install itself)\&. This will also cause
254nmbd
255to dump out its server database in the
256log\&.nmb
257file\&.
258.PP
259The debug log level of nmbd may be raised or lowered using
260\fBsmbcontrol\fR(1)
261(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\&.
262.SH "VERSION"
263.PP
264This man page is correct for version 3 of the Samba suite\&.
265.SH "SEE ALSO"
266.PP
267
268\fBinetd\fR(8),
269\fBsmbd\fR(8),
270\fBsmb.conf\fR(5),
271\fBsmbclient\fR(1),
272\fBtestparm\fR(1),
273\fBtestprns\fR(1), and the Internet RFC\*(Aqs
274rfc1001\&.txt,
275rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
276http://samba\&.org/cifs/\&.
277.SH "AUTHOR"
278.PP
279The 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\&.
280.PP
281The 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
282ftp://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.