Remove a death threat from the FreeBSD sources

[pw-darwin.git] / pw / pw.conf.5

diff --git a/pw/pw.conf.5 b/pw/pw.conf.5
index 7c91dd30498816318124f27ac8b5140bafe89c26..61c40e87c11abfced27411b6eee1e5666c06a8b8 100644 (file)
--- a/pw/pw.conf.5
+++ b/pw/pw.conf.5
@@ -1,6 +1,6 @@
 .\" Copyright (C) 1996
 .\" David L. Nugent.  All rights reserved.
 .\" Copyright (C) 1996
 .\" David L. Nugent.  All rights reserved.

-.\" 
+.\"

 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:


@@ -9,7 +9,7 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.

-.\" 
+.\"

 .\" THIS SOFTWARE IS PROVIDED BY DAVID L. NUGENT AND CONTRIBUTORS ``AS IS'' AND
 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 .\" THIS SOFTWARE IS PROVIDED BY DAVID L. NUGENT AND CONTRIBUTORS ``AS IS'' AND
 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE


@@ -24,21 +24,21 @@
 .\"
 .\" $FreeBSD$
 .\"
 .\"
 .\" $FreeBSD$
 .\"

-.Dd December 9, 1996
+.Dd March 30, 2007

 .Dt PW.CONF 5
 .Dt PW.CONF 5

-.Os 
+.Os

 .Sh NAME
 .Nm pw.conf
 .Nd format of the pw.conf configuration file
 .Sh DESCRIPTION
 The file
 .Sh NAME
 .Nm pw.conf
 .Nd format of the pw.conf configuration file
 .Sh DESCRIPTION
 The file

-.Aq Pa /etc/pw.conf
+.Pa /etc/pw.conf

 contains configuration data for the
 .Xr pw 8
 contains configuration data for the
 .Xr pw 8

-program.
+utility.

 The
 .Xr pw 8
 The
 .Xr pw 8

-program is used for maintenance of the system password and group
+utility is used for maintenance of the system password and group

 files, allowing users and groups to be added, deleted and changed.
 This file may be modified via the
 .Xr pw 8
 files, allowing users and groups to be added, deleted and changed.
 This file may be modified via the
 .Xr pw 8


@@ -49,14 +49,14 @@ command and the
 option, or by editing it directly with a text editor.
 .Pp
 Each line in
 option, or by editing it directly with a text editor.
 .Pp
 Each line in

-.Aq Pa /etc/pw.conf
+.Pa /etc/pw.conf

 is treated either a comment or as configuration data;
 blank lines and lines commencing with a
 .Ql \&#
 character are considered comments, and any remaining lines are
 examined for a leading keyword, followed by corresponding data.
 .Pp
 is treated either a comment or as configuration data;
 blank lines and lines commencing with a
 .Ql \&#
 character are considered comments, and any remaining lines are
 examined for a leading keyword, followed by corresponding data.
 .Pp

-Keywords recognized by 
+Keywords recognized by

 .Xr pw 8
 are:
 .Bl -tag -width password_days -offset indent -compact
 .Xr pw 8
 are:
 .Bl -tag -width password_days -offset indent -compact


@@ -67,7 +67,9 @@ reuse gaps in uid sequences
 .It reusegids
 reuse gaps in gid sequences
 .It nispasswd
 .It reusegids
 reuse gaps in gid sequences
 .It nispasswd

-path to the NIS passwd database
+path to the
+.Tn NIS
+passwd database

 .It skeleton
 where to obtain default home contents
 .It newmail
 .It skeleton
 where to obtain default home contents
 .It newmail


@@ -76,6 +78,8 @@ mail to send to new users
 log user/group modifications to this file
 .It home
 root directory for home directories
 log user/group modifications to this file
 .It home
 root directory for home directories

+.It homemode
+permissions for home directory

 .It shellpath
 paths in which to locate shell programs
 .It shells
 .It shellpath
 paths in which to locate shell programs
 .It shells


@@ -124,8 +128,9 @@ The final option causes
 .Xr pw 8
 to respond by printing a randomly generated password on stdout.
 This is the preferred and most secure option.
 .Xr pw 8
 to respond by printing a randomly generated password on stdout.
 This is the preferred and most secure option.

-.Xr Pw 8
-also provides a method of setting a specific password for the new
+The
+.Xr pw 8
+utility also provides a method of setting a specific password for the new

 user via a filehandle (command lines are not secure).
 .Pp
 Both
 user via a filehandle (command lines are not secure).
 .Pp
 Both


