| blob | 7675459166e0395f9b9bc2773617ff5346287bd5 |
1 .\" This manpage has been automatically generated by docbook2man-spec
2 .\" from a DocBook document. docbook2man-spec can be found at:
3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
4 .\" Please send any bug reports, improvements, comments, patches,
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "NMBD" "8" "10 October 2001" "" ""
7 .SH NAME
8 nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients
9 .SH SYNOPSIS
10 .sp
11 \fBnmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-d <debug level>\fR ] [ \fB-H <lmhosts file>\fR ] [ \fB-l <log file>\fR ] [ \fB-n <primary netbios name>\fR ] [ \fB-p <port number>\fR ] [ \fB-s <configuration file>\fR ]
12 .SH "DESCRIPTION"
13 .PP
14 This program is part of the Samba suite.
15 .PP
16 \fBnmbd\fR is a server that understands
17 and can reply to NetBIOS over IP name service requests, like
18 those produced by SMB/CIFS clients such as Windows 95/98/ME,
19 Windows NT, Windows 2000, and LanManager clients. It also
20 participates in the browsing protocols which make up the
21 Windows "Network Neighborhood" view.
22 .PP
23 SMB/CIFS clients, when they start up, may wish to
24 locate an SMB/CIFS server. That is, they wish to know what
25 IP number a specified host is using.
26 .PP
27 Amongst other services, \fBnmbd\fR will
28 listen for such requests, and if its own NetBIOS name is
29 specified it will respond with the IP number of the host it
30 is running on. Its "own NetBIOS name" is by
31 default the primary DNS name of the host it is running on,
32 but this can be overridden with the \fB-n\fR
33 option (see OPTIONS below). Thus \fBnmbd\fR will
34 reply to broadcast queries for its own name(s). Additional
35 names for \fBnmbd\fR to respond on can be set
36 via parameters in the \fI smb.conf(5)\fRconfiguration file.
37 .PP
38 \fBnmbd\fR can also be used as a WINS
39 (Windows Internet Name Server) server. What this basically means
40 is that it will act as a WINS database server, creating a
41 database from name registration requests that it receives and
42 replying to queries from clients for these names.
43 .PP
44 In addition, \fBnmbd\fR can act as a WINS
45 proxy, relaying broadcast queries from clients that do
46 not understand how to talk the WINS protocol to a WIN
47 server.
48 .SH "OPTIONS"
49 .TP
50 \fB-D\fR
51 If specified, this parameter causes
52 \fBnmbd\fR to operate as a daemon. That is,
53 it detaches itself and runs in the background, fielding
54 requests on the appropriate port. By default, \fBnmbd\fR
55 will operate as a daemon if launched from a command shell.
56 nmbd can also be operated from the \fBinetd\fR
57 meta-daemon, although this is not recommended.
58 .TP
59 \fB-a\fR
60 If this parameter is specified, each new
61 connection will append log messages to the log file.
62 This is the default.
63 .TP
64 \fB-o\fR
65 If this parameter is specified, the
66 log files will be overwritten when opened. By default,
67 \fBsmbd\fR will append entries to the log
68 files.
69 .TP
70 \fB-h\fR
71 Prints the help information (usage)
72 for \fBnmbd\fR.
73 .TP
74 \fB-H <filename>\fR
75 NetBIOS lmhosts file. The lmhosts
76 file is a list of NetBIOS names to IP addresses that
77 is loaded by the nmbd server and used via the name
78 resolution mechanism name resolve order
79 to resolve any NetBIOS name queries needed by the server. Note
80 that the contents of this file are \fBNOT\fR
81 used by \fBnmbd\fR to answer any name queries.
82 Adding a line to this file affects name NetBIOS resolution
83 from this host \fBONLY\fR.
85 The default path to this file is compiled into
86 Samba as part of the build process. Common defaults
87 are \fI/usr/local/samba/lib/lmhosts\fR,
88 \fI/usr/samba/lib/lmhosts\fR or
89 \fI/etc/lmhosts\fR. See the \fIlmhosts(5)\fRman page for details on the
90 contents of this file.
91 .TP
92 \fB-V\fR
93 Prints the version number for
94 \fBnmbd\fR.
95 .TP
96 \fB-d <debug level>\fR
97 debuglevel is an integer
98 from 0 to 10. The default value if this parameter is
99 not specified is zero.
101 The higher this value, the more detail will
102 be logged to the log files about the activities of the
103 server. At level 0, only critical errors and serious
104 warnings will be logged. Level 1 is a reasonable level for
105 day to day running - it generates a small amount of
106 information about operations carried out.
108 Levels above 1 will generate considerable amounts
109 of log data, and should only be used when investigating
110 a problem. Levels above 3 are designed for use only by developers
111 and generate HUGE amounts of log data, most of which is extremely
112 cryptic.
114 Note that specifying this parameter here will override
115 the log level
116 parameter in the \fI smb.conf\fRfile.
117 .TP
118 \fB-l <log file>\fR
119 The -l parameter specifies a path
120 and base filename into which operational data from
121 the running \fBnmbd\fR server will
122 be logged. The actual log file name is generated by
123 appending the extension ".nmb" to the specified base
124 name. For example, if the name specified was "log"
125 then the file log.nmb would contain the debugging data.
127 The default log file path is compiled into Samba as
128 part of the build process. Common defaults are \fI /usr/local/samba/var/log.nmb\fR, \fI /usr/samba/var/log.nmb\fR or
129 \fI/var/log/log.nmb\fR.
130 .TP
131 \fB-n <primary NetBIOS name>\fR
132 This option allows you to override
133 the NetBIOS name that Samba uses for itself. This is identical
134 to setting the NetBIOS nameparameter in the
135 \fIsmb.conf\fRfile. However, a command
136 line setting will take precedence over settings in
137 \fIsmb.conf\fR.
138 .TP
139 \fB-p <UDP port number>\fR
140 UDP port number is a positive integer value.
141 This option changes the default UDP port number (normally 137)
142 that \fBnmbd\fR responds to name queries on. Don't
143 use this option unless you are an expert, in which case you
144 won't need help!
145 .TP
146 \fB-s <configuration file>\fR
147 The default configuration file name
148 is set at build time, typically as \fI /usr/local/samba/lib/smb.conf\fR, but
149 this may be changed when Samba is autoconfigured.
151 The file specified contains the configuration details
152 required by the server. See
153 \fIsmb.conf(5)\fRfor more information.
154 .SH "FILES"
155 .TP
156 \fB\fI/etc/inetd.conf\fB\fR
157 If the server is to be run by the
158 \fBinetd\fR meta-daemon, this file
159 must contain suitable startup information for the
160 meta-daemon. See the section INSTALLATION below.
161 .TP
162 \fB\fI/etc/rc\fB\fR
163 or whatever initialization script your
164 system uses).
166 If running the server as a daemon at startup,
167 this file will need to contain an appropriate startup
168 sequence for the server. See the section INSTALLATION
169 below.
170 .TP
171 \fB\fI/etc/services\fB\fR
172 If running the server via the
173 meta-daemon \fBinetd\fR, this file
174 must contain a mapping of service name (e.g., netbios-ssn)
175 to service port (e.g., 139) and protocol type (e.g., tcp).
176 See the section INSTALLATION below.
177 .TP
178 \fB\fI/usr/local/samba/lib/smb.conf\fB\fR
179 This is the default location of the
180 \fIsmb.conf\fR
181 server configuration file. Other common places that systems
182 install this file are \fI/usr/samba/lib/smb.conf\fR
183 and \fI/etc/smb.conf\fR.
185 When run as a WINS server (see the
186 wins support
187 parameter in the \fI smb.conf(5)\fRman page), \fBnmbd\fR
188 will store the WINS database in the file \fIwins.dat\fR
189 in the \fIvar/locks\fR directory configured under
190 wherever Samba was configured to install itself.
192 If \fBnmbd\fR is acting as a \fB browse master\fR (see the local master
193 parameter in the \fI smb.conf(5)\fRman page), \fBnmbd\fR
194 will store the browsing database in the file \fIbrowse.dat
195 \fRin the \fIvar/locks\fR directory
196 configured under wherever Samba was configured to install itself.
197 .SH "SIGNALS"
198 .PP
199 To shut down an \fBnmbd\fR process it is recommended
200 that SIGKILL (-9) \fBNOT\fR be used, except as a last
201 resort, as this may leave the name database in an inconsistent state.
202 The correct way to terminate \fBnmbd\fR is to send it
203 a SIGTERM (-15) signal and wait for it to die on its own.
204 .PP
205 \fBnmbd\fR will accept SIGHUP, which will cause
206 it to dump out its namelists into the file \fInamelist.debug
207 \fRin the \fI/usr/local/samba/var/locks\fR
208 directory (or the \fIvar/locks\fR directory configured
209 under wherever Samba was configured to install itself). This will also
210 cause \fBnmbd\fR to dump out its server database in
211 the \fIlog.nmb\fR file.
212 .PP
213 The debug log level of nmbd may be raised or lowered using
214 \fBsmbcontrol(1)\fR
215 (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is
216 to allow transient problems to be diagnosed, whilst still running
217 at a normally low log level.
218 .SH "VERSION"
219 .PP
220 This man page is correct for version 2.2 of
221 the Samba suite.
222 .SH "SEE ALSO"
223 .PP
224 \fBinetd(8)\fR, \fBsmbd(8)\fR,
225 \fIsmb.conf(5)\fR
226 , \fBsmbclient(1)
227 \fR, and the Internet RFC's
228 \fIrfc1001.txt\fR, \fIrfc1002.txt\fR.
229 In addition the CIFS (formerly SMB) specification is available
230 as a link from the Web page
231 http://samba.org/cifs/ <URL:http://samba.org/cifs/>.
232 .SH "AUTHOR"
233 .PP
234 The original Samba software and related utilities
235 were created by Andrew Tridgell. Samba is now developed
236 by the Samba Team as an Open Source project similar
237 to the way the Linux kernel is developed.
238 .PP
239 The original Samba man pages were written by Karl Auer.
240 The man page sources were converted to YODL format (another
241 excellent piece of Open Source software, available at
242 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
243 release by Jeremy Allison. The conversion to DocBook for
244 Samba 2.2 was done by Gerald Carter