Cleanup includes

[pw-darwin.git] / pw / pw.8

diff --git a/pw/pw.8 b/pw/pw.8
index 428705589a80a7e398e3a35e36cdd402ed73d4aa..c29a8a9f40d1ca3b7862b374f642c3ba2be9b563 100644 (file)
--- a/pw/pw.8
+++ b/pw/pw.8
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd March 30, 2007
+.Dd June 14, 2015
 .Dt PW 8
 .Os
 .Sh NAME
@@ -32,6 +32,7 @@
 .Nd create, remove, modify & display system users and groups
 .Sh SYNOPSIS
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar useradd
 .Op name|uid
@@ -57,6 +58,7 @@
 .Op Fl P
 .Op Fl Y
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar useradd
 .Op name|uid
@@ -76,6 +78,7 @@
 .Op Fl s Ar shell
 .Op Fl y Ar path
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar userdel
 .Op name|uid
@@ -84,6 +87,7 @@
 .Op Fl r
 .Op Fl Y
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar usermod
 .Op name|uid
@@ -109,6 +113,7 @@
 .Op Fl P
 .Op Fl Y
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar usershow
 .Op name|uid
@@ -119,11 +124,13 @@
 .Op Fl 7
 .Op Fl a
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar usernext
 .Op Fl C Ar config
 .Op Fl q
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar groupadd
 .Op group|gid
@@ -138,6 +145,7 @@
 .Op Fl P
 .Op Fl Y
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar groupdel
 .Op group|gid
@@ -145,6 +153,7 @@
 .Op Fl g Ar gid
 .Op Fl Y
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar groupmod
 .Op group|gid
@@ -161,6 +170,7 @@
 .Op Fl P
 .Op Fl Y
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar groupshow
 .Op group|gid
@@ -170,17 +180,20 @@
 .Op Fl P
 .Op Fl a
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar groupnext
 .Op Fl C Ar config
 .Op Fl q
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar lock
 .Op name|uid
 .Op Fl C Ar config
 .Op Fl q
 .Nm
+.Op Fl R Ar rootdir
 .Op Fl V Ar etcdir
 .Ar unlock
 .Op name|uid
@@ -245,8 +258,13 @@ id as an alternative to using the
 options.
 .Pp
 The following flags are common to most or all modes of operation:
-.Pp
 .Bl -tag -width "-G grouplist"
+.It Fl R Ar rootdir
+Specifies an alternate root directory within which
+.Nm
+will operate.
+Any paths specified will be relative to
+.Va rootdir .
 .It Fl V Ar etcdir
 This flag sets an alternate location for the password, group and configuration files,
 and may be used to maintain a user/group database in an alternate location.
@@ -260,7 +278,7 @@ flag may be used to override this behaviour.
 As an exception to the general rule where options must follow the operation
 type, the
 .Fl V
-flag may be used on the command line before the operation keyword.
+flag must be used on the command line before the operation keyword.
 .It Fl C Ar config
 By default,
 .Nm
@@ -319,7 +337,6 @@ The following options apply to the
 and
 .Ar usermod
 commands:
-.Pp
 .Bl -tag -width "-G grouplist"
 .It Fl n Ar name
 Specify the user/account name.
@@ -353,7 +370,6 @@ or
 .Fl u
 options.
 .El
-.Pp
 .Bl -tag -width "-G grouplist"
 .It Fl c Ar comment
 This field sets the contents of the passwd GECOS field, which normally contains up
@@ -717,6 +733,17 @@ are also removed if the user's uid is unique and not also used by another accoun
 system.
 .Pp
 The
+.Ar usermod
+command adds one additional option:
+.Bl -tag -width "-G grouplist"
+.It Fl l Ar name
+This option allows changing of an existing account name to
+.Ql \&name .
+The new name must not already exist, and any attempt to duplicate an
+existing account name will be rejected.
+.El
+.Pp
+The
 .Ar usershow
 command allows viewing of an account in one of two formats.
 By default, the format is identical to the format used in
@@ -802,7 +829,6 @@ There is rarely any need to duplicate a group id.
 The
 .Ar groupmod
 command adds one additional option:
-.Pp
 .Bl -tag -width "-m newmembers"
 .It Fl l Ar name
 This option allows changing of an existing group name to
@@ -897,12 +923,6 @@ A Version 7 format password file
 The user capabilities database
 .It Pa /etc/group
 The group database
-.It Pa /etc/master.passwd.new
-Temporary copy of the master password file
-.It Pa /etc/passwd.new
-Temporary copy of the Version 7 password file
-.It Pa /etc/group.new
-Temporary copy of the group file
 .It Pa /etc/pw.conf
 Pw default options file
 .It Pa /var/log/userlog