@@ -154,7 +159,9 @@ user's uid and gid the same.
 If the new user's uid is currently in use as a group id, then the next
 available group id is chosen instead.
 .Pp
 If the new user's uid is currently in use as a group id, then the next
 available group id is chosen instead.
 .Pp

-On NIS servers which maintain a separate passwd database to
+On
+.Tn NIS
+servers which maintain a separate passwd database to

 .Pa /etc/master.passwd ,
 this option allows the additional file to be concurrently updated
 as user records are added, modified or removed.
 .Pa /etc/master.passwd ,
 this option allows the additional file to be concurrently updated
 as user records are added, modified or removed.


@@ -168,7 +175,8 @@ new home directory is constructed.
 This is
 .Pa /usr/share/skel
 by default.
 This is
 .Pa /usr/share/skel
 by default.

-.Xr Pw 8 's
+The
+.Xr pw 8 Ns 's

 .Fl m
 option causes the user's home directory to be created and populated
 using the files contained in the
 .Fl m
 option causes the user's home directory to be created and populated
 using the files contained in the


@@ -197,8 +205,15 @@ keyword is mandatory.
 This specifies the location of the directory in which all new user
 home directories are created.
 .Pp
 This specifies the location of the directory in which all new user
 home directories are created.
 .Pp

+The
+.Ar homemode
+keyword is optional.
+It specifies the creation mask of the user's home directory and is modified by
+.Xr umask 2 .
+.Pp
+The

 .Ar shellpath
 .Ar shellpath

-specifies a list of directories - separated by colons
+keyword specifies a list of directories - separated by colons

 .Ql \&:
 - which contain the programs used by the login shells.
 .Pp
 .Ql \&:
 - which contain the programs used by the login shells.
 .Pp


@@ -214,7 +229,7 @@ These shells must exist in one of the directories nominated by
 The
 .Ar defaultshell
 keyword nominates which shell program to use for new users when
 The
 .Ar defaultshell
 keyword nominates which shell program to use for new users when

-none is specified on the 
+none is specified on the

 .Xr pw 8
 command line.
 .Pp
 .Xr pw 8
 command line.
 .Pp


@@ -228,12 +243,13 @@ is used, then each new user will have a corresponding group of
 their own created automatically.
 This is the recommended procedure for new users as it best secures each
 user's files against interference by other users of the system
 their own created automatically.
 This is the recommended procedure for new users as it best secures each
 user's files against interference by other users of the system

-irrespective of the 
+irrespective of the

 .Em umask
 normally used by the user.
 .Pp
 .Em umask
 normally used by the user.
 .Pp

+The

 .Ar extragroups
 .Ar extragroups

-provides an automatic means of placing new users into groups within
+keyword provides an automatic means of placing new users into groups within

 the
 .Pa /etc/groups
 file.
 the
 .Pa /etc/groups
 file.


@@ -257,7 +273,7 @@ The
 .Ar maxuid ,
 .Ar mingid ,
 .Ar maxgid
 .Ar maxuid ,
 .Ar mingid ,
 .Ar maxgid

-keywords determines the allowed ranges of automatically allocated user
+keywords determine the allowed ranges of automatically allocated user

 and group id numbers.
 The default values for both user and group ids are 1000 and 32000 as
 minimum and maximum respectively.
 and group id numbers.
 The default values for both user and group ids are 1000 and 32000 as
 minimum and maximum respectively.


@@ -280,7 +296,6 @@ A value of
 .Ql \&0
 in either field will disable the corresponding (account or password)
 expiration date.
 .Ql \&0
 in either field will disable the corresponding (account or password)
 expiration date.

-.Pp

 .Sh LIMITS
 The maximum line length of
 .Pa /etc/pw.conf
 .Sh LIMITS
 The maximum line length of
 .Pa /etc/pw.conf


@@ -296,6 +311,7 @@ as comments.
 .El
 .Sh SEE ALSO
 .Xr passwd 1 ,
 .El
 .Sh SEE ALSO
 .Xr passwd 1 ,

+.Xr umask 2 ,

 .Xr group 5 ,
 .Xr login.conf 5 ,
 .Xr passwd 5 ,
 .Xr group 5 ,
 .Xr login.conf 5 ,
 .Xr passwd 5 ,