Changeset 429 for trunk/server/docs/manpages/winbindd.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/winbindd.8 (modified) (40 diffs)

trunk/server/docs/manpages/winbindd.8

@@ -1 @@
-'\" t
 .\"     Title: winbindd
 .\"    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 "WINBINDD" "8" "02/19/2010" "Samba 3\&.5" "System Administration tools"
+.TH "WINBINDD" "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"
 winbindd \- Name Service Switch daemon for resolving names from NT servers
-.SH "SYNOPSIS"
+.SH "Synopsis"
+.fam C
 .HP \w'\ 'u
-winbindd [\-D] [\-F] [\-S] [\-i] [\-Y] [\-d\ <debug\ level>] [\-s\ <smb\ config\ file>] [\-n]
+\FCwinbindd\F[] [\-D] [\-F] [\-S] [\-i] [\-Y] [\-d\ <debug\ level>] [\-s\ <smb\ config\ file>] [\-n]
+.fam
 .SH "DESCRIPTION"
 .PP
@@ -30 +180 @@
 suite\&.
 .PP
-winbindd
+\FCwinbindd\F[]
 is a daemon that provides a number of services to the Name Service Switch capability found in most modern C libraries, to arbitrary applications via PAM and
-ntlm_auth
+\FCntlm_auth\F[]
 and to Samba itself\&.
 .PP
 Even if winbind is not used for nsswitch, it still provides a service to
-smbd,
-ntlm_auth
+\FCsmbd\F[],
+\FCntlm_auth\F[]
 and the
-pam_winbind\&.so
+\FCpam_winbind\&.so\F[]
 PAM module, by managing connections to domain controllers\&. In this configuraiton the
 \m[blue]\fBidmap uid\fR\m[]
@@ -47 +197 @@
 .PP
 The Name Service Switch allows user and system information to be obtained from different databases services such as NIS or DNS\&. The exact behaviour can be configured through the
-/etc/nsswitch\&.conf
+\FC/etc/nsswitch\&.conf\F[]
 file\&. Users and groups are allocated as they are resolved to a range of user and group ids specified by the administrator of the Samba system\&.
 .PP
 The service provided by
