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