- document the "remote announce" option
[samba.git] / docs / manpages / nmbd.8
1 .TH NMBD 8 17/1/1995 nmbd nmbd
2 .SH NAME
3 nmbd \- provide netbios nameserver support to clients
4 .SH SYNOPSIS
5 .B nmbd
6 [
7 .B -D
8 ] [
9 .B -H
10 .I netbios hosts file
11 ] [
12 .B -d
13 .I debuglevel
14 ] [
15 .B -l
16 .I log basename
17 ] [
18 .B -p
19 .I port number
20 ] [
21 .B -s
22 .I config file name
23 ]
24
25 .SH DESCRIPTION
26 This program is part of the Samba suite.
27
28 .B nmbd
29 is a server that understands and can reply to netbios
30 name service requests, like those produced by LanManager
31 clients. It also controls browsing.
32
33 LanManager clients, when they start up, may wish to locate a LanManager server.
34 That is, they wish to know what IP number a specified host is using.
35
36 This program simply listens for such requests, and if its own name is specified
37 it will respond with the IP number of the host it is running on. "Its own name"
38 is by default the name of the host it is running on, but this can be overriden
39 with the
40 .B -n
41 option (see "OPTIONS" below). Using the
42
43 Nmbd can also be used as a WINS (Windows Internet Name Server)
44 server. It will do this automatically by default. What this basically
45 means is that it will respond to all name requests that it receives
46 that are not broadcasts, as long as it can resolve the name.
47 .SH OPTIONS
48 .B -B
49
50 .RS 3
51 This option is obsolete. Please use the interfaces option in smb.conf
52 .RE
53 .B -I
54
55 .RS 3
56 This option is obsolete. Please use the interfaces option in smb.conf
57 .RE
58
59 .B -D
60
61 .RS 3
62 If specified, this parameter causes the server to operate as a daemon. That is,
63 it detaches itself and runs in the background, fielding requests on the 
64 appropriate port.
65
66 By default, the server will NOT operate as a daemon.
67 .RE
68
69 .B -C comment string
70
71 .RS 3
72 This option is obsolete. Please use the "server string" option in smb.conf
73 .RE
74
75 .B -G
76
77 .RS 3
78 This option is obsolete. Please use the "workgroup" option in smb.conf
79 .RE
80
81 .B -H
82
83 .RS 3
84 It may be useful in some situations to be able to specify a list of
85 netbios names for which the server should send a reply if
86 queried. This option allows that. The syntax is similar to the
87 standard /etc/hosts file format, but has some extensions.
88
89 The file contains three columns. Lines beginning with a # are ignored
90 as comments. The first column is an IP address, or a hostname. If it
91 is a hostname then it is interpreted as the IP address returned by
92 gethostbyname() when read. Any IP address of 0.0.0.0 will be
93 interpreted as the servers own IP address.
94
95 The second column is a netbios name. This is the name that the server
96 will respond to. It must be less than 20 characters long.
97
98 The third column is optional, and is intended for flags. Currently the
99 only flag supported is M. 
100
101 A M means that this name is the default netbios name for this
102 machine. This has the same affect as specifying the -n option to nmbd.
103
104 After startup the server waits for queries, and will answer queries to
105 any name known to it. This includes all names in the netbios hosts
106 file (if any) and it's own name.
107
108 The primary intention of the -H option is to allow a mapping from
109 netbios names to internet domain names.
110
111 .B Example:
112
113         # This is a sample netbios hosts file
114
115         # DO NOT USE THIS FILE AS-IS
116         # YOU MAY INCONVENIENCE THE OWNERS OF THESE IPs
117         # if you want to include a name with a space in it then 
118         # use double quotes.
119
120         # next add a netbios alias for a faraway host
121         arvidsjaur.anu.edu.au ARVIDSJAUR
122
123         # finally put in an IP for a hard to find host
124         130.45.3.213 FREDDY
125
126 .RE
127 .B -N
128
129 .RS 3
130 This option is obsolete. Please use the "interfaces" option in
131 smb.conf instead.
132 .RE
133
134 .B -d
135 .I debuglevel
136 .RS 3
137 This option set the debug level. See smb.conf(5)
138 .RE
139
140 .B -l
141 .I log file
142
143 .RS 3
144 If specified,
145 .I logfile
146 specifies a base filename into which operational data from the running server
147 will be logged.
148
149 The default base name is specified at compile time.
150
151 The base name is used to generate actual log file names. For example, if the
152 name specified was "log" then the file log.nmb would contain debug
153 info.
154 .RE
155
156 .B -n
157 .I netbios name
158
159 .RS 3
160 This option allows you to override the Netbios name that Samba uses
161 for itself. 
162 .RE
163
164 .B -p
165 .I port number
166 .RS 3
167
168 port number is a positive integer value.
169
170 Don't use this option unless you are an expert, in which case you
171 won't need help!
172
173 .SH VERSION
174
175 This man page is (mostly) correct for version 1.9.16 of the Samba
176 suite, plus some of the recent patches to it. These notes will
177 necessarily lag behind development of the software, so it is possible
178 that your version of the server has extensions or parameter semantics
179 that differ from or are not covered by this man page. Please notify
180 these to the address below for rectification.
181 .SH SEE ALSO
182 .B inetd(8),
183 .B smbd(8), 
184 .B smb.conf(5),
185 .B smbclient(1),
186 .B testparm(1), 
187 .B testprns(1)
188
189 .SH CREDITS
190 The original Samba software and related utilities were created by 
191 Andrew Tridgell (samba-bugs@anu.edu.au). Andrew is also the Keeper
192 of the Source for this project.
193
194 This man page originally written by Karl Auer (Karl.Auer@anu.edu.au)
195
196
197
198
199
200