-winbindd
+\FCwinbindd\F[]
 is called `winbind\' and can be used to resolve user and group information from a Windows NT server\&. The service can also provide authentication services via an associated PAM module\&.
 .PP
 The
-pam_winbind
+\FCpam_winbind\F[]
 module supports the
 \fIauth\fR,
@@ -64 +214 @@
 \fIaccount\fR
 module simply performs a getpwnam() to verify that the system can obtain a uid for the user, as the domain controller has already performed access control\&. If the
-libnss_winbind
+\FClibnss_winbind\F[]
 library has been correctly installed, or an alternate source of names configured, this should always succeed\&.
 .PP
@@ -72 +222 @@
 .RS 4
 If specified, this parameter causes the server to operate as a daemon\&. That is, it detaches itself and runs in the background on the appropriate port\&. This switch is assumed if
-winbindd
+\FCwinbindd\F[]
 is executed on the command line of a shell\&.
 .RE
@@ -79 +229 @@
 .RS 4
 This feature is only available on IRIX\&. User information traditionally stored in the
-hosts(5)
+\FChosts(5)\F[]
 file and used by
-gethostbyname(3)
+\FCgethostbyname(3)\F[]
 functions\&. Names are resolved through the WINS server or by broadcast\&.
 .RE
@@ -88 +238 @@
 .RS 4
 User information traditionally stored in the
-passwd(5)
+\FCpasswd(5)\F[]
 file and used by
-getpwent(3)
+\FCgetpwent(3)\F[]
 functions\&.
 .RE
@@ -97 +247 @@
 .RS 4
 Group information traditionally stored in the
-group(5)
+\FCgroup(5)\F[]
 file and used by
-getgrent(3)
+\FCgetgrent(3)\F[]
 functions\&.
 .RE
 .PP
 For example, the following simple configuration in the
-/etc/nsswitch\&.conf
+\FC/etc/nsswitch\&.conf\F[]
 file can be used to initially resolve user and group information from
-/etc/passwd
+\FC/etc/passwd \F[]
 and
-/etc/group
+\FC/etc/group\F[]
 and then from the Windows NT server\&.
 .sp
@@ -114 +264 @@
 .RS 4
 .\}
+.fam C
+.ps -1
 .nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
 passwd:         files winbind
 group:          files winbind
@@ -122 +280 @@
 hosts:          files dns wins
 
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
 .fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -128 +292 @@
 .PP
 The following simple configuration in the
-/etc/nsswitch\&.conf
+\FC/etc/nsswitch\&.conf\F[]
 file can be used to initially resolve hostnames from
-/etc/hosts
+\FC/etc/hosts\F[]
 and then from the WINS server\&.
 .sp
@@ -136 +300 @@
 .RS 4
 .\}
+.fam C
+.ps -1
 .nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
 hosts:          files wins
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
 .fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -147 +325 @@
 .RS 4
 If specified, this parameter causes the main
-winbindd
+\FCwinbindd\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
-winbindd
+\FCwinbindd\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
@@ -162 +340 @@
 .RS 4
 If specified, this parameter causes
-winbindd
+\FCwinbindd\F[]
 to log to standard output rather than a file\&.
 .RE
@@ -178 +356 @@
 \m[blue]\fB\%smb.conf.5.html#\fR\m[]
 parameter in the
-smb\&.conf
+\FCsmb\&.conf\F[]
 file\&.
 .RE
@@ -190 +368 @@
 .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
@@ -209 +387 @@
 .RS 4
 Tells
-winbindd
+\FCwinbindd\F[]
 to not become a daemon and detach from the current terminal\&. This option is used by developers when interactive debugging of
-winbindd
+\FCwinbindd\F[]
 is required\&.
-winbindd
+\FCwinbindd\F[]
 also logs to standard output, as if the
-\-S
+\FC\-S\F[]
 parameter had been given\&.
 .RE
@@ -231 +409 @@
 .PP
 Users and groups on a Windows NT server are assigned a security id (SID) which is globally unique when the user or group is created\&. To convert the Windows NT user or group into a unix user or group, a mapping between SIDs and unix user and group ids is required\&. This is one of the jobs that
-winbindd
+\FC winbindd\F[]
 performs\&.
 .PP
@@ -240 +418 @@
 .PP
 Configuration of the
-winbindd
+\FCwinbindd\F[]
 daemon is done through configuration parameters in the
 \fBsmb.conf\fR(5)
@@ -381 +559 @@
 .PP
 In
-/etc/nsswitch\&.conf
+\FC/etc/nsswitch\&.conf\F[]
 put the following:
 .sp
@@ -387 +565 @@
 .RS 4
 .\}
+.fam C
+.ps -1
 .nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
 passwd: files winbind
 group:  files winbind
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
 .fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -396 +588 @@
 .PP
 In
-/etc/pam\&.d/*
+\FC/etc/pam\&.d/*\F[]
 replace the
 \fI auth\fR
@@ -404 +596 @@
 .RS 4
 .\}
+.fam C
+.ps -1
 .nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
 auth  required    /lib/security/pam_securetty\&.so
 auth  required    /lib/security/pam_nologin\&.so
@@ -410 +610 @@
 auth  required    /lib/security/pam_unix\&.so \e
                   use_first_pass shadow nullok
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
 .fi
-.if n \{\
-.RE
-.\}
-.sp
-.if n \{\
-.sp
-.\}
-.RS 4
+.fam
+.ps +1
+.if n \{\
+.RE
+.\}
+.sp
+.if n \{\
+.sp
+.\}
+.RS 4
+.BM yellow
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -430 +637 @@
 The PAM module pam_unix has recently replaced the module pam_pwdb\&. Some Linux systems use the module pam_unix2 in place of pam_unix\&.
 .sp .5v
+.EM yellow
 .RE
 .PP
@@ -440 +648 @@
 Now replace the account lines with this:
 .PP
-account required /lib/security/pam_winbind\&.so
+\FCaccount required /lib/security/pam_winbind\&.so \F[]
 .PP
 The next step is to join the domain\&. To do that use the
-net
+\FCnet\F[]
 program like this:
 .PP
-net join \-S PDC \-U Administrator
+\FCnet join \-S PDC \-U Administrator\F[]
 .PP
 The username after the
@@ -453 +661 @@
 .PP
 Next copy
-libnss_winbind\&.so
+\FClibnss_winbind\&.so\F[]
 to
-/lib
+\FC/lib\F[]
 and
-pam_winbind\&.so
+\FCpam_winbind\&.so \F[]
 to
-/lib/security\&. A symbolic link needs to be made from
-/lib/libnss_winbind\&.so
+\FC/lib/security\F[]\&. A symbolic link needs to be made from
+\FC/lib/libnss_winbind\&.so\F[]
 to
-/lib/libnss_winbind\&.so\&.2\&. If you are using an older version of glibc then the target of the link should be
-/lib/libnss_winbind\&.so\&.1\&.
+\FC/lib/libnss_winbind\&.so\&.2\F[]\&. If you are using an older version of glibc then the target of the link should be
+\FC/lib/libnss_winbind\&.so\&.1\F[]\&.
 .PP
 Finally, setup a
@@ -472 +680 @@
 .RS 4
 .\}
+.fam C
+.ps -1
 .nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
 [global]
         winbind separator = +
@@ -483 +699 @@
         security = domain
         password server = *
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
 .fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -489 +711 @@
 .PP
 Now start winbindd and you should find that your user and group database is expanded to include your NT users and groups, and that you can login to your unix box as a domain user, using the DOMAIN+user syntax for the username\&. You may wish to use the commands
-getent passwd
+\FCgetent passwd\F[]
 and
-getent group
+\FCgetent group \F[]
 to confirm the correct operation of winbindd\&.
 .SH "NOTES"
 .PP
 The following notes are useful when configuring and running
-winbindd:
+\FCwinbindd\F[]:
 .PP
 \fBnmbd\fR(8)
 must be running on the local machine for
-winbindd
+\FCwinbindd\F[]
 to work\&.
 .PP
@@ -506 +728 @@
 .PP
 If more than one UNIX machine is running
-winbindd, then in general the user and groups ids allocated by winbindd will not be the same\&. The user and group ids will only be valid for the local machine, unless a shared
+\FCwinbindd\F[], then in general the user and groups ids allocated by winbindd will not be the same\&. The user and group ids will only be valid for the local machine, unless a shared
 \m[blue]\fBidmap backend\fR\m[]
 is configured\&.
@@ -514 +736 @@
 .PP
 The following signals can be used to manipulate the
-winbindd
+\FCwinbindd\F[]
 daemon\&.
 .PP
@@ -527 +749 @@
 .RS 4
 The SIGUSR2 signal will cause
-winbindd
+\FC winbindd\F[]
 to write status information to the winbind log file\&.
 .sp
@@ -534 +756 @@
 .SH "FILES"
 .PP
-/etc/nsswitch\&.conf(5)
+\FC/etc/nsswitch\&.conf(5)\F[]
 .RS 4
 Name service switch configuration file\&.
@@ -542 +764 @@
 .RS 4
 The UNIX pipe over which clients communicate with the
-winbindd
+\FCwinbindd\F[]
 program\&. For security reasons, the winbind client will only attempt to connect to the winbindd daemon if both the
-/tmp/\&.winbindd
+\FC/tmp/\&.winbindd\F[]
 directory and
-/tmp/\&.winbindd/pipe
+\FC/tmp/\&.winbindd/pipe\F[]
 file are owned by root\&.
 .RE
@@ -553 +775 @@
 .RS 4
 The UNIX pipe over which \'privileged\' clients communicate with the
-winbindd
+\FCwinbindd\F[]
 program\&. For security reasons, access to some winbindd functions \- like those needed by the
-ntlm_auth
+\FCntlm_auth\F[]
 utility \- is restricted\&. By default, only users in the \'root\' group will get this access, however the administrator may change the group permissions on $LOCKDIR/winbindd_privileged to allow programs like \'squid\' to use ntlm_auth\&. Note that the winbind client will only attempt to connect to the winbindd daemon if both the
-$LOCKDIR/winbindd_privileged
+\FC$LOCKDIR/winbindd_privileged\F[]
 directory and
-$LOCKDIR/winbindd_privileged/pipe
+\FC$LOCKDIR/winbindd_privileged/pipe\F[]
 file are owned by root\&.
 .RE
@@ -573 +795 @@
 \fI\-\-with\-lockdir\fR
 option\&. This directory is by default
-/usr/local/samba/var/locks\&.
+\FC/usr/local/samba/var/locks \F[]\&.
 .RE
 .PP
@@ -585 +807 @@
 .SH "SEE ALSO"
 .PP
-nsswitch\&.conf(5),
+\FCnsswitch\&.conf(5)\F[],
 \fBsamba\fR(7),
 \fBwbinfo\fR(1),
@@ -595 +817 @@
 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\&.
 .PP
-wbinfo
+\FCwbinfo\F[]
 and
-winbindd
+\FCwinbindd\F[]
 were written by Tim Potter\&.
 .PP