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