[Midnightbsd-cvs] src: man/man5: update man pages
laffer1 at midnightbsd.org
laffer1 at midnightbsd.org
Sun Mar 29 15:29:31 EDT 2009
Log Message:
-----------
update man pages
Modified Files:
--------------
src/share/man/man5:
linprocfs.5 (r1.1.1.1 -> r1.2)
mailer.conf.5 (r1.1.1.1 -> r1.2)
msdosfs.5 (r1.1.1.1 -> r1.2)
nsswitch.conf.5 (r1.1.1.1 -> r1.2)
passwd.5 (r1.1.1.1 -> r1.2)
procfs.5 (r1.1.1.1 -> r1.2)
quota.user.5 (r1.1.1.1 -> r1.2)
style.Makefile.5 (r1.1.1.2 -> r1.2)
-------------- next part --------------
Index: mailer.conf.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/mailer.conf.5,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -L share/man/man5/mailer.conf.5 -L share/man/man5/mailer.conf.5 -u -r1.1.1.1 -r1.2
--- share/man/man5/mailer.conf.5
+++ share/man/man5/mailer.conf.5
@@ -29,9 +29,9 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $FreeBSD: src/share/man/man5/mailer.conf.5,v 1.11 2005/02/09 18:07:16 ru Exp $
+.\" $FreeBSD: src/share/man/man5/mailer.conf.5,v 1.13 2006/09/18 15:24:19 ru Exp $
.\"
-.Dd December 16, 1998
+.Dd May 31, 2006
.Dt MAILER.CONF 5
.Os
.Sh NAME
@@ -41,29 +41,58 @@
.Sh DESCRIPTION
The file
.Pa /etc/mail/mailer.conf
-contains a series of pairs.
-The first member of each pair is the name
+contains a series of lines of the form
+.Pp
+.Ar name
+.Ar program
+.Op Ar arguments ...
+.Pp
+The first word of each line is the
+.Ar name
of a program invoking
-.Xr mailwrapper 8
-which is typically a symbolic link to
-.Pa /usr/sbin/sendmail .
-(On a typical system,
+.Xr mailwrapper 8 .
+(For example, on a typical system
+.Pa /usr/sbin/sendmail
+would be a symbolic link to
+.Xr mailwrapper 8 ,
+as would
.Xr newaliases 1
and
-.Xr mailq 1
-would be set up this way.)
-The second member of each pair is the name of the program to
-actually execute when the first name is invoked.
-The file may also
-contain comments, denoted by a # mark in the first column of any line.
+.Xr mailq 1 .
+Thus,
+.Ar name
+might be
+.Dq Li sendmail
+or
+.Dq Li newaliases
+etc.)
+.Pp
+The second word of each line is the name of the
+.Ar program
+to actually execute when the first name is invoked.
+.Pp
+The further
+.Ar arguments ,
+if any, are passed to the
+.Ar program ,
+followed by the arguments
+.Xr mailwrapper 8
+was called with.
+.Pp
+The file may also contain comment lines, denoted by a
+.Ql #
+mark in the first column of any line.
.Sh FILES
/etc/mail/mailer.conf
.Sh EXAMPLES
-The following is an example of how to set up an
+This example shows how to set up
.Nm
-for traditional sendmail invocation behavior.
-.Bd -literal
-# Execute the "real" sendmail program, named /usr/libexec/sendmail/sendmail
+to invoke the traditional
+.Xr sendmail 8
+program:
+.Bd -literal -offset indent
+# Execute the "real" sendmail program located in
+# /usr/libexec/sendmail/sendmail
sendmail /usr/libexec/sendmail/sendmail
send-mail /usr/libexec/sendmail/sendmail
mailq /usr/libexec/sendmail/sendmail
@@ -71,20 +100,35 @@
.Ed
.Pp
This example shows how to invoke a sendmail-workalike like Postfix in
-place of sendmail.
-.Bd -literal
+place of
+.Xr sendmail 8 :
+.Bd -literal -offset indent
# Emulate sendmail using postfix
sendmail /usr/local/sbin/sendmail
send-mail /usr/local/sbin/sendmail
mailq /usr/local/sbin/sendmail
newaliases /usr/local/sbin/sendmail
.Ed
+.Pp
+This example shows the use of the
+.Nm mini_sendmail
+package from ports in place of
+.Xr sendmail 8 .
+Note the use of additional arguments.
+.Bd -literal -offset indent
+# Send outgoing mail to a smart relay using mini_sendmail
+sendmail /usr/local/bin/mini_sendmail -srelayhost
+send-mail /usr/local/bin/mini_sendmail -srelayhost
+.Ed
.Sh SEE ALSO
.Xr mail 1 ,
.Xr mailq 1 ,
.Xr newaliases 1 ,
.Xr mailwrapper 8 ,
.Xr sendmail 8
+.Pp
+.Xr postfix 1 Pq Pa ports/mail/postfix ,
+.Xr mini_sendmail 8 Pq Pa ports/mail/mini_sendmail
.Sh HISTORY
.Nm
appeared in
Index: quota.user.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/quota.user.5,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -L share/man/man5/quota.user.5 -L share/man/man5/quota.user.5 -u -r1.1.1.1 -r1.2
--- share/man/man5/quota.user.5
+++ share/man/man5/quota.user.5
@@ -21,9 +21,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $FreeBSD: src/share/man/man5/quota.user.5,v 1.3 2002/12/12 17:25:57 ru Exp $
+.\" $FreeBSD: src/share/man/man5/quota.user.5,v 1.4 2007/02/04 07:44:40 mpp Exp $
.\"
-.Dd February 22, 2001
+.Dd February 3, 2007
.Dt QUOTA.USER 5
.Os
.Sh NAME
@@ -39,8 +39,90 @@
.Xr quotacheck 8 ,
and should be edited with
.Xr edquota 8 .
+It is possible to specify a different location and file name with the
+.Dq Li userquota
+and
+.Dq Li groupquota
+options in the
+.Xr fstab 5
+file.
+.Pp
+.Pp
+The data files contain the following information:
+.Pp
+.Bl -bullet -indent offset -compact
+.It
+Current block usage
+.It
+Current number of files
+.It
+Soft block limit
+.It
+Soft file limit
+.It
+Hard block limit
+.It
+Hard file limit
+.It
+Block grace time remaining if over the soft limit
+.It
+File grace time remaining if over the soft limit
+.El
+.Pp
+.Pp
+See
+.Xr edquota 8
+for an explanation on the various limits and grace periods.
+.Pp
+During normal quota operations the
+.Xr quotactl 2
+interface is used to query or set quota information and the kernel
+will maintain the data files as needed.
+If quotas are disabled on
+a file system, but marked as having quotas enabled in
+.Xr fstab 5 ,
+then the quota data files will be used directly.
+.Pp
+The data files are stored as an array of
+.Dq Li struct dqblk
+structures, as defined in
+.In ufs/ufs/quota.h ,
+and indexed by UID or GID.
+The data files will be written as a sparse file if possible.
+Data is only maintained for ids that have either non-zero usage or
+non-zero quota limits.
+If an attempt is made to access data for an id that would exist past the
+end of the current data file, a quota structure with all values set
+to zero will be created, and the data file extended as needed.
+The
+.Xr quotacheck 8
+utility will truncate the data files to the minimum size needed
+to store the highest id with either non-zero file usage or
+non-zero quota limits.
+.Pp
+The data record for id 0 has special meaning. If the
+.Dq Dv dqb_btime
+or
+.Dq Dv dbq_itime
+fields are non-zero, they are used to indicate the grace period on
+that file system for users who have exceeded their soft limit.
+These times can be set by
+.Xr edquota 8
+with the
+.Fl t
+flag.
+If no explicit grace period has been set with
+.Xr edquota 8 ,
+then the default value of 7 days will be used.
+The default values are defined by
+.Dv MAX_DQ_TIME
+and
+.Dv MAX_IQ_TIME
+in
+.In ufs/ufs/quota.h .
.Sh SEE ALSO
.Xr quota 1 ,
+.Xr quotactl 2 ,
.Xr fstab 5 ,
.Xr edquota 8 ,
.Xr quotacheck 8 ,
Index: nsswitch.conf.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/nsswitch.conf.5,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -L share/man/man5/nsswitch.conf.5 -L share/man/man5/nsswitch.conf.5 -u -r1.1.1.1 -r1.2
--- share/man/man5/nsswitch.conf.5
+++ share/man/man5/nsswitch.conf.5
@@ -31,9 +31,9 @@
.\" TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
.\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $FreeBSD: src/share/man/man5/nsswitch.conf.5,v 1.13 2005/04/24 20:24:59 bz Exp $
+.\" $FreeBSD: src/share/man/man5/nsswitch.conf.5,v 1.17.2.1 2007/10/19 00:18:19 bushman Exp $
.\"
-.Dd April 24, 2005
+.Dd January 22, 2007
.Dt NSSWITCH.CONF 5
.Os
.Sh NAME
@@ -48,9 +48,9 @@
.Pp
The configuration file controls how a process looks up various databases
containing information regarding hosts, users (passwords), groups, etc.
-Each database comes from a source (such as local files, DNS, and
-.Tn NIS ) ,
-and the order to look up the sources is specified in
+Each database comes from a source (such as local files, DNS,
+.Tn NIS ,
+and cache), and the order to look up the sources is specified in
.Nm .
.Pp
Each entry in
@@ -93,6 +93,10 @@
.Dq group
databases.
If this is present, it must be the only source for that entry.
+.It cache
+makes use of the
+.Xr nscd 8
+daemon.
.El
.Ss Databases
The following databases are used by the following C library functions:
@@ -101,15 +105,45 @@
.It Sy Database
.Sy "Used by"
.It group
-.Xr getgrent 3
+.Xr getgrent 3 ,
+.Xr getgrent_r 3 ,
+.Xr getgrgid_r 3 ,
+.Xr getgrnam_r 3 ,
+.Xr setgrent 3 ,
+.Xr endgrent 3
.It hosts
-.Xr gethostbyname 3
+.Xr getaddrinfo 3 ,
+.Xr gethostbyaddr 3 ,
+.Xr gethostbyaddr_r 3 ,
+.Xr gethostbyname 3 ,
+.Xr gethostbyname2 3 ,
+.Xr gethostbyname_r 3 ,
+.Xr getipnodebyaddr 3 ,
+.Xr getipnodebyname 3
.It networks
-.Xr getnetbyname 3
+.Xr getnetbyaddr 3 ,
+.Xr getnetbyaddr_r 3 ,
+.Xr getnetbyname 3 ,
+.Xr getnetbyname_r 3
.It passwd
-.Xr getpwent 3
+.Xr getpwent 3 ,
+.Xr getpwent_r 3 ,
+.Xr getpwnam_r 3 ,
+.Xr getpwuid_r 3 ,
+.Xr setpwent 3 ,
+.Xr endpwent 3
.It shells
.Xr getusershell 3
+.It services
+.Xr getservent 3
+.It rpc
+.Xr getrpcbyname 3 ,
+.Xr getrpcbynumber 3 ,
+.Xr getrpcent 3
+.It proto
+.Xr getprotobyname 3
+.Xr getprotobynumber 3 ,
+.Xr getprotoent 3
.El
.Ss Status codes
The following status codes are available:
@@ -177,6 +211,25 @@
.Dq success ,
and continue on anything else (i.e,
.Li "[success=return notfound=continue unavail=continue tryagain=continue]" ) .
+.Ss Cache
+You can enable caching for the particular database by specifying
+.Dq cache
+as the first source in the
+.Xr nsswitch.conf 5
+file.
+You should also enable caching for this database in
+.Xr nscd.conf 5 .
+If for the particular query
+.Dq cache
+source returns success, no further sources are queried.
+On the other hand, if there are no previously cached data, the
+query result will be placed into the cache right after
+all other sources are processed.
+Note, that
+.Dq cache
+requires
+.Xr nscd 8
+daemon to be running.
.Ss Compat mode: +/- syntax
In historical multi-source implementations, the
.Sq +
@@ -231,7 +284,7 @@
for the requested database.
Exceptions are:
.Pp
-.Bl -tag -width passwd_compat -compact
+.Bl -tag -width services_compat -compact
.It Sy Database
.Sy "Default source list"
.It group
@@ -244,6 +297,10 @@
compat
.It passwd_compat
nis
+.It services
+compat
+.It services_compat
+nis
.El
.Sh FILES
.Bl -tag -width /etc/nsswitch.conf -compact
@@ -254,7 +311,7 @@
.Pa /etc .
.El
.Sh EXAMPLES
-To lookup hosts in
+To lookup hosts in cache, then in
.Pa /etc/hosts
and then from the DNS, and lookup user information from
.Tn NIS
@@ -262,7 +319,7 @@
.Pp
.Bl -tag -width passwd: -compact
.It hosts:
-files dns
+cache files dns
.It passwd:
nis [notfound=return] files
.It group:
@@ -276,13 +333,29 @@
when the server is down.
.Sh NOTES
If system got compiled with
-.Va NO_NIS
+.Va WITHOUT_NIS
you have to remove
.Sq nis
entries.
+.Pp
+.Fx Ns 's
+.Lb libc
+provides stubs for compatibility with NSS modules
+written for the
+.Tn GNU
+C Library
+.Nm nsswitch
+interface.
+However, these stubs only support the use of the
+.Dq Li passwd
+and
+.Dq Li group
+databases.
.Sh SEE ALSO
.Xr nsdispatch 3 ,
+.Xr nscd.conf 5 ,
.Xr resolv.conf 5 ,
+.Xr nscd 8 ,
.Xr named 8 ,
.Xr ypbind 8
.Sh HISTORY
Index: msdosfs.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/msdosfs.5,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -L share/man/man5/msdosfs.5 -L share/man/man5/msdosfs.5 -u -r1.1.1.1 -r1.2
--- share/man/man5/msdosfs.5
+++ share/man/man5/msdosfs.5
@@ -1,8 +1,8 @@
-.\" $FreeBSD: src/share/man/man5/msdosfs.5,v 1.4.12.1 2005/09/24 01:59:38 keramida Exp $
+.\" $FreeBSD: src/share/man/man5/msdosfs.5,v 1.6 2007/08/22 18:04:08 gabor Exp $
.\" Written by Tom Rhodes
.\" This file is in the public domain.
.\"
-.Dd December 26, 2002
+.Dd Aug 22, 2007
.Dt MSDOSFS 5
.Os
.Sh NAME
@@ -21,7 +21,7 @@
.Pp
The most common usage follows:
.Pp
-.Dl "mount_msdosfs /dev/ad0sN /mnt"
+.Dl "mount -t msdosfs /dev/ad0sN /mnt"
.Pp
where
.Ar N
Index: linprocfs.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/linprocfs.5,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -L share/man/man5/linprocfs.5 -L share/man/man5/linprocfs.5 -u -r1.1.1.1 -r1.2
--- share/man/man5/linprocfs.5
+++ share/man/man5/linprocfs.5
@@ -1,4 +1,4 @@
-.\" $FreeBSD: src/share/man/man5/linprocfs.5,v 1.13 2005/01/21 08:36:39 ru Exp $
+.\" $FreeBSD: src/share/man/man5/linprocfs.5,v 1.15 2006/09/18 15:24:19 ru Exp $
.\" Written by Garrett Wollman
.\" This file is in the public domain.
.\"
@@ -65,11 +65,17 @@
.It Pa /compat/linux/proc/self/mem
The complete virtual address space of the current process.
.El
+.Sh EXAMPLES
+To mount a
+.Nm
+file system on
+.Pa /compat/linux/proc :
+.Pp
+.Dl "mount -t linprocfs linproc /compat/linux/proc"
.Sh SEE ALSO
.Xr mount 2 ,
.Xr unmount 2 ,
.Xr procfs 5 ,
-.Xr mount_linprocfs 8 ,
.Xr pseudofs 9
.Sh HISTORY
The
Index: procfs.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/procfs.5,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -L share/man/man5/procfs.5 -L share/man/man5/procfs.5 -u -r1.1.1.1 -r1.2
--- share/man/man5/procfs.5
+++ share/man/man5/procfs.5
@@ -1,4 +1,4 @@
-.\" $FreeBSD: src/share/man/man5/procfs.5,v 1.32 2004/09/03 18:56:59 alfred Exp $
+.\" $FreeBSD: src/share/man/man5/procfs.5,v 1.33 2006/05/19 00:23:29 rodrigc Exp $
.\" Written by Garrett Wollman
.\" This file is in the public domain.
.\"
@@ -244,11 +244,17 @@
.It Pa /proc/curproc/status
the process' current status
.El
+.Sh EXAMPLES
+To mount a
+.Nm
+file system on
+.Pa /proc :
+.Pp
+.Dl "mount -t procfs proc /proc"
.Sh SEE ALSO
.Xr mount 2 ,
.Xr sigaction 2 ,
.Xr unmount 2 ,
-.Xr mount_procfs 8 ,
.Xr procctl 8 ,
.Xr pseudofs 9
.Sh AUTHORS
Index: style.Makefile.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/style.Makefile.5,v
retrieving revision 1.1.1.2
retrieving revision 1.2
diff -L share/man/man5/style.Makefile.5 -L share/man/man5/style.Makefile.5 -u -r1.1.1.2 -r1.2
--- share/man/man5/style.Makefile.5
+++ share/man/man5/style.Makefile.5
@@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $FreeBSD: src/share/man/man5/style.Makefile.5,v 1.15.2.1 2006/01/22 16:33:46 yar Exp $
+.\" $FreeBSD: src/share/man/man5/style.Makefile.5,v 1.16 2005/10/10 14:55:58 yar Exp $
.\"
.Dd January 8, 2005
.Dt STYLE.MAKEFILE 5
Index: passwd.5
===================================================================
RCS file: /home/cvs/src/share/man/man5/passwd.5,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -L share/man/man5/passwd.5 -L share/man/man5/passwd.5 -u -r1.1.1.1 -r1.2
--- share/man/man5/passwd.5
+++ share/man/man5/passwd.5
@@ -33,9 +33,9 @@
.\" SUCH DAMAGE.
.\"
.\" From: @(#)passwd.5 8.1 (Berkeley) 6/5/93
-.\" $FreeBSD: src/share/man/man5/passwd.5,v 1.44.2.1 2005/09/24 01:59:38 keramida Exp $
+.\" $FreeBSD: src/share/man/man5/passwd.5,v 1.50 2007/05/08 11:00:07 yar Exp $
.\"
-.Dd February 8, 2005
+.Dd May 8, 2007
.Dt PASSWD 5
.Os
.Sh NAME
@@ -47,17 +47,17 @@
.Nm
files are the local source of password information.
They can be used in conjunction with the Hesiod domains
-.Sq passwd
+.Sq Li passwd
and
-.Sq uid ,
+.Sq Li uid ,
and the
.Tn NIS
maps
-.Sq passwd.byname ,
-.Sq passwd.byuid ,
-.Sq master.passwd.byname ,
+.Sq Li passwd.byname ,
+.Sq Li passwd.byuid ,
+.Sq Li master.passwd.byname ,
and
-.Sq master.passwd.byuid ,
+.Sq Li master.passwd.byuid ,
as controlled by
.Xr nsswitch.conf 5 .
.Pp
@@ -67,32 +67,34 @@
The
.Nm master.passwd
file is readable only by root, and consists of newline separated
-records, one per user, containing ten colon (``:'') separated
+records, one per user, containing ten colon
+.Pq Ql \&:
+separated
fields.
These fields are as follows:
.Pp
-.Bl -tag -width password -offset indent
-.It name
+.Bl -tag -width ".Ar password" -offset indent
+.It Ar name
User's login name.
-.It password
+.It Ar password
User's
.Em encrypted
password.
-.It uid
+.It Ar uid
User's id.
-.It gid
+.It Ar gid
User's login group id.
-.It class
+.It Ar class
User's login class.
-.It change
+.It Ar change
Password change time.
-.It expire
+.It Ar expire
Account expiration time.
-.It gecos
+.It Ar gecos
General information about the user.
-.It home_dir
+.It Ar home_dir
User's home directory.
-.It shell
+.It Ar shell
User's login shell.
.El
.Pp
@@ -102,22 +104,16 @@
.Nm master.passwd
file by
.Xr pwd_mkdb 8 ,
-has the class, change, and expire fields removed, and the password
+has the
+.Ar class ,
+.Ar change ,
+and
+.Ar expire
+fields removed, and the
+.Ar password
field replaced by a
.Ql *
character.
-In the
-.Nm master.passwd
-file, a password of
-.Ql *
-is used to indicate that no one can ever log into that account
-using password authentication (logins through other forms of
-authentication, i.e.\& using
-.Xr ssh 1
-keys, will still work).
-The field only contains encrypted passwords, and
-.Ql *
-can never be the result of encrypting a password.
.Pp
The
.Ar name
@@ -134,14 +130,25 @@
that manipulate these files will often return only one of the multiple
entries, and that one by random selection.
.Pp
-The login name must never begin with a hyphen (``-''); also, it is strongly
-suggested that neither upper-case characters or dots (``.'') be part
+The login name must never begin with a hyphen
+.Pq Ql - ;
+also, it is strongly
+suggested that neither upper-case characters or dots
+.Pq Ql \&.
+be part
of the name, as this tends to confuse mailers.
No field may contain a
-colon (``:'') as this has been used historically to separate the fields
+colon
+.Pq Ql \&:
+as this has been used historically to separate the fields
in the user database.
.Pp
-The password field is the
+In the
+.Nm master.passwd
+file,
+the
+.Ar password
+field is the
.Em encrypted
form of the password, see
.Xr crypt 3 .
@@ -149,11 +156,33 @@
.Ar password
field is empty, no password will be required to gain access to the
machine.
-This is almost invariably a mistake.
-Because these files contain the encrypted user passwords, they should
+This is almost invariably a mistake, so authentication components
+such as PAM can forcibly disallow remote access to passwordless accounts.
+Because this file contains the encrypted user passwords, it should
not be readable by anyone without appropriate privileges.
.Pp
-The group field is the group that the user will be placed in upon login.
+A password of
+.Ql *
+indicates that
+password authentication is disabled for that account
+(logins through other forms of
+authentication, e.g., using
+.Xr ssh 1
+keys, will still work).
+The field only contains encrypted passwords, and
+.Ql *
+can never be the result of encrypting a password.
+.Pp
+An encrypted password prefixed by
+.Ql *LOCKED*
+means that the account is temporarily locked out
+and no one can log into it using any authentication.
+For a convenient command-line interface to account locking, see
+.Xr pw 8 .
+.Pp
+The
+.Ar group
+field is the group that the user will be placed in upon login.
Since this system supports multiple groups (see
.Xr groups 1 )
this field currently has little special meaning.
@@ -187,93 +216,121 @@
.Pp
The
.Ar gecos
-field normally contains comma (``,'') separated subfields as follows:
+field normally contains comma
+.Pq Ql \&,
+separated subfields as follows:
.Pp
-.Bl -tag -width office -offset indent -compact
-.It name
+.Bl -tag -width ".Ar office" -offset indent -compact
+.It Ar name
user's full name
-.It office
+.It Ar office
user's office number
-.It wphone
+.It Ar wphone
user's work phone number
-.It hphone
+.It Ar hphone
user's home phone number
.El
.Pp
-The full name may contain a ampersand (``&'') which will be replaced by
-the capitalized login name when the gecos field is displayed or used
+The full
+.Ar name
+may contain a ampersand
+.Pq Ql &
+which will be replaced by
+the capitalized login
+.Ar name
+when the
+.Ar gecos
+field is displayed or used
by various programs such as
.Xr finger 1 ,
.Xr sendmail 8 ,
etc.
.Pp
-The office and phone number subfields are used by the
+The
+.Ar office
+and phone number subfields are used by the
.Xr finger 1
program, and possibly other applications.
.Pp
-The user's home directory is the full
+The user's home directory,
+.Ar home_dir ,
+is the full
.Ux
path name where the user
will be placed on login.
.Pp
-The shell field is the command interpreter the user prefers.
+The
+.Ar shell
+field is the command interpreter the user prefers.
If there is nothing in the
.Ar shell
field, the Bourne shell
.Pq Pa /bin/sh
is assumed.
+The conventional way to disable logging into an account once and for all,
+as it is done for system accounts,
+is to set its
+.Ar shell
+to
+.Xr nologin 8 .
.Sh HESIOD SUPPORT
If
-.Sq dns
+.Sq Li dns
is specified for the
-.Sq passwd
+.Sq Li passwd
database in
.Xr nsswitch.conf 5 ,
then
.Nm
lookups occur from the
-.Sq passwd
+.Sq Li passwd
Hesiod domain.
.Sh NIS SUPPORT
If
-.Sq nis
+.Sq Li nis
is specified for the
-.Sq passwd
+.Sq Li passwd
database in
.Xr nsswitch.conf 5 ,
then
.Nm
lookups occur from the
-.Sq passwd.byname ,
-.Sq passwd.byuid ,
-.Sq master.passwd.byname ,
+.Sq Li passwd.byname ,
+.Sq Li passwd.byuid ,
+.Sq Li master.passwd.byname ,
and
-.Sq master.passwd.byuid
+.Sq Li master.passwd.byuid
.Tn NIS
maps.
.Sh COMPAT SUPPORT
If
-.Sq compat
+.Sq Li compat
is specified for the
-.Sq passwd
+.Sq Li passwd
database, and either
-.Sq dns
+.Sq Li dns
or
-.Sq nis
+.Sq Li nis
is specified for the
-.Sq passwd_compat
+.Sq Li passwd_compat
database in
.Xr nsswitch.conf 5 ,
then the
.Nm
file also supports standard
-.Sq +/-
+.Sq Li + Ns / Ns Li -
exclusions and inclusions, based on user names and netgroups.
.Pp
-Lines beginning with a ``-'' (minus sign) are entries marked as being excluded
-from any following inclusions, which are marked with a ``+'' (plus sign).
-.Pp
-If the second character of the line is a ``@'' (at sign), the operation
+Lines beginning with a
+.Ql -
+(minus sign) are entries marked as being excluded
+from any following inclusions, which are marked with a
+.Ql +
+(plus sign).
+.Pp
+If the second character of the line is a
+.Ql @
+(at sign), the operation
involves the user fields of all entries in the netgroup specified by the
remaining characters of the
.Ar name
@@ -282,19 +339,21 @@
.Ar name
field is assumed to be a specific user name.
.Pp
-The ``+'' token may also be alone in the
+The
+.Ql +
+token may also be alone in the
.Ar name
field, which causes all users from either the Hesiod domain
.Nm
(with
-.Sq passwd_compat: dns )
+.Sq Li passwd_compat: dns )
or
-.Sq passwd.byname
+.Sq Li passwd.byname
and
-.Sq passwd.byuid
+.Sq Li passwd.byuid
.Tn NIS
maps (with
-.Sq passwd_compat: nis )
+.Sq Li passwd_compat: nis )
to be included.
.Pp
If the entry contains non-empty
@@ -337,10 +396,10 @@
The following awk script can be used to convert your old-style password
file into a new style password file.
The additional fields
-.Dq class ,
-.Dq change
+.Ar class ,
+.Ar change
and
-.Dq expire
+.Ar expire
are added, but are turned off by default.
Class is currently not implemented, but change and expire are; to set them,
use the current day in seconds from the epoch + whatever number of seconds
@@ -357,7 +416,9 @@
.Xr getpwent 3 ,
.Xr login.conf 5 ,
.Xr netgroup 5 ,
+.Xr nsswitch.conf 5 ,
.Xr adduser 8 ,
+.Xr nologin 8 ,
.Xr pw 8 ,
.Xr pwd_mkdb 8 ,
.Xr vipw 8 ,
@@ -386,6 +447,6 @@
User information should (and eventually will) be stored elsewhere.
.Pp
Placing
-.Sq compat
+.Sq Li compat
exclusions in the file after any inclusions will have
unexpected results.
More information about the Midnightbsd-cvs
mailing list