summaryrefslogtreecommitdiff
path: root/docs/manpages/nmbd.8
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/nmbd.8')
-rw-r--r--docs/manpages/nmbd.8262
1 files changed, 56 insertions, 206 deletions
diff --git a/docs/manpages/nmbd.8 b/docs/manpages/nmbd.8
index 757f5da543..ffcf22bafa 100644
--- a/docs/manpages/nmbd.8
+++ b/docs/manpages/nmbd.8
@@ -1,161 +1,13 @@
+'\" t
.\" Title: nmbd
.\" Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\" Date: 06/18/2010
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 03/06/2011
.\" Manual: System Administration tools
.\" Source: Samba 3.5
.\" Language: English
.\"
-.TH "NMBD" "8" "06/18/2010" "Samba 3\&.5" "System Administration tools"
-.\" -----------------------------------------------------------------
-.\" * (re)Define some macros
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" toupper - uppercase a string (locale-aware)
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de toupper
-.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
-\\$*
-.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH-xref - format a cross-reference to an SH section
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de SH-xref
-.ie n \{\
-.\}
-.toupper \\$*
-.el \{\
-\\$*
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH - level-one heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SH
-.\" put an extra blank line of space above the head in non-TTY output
-.if t \{\
-.sp 1
-.\}
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[an-margin]u
-.ti 0
-.HTML-TAG ".NH \\n[an-level]"
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-\." make the size of the head bigger
-.ps +3
-.ft B
-.ne (2v + 1u)
-.ie n \{\
-.\" if n (TTY output), use uppercase
-.toupper \\$*
-.\}
-.el \{\
-.nr an-break-flag 0
-.\" if not n (not TTY), use normal case (not uppercase)
-\\$1
-.in \\n[an-margin]u
-.ti 0
-.\" if not n (not TTY), put a border/line under subheading
-.sp -.6
-\l'\n(.lu'
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SS - level-two heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SS
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[IN]u
-.ti \\n[SN]u
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.ps \\n[PS-SS]u
-\." make the size of the head bigger
-.ps +2
-.ft B
-.ne (2v + 1u)
-.if \\n[.$] \&\\$*
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BB/BE - put background/screen (filled box) around block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BB
-.if t \{\
-.sp -.5
-.br
-.in +2n
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EB
-.if t \{\
-.if "\\$2"adjust-for-leading-newline" \{\
-.sp -1
-.\}
-.br
-.di
-.in
-.ll
-.gcolor
-.nr BW \\n(.lu-\\n(.i
-.nr BH \\n(dn+.5v
-.ne \\n(BHu+.5v
-.ie "\\$2"adjust-for-leading-newline" \{\
-\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.el \{\
-\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.in 0
-.sp -.5v
-.nf
-.BX
-.in
-.sp .5v
-.fi
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BM/EM - put colored marker in margin next to block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BM
-.if t \{\
-.br
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EM
-.if t \{\
-.br
-.di
-.ll
-.gcolor
-.nr BH \\n(dn
-.ne \\n(BHu
-\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
-.in 0
-.nf
-.BX
-.in
-.fi
-.\}
-..
+.TH "NMBD" "8" "03/06/2011" "Samba 3\&.5" "System Administration tools"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -166,82 +18,80 @@
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
-.SH "Name"
+.SH "NAME"
nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients
-.SH "Synopsis"
-.fam C
+.SH "SYNOPSIS"
.HP \w'\ 'u
-\FCnmbd\F[] [\-D] [\-F] [\-S] [\-a] [\-i] [\-o] [\-h] [\-V] [\-d\ <debug\ level>] [\-H\ <lmhosts\ file>] [\-l\ <log\ directory>] [\-p\ <port\ number>] [\-s\ <configuration\ file>]
-.fam
+nmbd [\-D] [\-F] [\-S] [\-a] [\-i] [\-o] [\-h] [\-V] [\-d\ <debug\ level>] [\-H\ <lmhosts\ file>] [\-l\ <log\ directory>] [\-p\ <port\ number>] [\-s\ <configuration\ file>]
.SH "DESCRIPTION"
.PP
This program is part of the
\fBsamba\fR(7)
suite\&.
.PP
-\FCnmbd\F[]
+nmbd
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\&.
.PP
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\&.
.PP
Amongst other services,
-\FCnmbd\F[]
+nmbd
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
\m[blue]\fBnetbios name\fR\m[]
in
-\FCsmb\&.conf\F[]\&. Thus
-\FCnmbd\F[]
+smb\&.conf\&. Thus
+nmbd
will reply to broadcast queries for its own name(s)\&. Additional names for
-\FCnmbd\F[]
+nmbd
to respond on can be set via parameters in the
\fBsmb.conf\fR(5)
configuration file\&.
.PP
-\FCnmbd\F[]
+nmbd
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\&.
.PP
In addition,
-\FCnmbd\F[]
+nmbd
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\&.
.SH "OPTIONS"
.PP
\-D
.RS 4
If specified, this parameter causes
-\FCnmbd\F[]
+nmbd
to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. By default,
-\FCnmbd\F[]
+nmbd
will operate as a daemon if launched from a command shell\&. nmbd can also be operated from the
-\FCinetd\F[]
+inetd
meta\-daemon, although this is not recommended\&.
.RE
.PP
\-F
.RS 4
If specified, this parameter causes the main
-\FCnmbd\F[]
+nmbd
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
-\FCnmbd\F[]
+nmbd
under process supervisors such as
-\FCsupervise\F[]
+supervise
and
-\FCsvscan\F[]
+svscan
from Daniel J\&. Bernstein\'s
-\FCdaemontools\F[]
+daemontools
package, or the AIX process monitor\&.
.RE
.PP
\-S
.RS 4
If specified, this parameter causes
-\FCnmbd\F[]
+nmbd
to log to standard output rather than a file\&.
.RE
.PP
\-i
.RS 4
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\&.
-\FCnmbd\F[]
+nmbd
also logs to standard output, as if the
\fB\-S\fR
parameter had been given\&.
@@ -261,15 +111,15 @@ described in
to resolve any NetBIOS name queries needed by the server\&. Note that the contents of this file are
\fINOT\fR
used by
-\FCnmbd\F[]
+nmbd
to answer any name queries\&. Adding a line to this file affects name NetBIOS resolution from this host
\fIONLY\fR\&.
.sp
The default path to this file is compiled into Samba as part of the build process\&. Common defaults are
-\FC/usr/local/samba/lib/lmhosts\F[],
-\FC/usr/samba/lib/lmhosts\F[]
+/usr/local/samba/lib/lmhosts,
+/usr/samba/lib/lmhosts
or
-\FC/etc/samba/lmhosts\F[]\&. See the
+/etc/samba/lmhosts\&. See the
\fBlmhosts\fR(5)
man page for details on the contents of this file\&.
.RE
@@ -286,7 +136,7 @@ Levels above 1 will generate considerable amounts of log data, and should only b
Note that specifying this parameter here will override the
\m[blue]\fB\%smb.conf.5.html#\fR\m[]
parameter in the
-\FCsmb\&.conf\F[]
+smb\&.conf
file\&.
.RE
.PP
@@ -298,7 +148,7 @@ Prints the program version number\&.
\-s|\-\-configfile <configuration file>
.RS 4
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
-\FCsmb\&.conf\F[]
+smb\&.conf
for more information\&. The default configuration file name is determined at compile time\&.
.RE
.PP
@@ -312,54 +162,54 @@ will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log
\-p <UDP port number>
.RS 4
UDP port number is a positive integer value\&. This option changes the default UDP port number (normally 137) that
-\FCnmbd\F[]
+nmbd
responds to name queries on\&. Don\'t use this option unless you are an expert, in which case you won\'t need help!
.RE
.SH "FILES"
.PP
-\FC/etc/inetd\&.conf\F[]
+/etc/inetd\&.conf
.RS 4
If the server is to be run by the
-\FCinetd\F[]
+inetd
meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&.
.RE
.PP
-\FC/etc/rc\F[]
+/etc/rc
.RS 4
or whatever initialization script your system uses)\&.
.sp
If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\&.
.RE
.PP
-\FC/etc/services\F[]
+/etc/services
.RS 4
If running the server via the meta\-daemon
-\FCinetd\F[], 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)\&.
+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)\&.
.RE
.PP
-\FC/usr/local/samba/lib/smb\&.conf\F[]
+/usr/local/samba/lib/smb\&.conf
.RS 4
This is the default location of the
\fBsmb.conf\fR(5)
server configuration file\&. Other common places that systems install this file are
-\FC/usr/samba/lib/smb\&.conf\F[]
+/usr/samba/lib/smb\&.conf
and
-\FC/etc/samba/smb\&.conf\F[]\&.
+/etc/samba/smb\&.conf\&.
.sp
When run as a WINS server (see the
\m[blue]\fBwins support\fR\m[]
parameter in the
\fBsmb.conf\fR(5)
man page),
-\FCnmbd\F[]
+nmbd
will store the WINS database in the file
-\FCwins\&.dat\F[]
+wins\&.dat
in the
-\FCvar/locks\F[]
+var/locks
directory configured under wherever Samba was configured to install itself\&.
.sp
If
-\FCnmbd\F[]
+nmbd
is acting as a
\fI browse master\fR
(see the
@@ -367,34 +217,34 @@ is acting as a
parameter in the
\fBsmb.conf\fR(5)
man page,
-\FCnmbd\F[]
+nmbd
will store the browsing database in the file
-\FCbrowse\&.dat \F[]
+browse\&.dat
in the
-\FCvar/locks\F[]
+var/locks
directory configured under wherever Samba was configured to install itself\&.
.RE
.SH "SIGNALS"
.PP
To shut down an
-\FCnmbd\F[]
+nmbd
process it is recommended that SIGKILL (\-9)
\fINOT\fR
be used, except as a last resort, as this may leave the name database in an inconsistent state\&. The correct way to terminate
-\FCnmbd\F[]
+nmbd
is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&.
.PP
-\FCnmbd\F[]
+nmbd
will accept SIGHUP, which will cause it to dump out its namelists into the file
-\FCnamelist\&.debug \F[]
+namelist\&.debug
in the
-\FC/usr/local/samba/var/locks\F[]
+/usr/local/samba/var/locks
directory (or the
-\FCvar/locks\F[]
+var/locks
directory configured under wherever Samba was configured to install itself)\&. This will also cause
-\FCnmbd\F[]
+nmbd
to dump out its server database in the
-\FClog\&.nmb\F[]
+log\&.nmb
file\&.
.PP
The debug log level of nmbd may be raised or lowered using
@@ -412,8 +262,8 @@ This man page is correct for version 3 of the Samba suite\&.
\fBsmbclient\fR(1),
\fBtestparm\fR(1),
\fBtestprns\fR(1), and the Internet RFC\'s
-\FCrfc1001\&.txt\F[],
-\FCrfc1002\&.txt\F[]\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
+rfc1001\&.txt,
+rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
http://samba\&.org/cifs/\&.
.SH "AUTHOR"
.PP