Added internal cross references for all man pages.
[samba.git] / docs / yodldocs / nmbd.8.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(nmbd)(8)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(nmbd)(NetBIOS name server to provide NetBIOS over IP
7 naming services to clients)
8
9 label(SYNOPSIS)
10 manpagesynopsis()
11
12 bf(nmbd) [link(-D)(minusD)] [link(-o)(minuso)] [link(-a)(minusa)] [link(-H lmhosts file)(minusH)] [link(-d debuglevel)(minusd)] [link(-l log file basename)(minusl)] [link(-n primary NetBIOS name)(minusn)] [link(-p port number)(minusp)] [link(-s configuration file)(minuss)] [link(-i NetBIOS scope)(minusi)] [link(-h)(minush)]
13
14 label(DESCRIPTION)
15 manpagedescription()
16
17 This program is part of the bf(Samba) suite.
18
19 bf(nmbd) is a server that understands and can reply to NetBIOS over IP
20 name service requests, like those produced by SMBD/CIFS clients such
21 as Windows 95/98, Windows NT and LanManager clients. It also
22 participates in the browsing protocols which make up the Windows
23 "Network Neighborhood" view.
24
25 SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS
26 server. That is, they wish to know what IP number a specified host is
27 using.
28
29 Amongst other services, this program will listen for such requests,
30 and if its own NetBIOS name is specified it will respond with the IP
31 number of the host it is running on.  Its "own NetBIOS name" is by
32 default the primary DNS name of the host it is running on, but this
33 can be overriden with the bf(-n) option (see em(OPTIONS) below). Thus
34 nmbd will reply to broadcast queries for its own name(s). Additional
35 names for nmbd to respond on can be set via parameters in the
36 bf(smb.conf (5)) configuration file.
37
38 nmbd can also be used as a WINS (Windows Internet Name Server)
39 server. What this basically means is that it will act as a WINS
40 database server, creating a database from name registration requests
41 that it receives and replying to queries from clients for these names.
42
43 In addition, nmbd can act as a WINS proxy, relaying broadcast queries
44 from clients that do not understand how to talk the WINS protocol to a
45 WIN server.
46
47 label(OPTIONS)
48 manpageoptions()
49
50 startdit()
51
52 label(minusD)
53 dit(bf(-D)) If specified, this parameter causes the server to operate
54 as a daemon. That is, it detaches itself and runs in the background,
55 fielding requests on the appropriate port. By default, the server will
56 NOT operate as a daemon. nmbd can also be operated from the inetd
57 meta-daemon, although this is not recommended.
58
59 label(minusa)
60 dit(bf(-a)) If this parameter is specified, each new connection will
61 append log messages to the log file.  This is the default.
62
63 label(minuso)
64 dit(bf(-o)) If this parameter is specified, the log files will be
65 overwritten when opened.  By default, the log files will be appended
66 to.
67
68 label(minusH)
69 dit(bf(-H filename)) NetBIOS lmhosts file.
70
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 em(name resolve order) described in bf(smbd.conf (5)) to resolve any
74 NetBIOS name queries needed by the server. Note that the contents of
75 this file are em(NOT) used by nmbd to answer any name queries, adding
76 a line to this file affects name NetBIOS resolution from this host
77 em(ONLY).
78
79 The default path to this file is compiled into Samba as part of the
80 build process. Common defaults are em(/usr/local/samba/lib/lmhosts),
81 em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the bf(lmhosts
82 (5)) man page for details on the contents of this file.
83
84 label(minusd)
85 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
86
87 The default value if this parameter is not specified is zero.
88
89 The higher this value, the more detail will be logged to the log files
90 about the activities of the server. At level 0, only critical errors
91 and serious warnings will be logged. Level 1 is a reasonable level for
92 day to day running - it generates a small amount of information about
93 operations carried out.
94
95 Levels above 1 will generate considerable amounts of log data, and
96 should only be used when investigating a problem. Levels above 3 are
97 designed for use only by developers and generate HUGE amounts of log
98 data, most of which is extremely cryptic.
99
100 Note that specifying this parameter here will override the url(bf(log
101 level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf
102 (5)))(smb.conf.5.html) file.
103
104 label(minusl)
105 dit(bf(-l logfile)) The bf(-l) parameter specifies a path and base
106 filename into which operational data from the running nmbd server will
107 be logged.  The actual log file name is generated by appending the
108 extension ".nmb" to the specified base name.  For example, if the name
109 specified was "log" then the file log.nmb would contain the debugging
110 data.
111
112 The default log file path is is compiled into Samba as part of the
113 build process. Common defaults are em(/usr/local/samba/var/log.nmb),
114 em(/usr/samba/var/log.nmb) or em(/var/log/log.nmb).
115
116 label(minusn)
117 dit(bf(-n primary NetBIOS name)) This option allows you to override
118 the NetBIOS name that Samba uses for itself. This is identical to
119 setting the bf(NetBIOS name) parameter in the smb.conf file
120 but will override the setting in the smb.conf file.
121
122 label(minusp)
123 dit(bf(-p UDP port number)) UDP port number is a positive integer value.
124
125 This option changes the default UDP port number (normally 137) that
126 nmbd responds to name queries on. Don't use this option unless you are
127 an expert, in which case you won't need help!
128
129 label(minuss)
130 dit(bf(-s configuration file)) The default configuration file name is
131 set at build time, typically as em(/usr/local/samba/lib/smb.conf), but
132 this may be changed when Samba is autoconfigured.
133
134 The file specified contains the configuration details required by the
135 server.  See bf(smb.conf (5)) for more information.
136
137 label(minusi)
138 dit(bf(-i scope)) This specifies a NetBIOS scope that the server will use
139 to communicate with when generating NetBIOS names. For details on the
140 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
141 are em(very) rarely used, only set this parameter if you are the
142 system administrator in charge of all the NetBIOS systems you
143 communicate with.
144
145 label(minush)
146 dit(bf(-h)) Prints the help information (usage) for nmbd.
147
148 endit()
149
150 label(FILES)
151 manpagefiles()
152
153 bf(/etc/inetd.conf)
154
155 If the server is to be run by the inetd meta-daemon, this file must
156 contain suitable startup information for the meta-daemon.
157
158 bf(/etc/rc)
159
160 (or whatever initialisation script your system uses).
161
162 If running the server as a daemon at startup, this file will need to
163 contain an appropriate startup sequence for the server.
164
165 bf(/usr/local/samba/lib/smb.conf)
166
167 This is the default location of the em(smb.conf) server configuration
168 file. Other common places that systems install this file are
169 em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
170
171 label(SIGNALS)
172 manpagesection(SIGNALS)
173
174 nmbd will accept SIGHUP, which will cause it to dump out it's
175 namelists into the file namelist.debug in the
176 em(/usr/local/samba/var/locks) directory (or the em(var/locks)
177 directory configured under wherever Samba was configured to install
178 itself). This will also cause nmbd to dump out it's server database in
179 the log.nmb file.  Also new in version 1.9.18 and above is the ability
180 to raise the debug log level of nmbd by sending it a SIGUSR1 (tt(kill
181 -USR1 <nmbd-pid>)) and to lower the nmbd log level by sending it a
182 SIGUSR2 (tt(kill -USR2 <nmbd-pid>)). This is to allow transient
183 problems to be diagnosed, whilst still running at a normally low log
184 level.
185
186 label(VERSION)
187 manpagesection(VERSION)
188
189 This man page is correct for version 2.0 of the Samba suite.
190
191 label(SEEALSO)
192 manpageseealso()
193
194 bf(inetd (8)), url(bf(smbd (8)))(smbd.8.html), url(bf(smb.conf
195 (5)))(smb.conf.5.html), url(bf(smbclient (1)))(smbclient.1.html),
196 url(bf(testparm (1)))(testparm.1.html), url(bf(testprns
197 (1)))(testprns.1.html), and the Internet RFC's bf(rfc1001.txt),
198 bf(rfc1002.txt). In addition the CIFS (formerly SMB) specification is
199 available as a link from the Web page :
200 url(http://samba.anu.edu.au/cifs/)(http://samba.anu.edu.au/cifs/).
201
202 label(AUTHOR)
203 manpageauthor()
204
205 The original Samba software and related utilities were created by
206 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
207 by the Samba Team as an Open Source project similar to the way the
208 Linux kernel is developed.
209
210 The original Samba man pages were written by Karl Auer. The man page
211 sources were converted to YODL format (another excellent piece of Open
212 Source software) and updated for the Samba2.0 release by Jeremy
213 Allison, email(samba-bugs@samba.anu.edu.au).
214
215 See url(bf(samba (7)))(samba.7.html) to find out how to get a full list of contributors
216 and details on how to submit bug reports, comments etc.