Changeset 429 for trunk/server/docs/manpages/nmbd.8

Timestamp:

Apr 9, 2010, 3:51:41 PM (15 years ago)

Author:

Silvan Scherrer

Message:

Samba 3.5.x: trunk update to 3.5.2

Location:

trunk/server

Files:

• . (modified) (1 prop)
• docs/manpages/nmbd.8 (modified) (17 diffs)

trunk/server/docs/manpages/nmbd.8

@@ -1 @@
-'\" t
 .\"     Title: nmbd
 .\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 02/19/2010
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 03/30/2010
 .\"    Manual: System Administration tools
 .\"    Source: Samba 3.5
 .\"  Language: English
 .\"
-.TH "NMBD" "8" "02/19/2010" "Samba 3\&.5" "System Administration tools"
+.TH "NMBD" "8" "03/30/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
+.\}
+..
 .\" -----------------------------------------------------------------
 .\" * set default formatting
@@ -19 +167 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "NAME"
+.SH "Name"
 nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients
-.SH "SYNOPSIS"
+.SH "Synopsis"
+.fam C
 .HP \w'\ 'u
-nmbd [\-D] [\-F] [\-S] [\-a] [\-i] [\-o] [\-h] [\-V] [\-d\ <debug\ level>] [\-H\ <lmhosts\ file>] [\-l\ <log\ directory>] [\-p\ <port\ number>] [\-s\ <configuration\ file>]
+\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
 .SH "DESCRIPTION"
 .PP
@@ -30 +180 @@
 suite\&.
 .PP
-nmbd
+\FCnmbd\F[]
 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
@@ -36 +186 @@
 .PP
 Amongst other services,
-nmbd
+\FCnmbd\F[]
 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
-smb\&.conf\&. Thus
-nmbd
+\FCsmb\&.conf\F[]\&. Thus
+\FCnmbd\F[]
 will reply to broadcast queries for its own name(s)\&. Additional names for
-nmbd
+\FCnmbd\F[]
 to respond on can be set via parameters in the
 \fBsmb.conf\fR(5)
 configuration file\&.
 .PP
-nmbd
+\FCnmbd\F[]
 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,
-nmbd
+\FCnmbd\F[]
 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"
@@ -59 +209 @@
 .RS 4
 If specified, this parameter causes
-nmbd
+\FCnmbd\F[]
 to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. By default,
-nmbd
+\FCnmbd\F[]
 will operate as a daemon if launched from a command shell\&. nmbd can also be operated from the
-inetd
+\FCinetd\F[]
 meta\-daemon, although this is not recommended\&.
 .RE
@@ -70 +220 @@
 .RS 4
 If specified, this parameter causes the main
-nmbd
+\FCnmbd\F[]
 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
-nmbd
+\FCnmbd\F[]
 under process supervisors such as
-supervise
+\FCsupervise\F[]
 and
-svscan
+\FCsvscan\F[]
 from Daniel J\&. Bernstein\'s
-daemontools
+\FCdaemontools\F[]
 package, or the AIX process monitor\&.
 .RE
@@ -85 +235 @@
 .RS 4
 If specified, this parameter causes
-nmbd
+\FCnmbd\F[]
 to log to standard output rather than a file\&.
 .RE
@@ -92 +242 @@
 .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\&.
-nmbd
+\FCnmbd\F[]
 also logs to standard output, as if the
 \fB\-S\fR
@@ -112 +262 @@
 \fINOT\fR
 used by
-nmbd
+\FCnmbd\F[]
 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
-/usr/local/samba/lib/lmhosts,
-/usr/samba/lib/lmhosts
+\FC/usr/local/samba/lib/lmhosts\F[],
+\FC/usr/samba/lib/lmhosts\F[]
 or
-/etc/samba/lmhosts\&. See the
+\FC/etc/samba/lmhosts\F[]\&. See the
 \fBlmhosts\fR(5)
 man page for details on the contents of this file\&.
@@ -137 +287 @@
 \m[blue]\fB\%smb.conf.5.html#\fR\m[]
 parameter in the
-smb\&.conf
+\FCsmb\&.conf\F[]
 file\&.
 .RE
@@ -149 +299 @@
 .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
-smb\&.conf
+\FCsmb\&.conf\F[]
 for more information\&. The default configuration file name is determined at compile time\&.
 .RE
@@ -163 +313 @@
 .RS 4
 UDP port number is a positive integer value\&. This option changes the default UDP port number (normally 137) that
-nmbd
+\FCnmbd\F[]
 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
-/etc/inetd\&.conf
+\FC/etc/inetd\&.conf\F[]
 .RS 4
 If the server is to be run by the
-inetd
+\FCinetd\F[]
 meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&.
 .RE
 .PP
-/etc/rc
+\FC/etc/rc\F[]
 .RS 4
 or whatever initialization script your system uses)\&.
@@ -182 +332 @@
 .RE
 .PP
-/etc/services
+\FC/etc/services\F[]
 .RS 4
 If running the server via the meta\-daemon
-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
-/usr/local/samba/lib/smb\&.conf
+\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)\&.
+.RE
+.PP
+\FC/usr/local/samba/lib/smb\&.conf\F[]
 .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
-/usr/samba/lib/smb\&.conf
+\FC/usr/samba/lib/smb\&.conf\F[]
 and
-/etc/samba/smb\&.conf\&.
+\FC/etc/samba/smb\&.conf\F[]\&.
 .sp
 When run as a WINS server (see the
@@ -202 +352 @@
 \fBsmb.conf\fR(5)
 man page),
-nmbd
+\FCnmbd\F[]
 will store the WINS database in the file
-wins\&.dat
+\FCwins\&.dat\F[]
 in the
-var/locks
+\FCvar/locks\F[]
 directory configured under wherever Samba was configured to install itself\&.
 .sp
 If
-nmbd
+\FCnmbd\F[]
 is acting as a
 \fI browse master\fR
@@ -218 +368 @@
 \fBsmb.conf\fR(5)
 man page,
-nmbd
+\FCnmbd\F[]
 will store the browsing database in the file
-browse\&.dat
+\FCbrowse\&.dat \F[]
 in the
-var/locks
+\FCvar/locks\F[]
 directory configured under wherever Samba was configured to install itself\&.
 .RE
@@ -228 +378 @@
 .PP
 To shut down an
-nmbd
+\FCnmbd\F[]
 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
-nmbd
+\FCnmbd\F[]
 is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&.
 .PP
-nmbd
+\FCnmbd\F[]
 will accept SIGHUP, which will cause it to dump out its namelists into the file
-namelist\&.debug
+\FCnamelist\&.debug \F[]
 in the
-/usr/local/samba/var/locks
+\FC/usr/local/samba/var/locks\F[]
 directory (or the
-var/locks
+\FCvar/locks\F[]
 directory configured under wherever Samba was configured to install itself)\&. This will also cause
-nmbd
+\FCnmbd\F[]
 to dump out its server database in the
-log\&.nmb
+\FClog\&.nmb\F[]
 file\&.
 .PP
@@ -263 +413 @@
 \fBtestparm\fR(1),
 \fBtestprns\fR(1), and the Internet RFC\'s
-rfc1001\&.txt,
-rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
+\FCrfc1001\&.txt\F[],
+\FCrfc1002\&.txt\F[]\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page
 http://samba\&.org/cifs/\&.
 .SH "AUTHOR"