pw: (file == NULL) check is always false in read_userconfig(), remove

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

diff --git a/adduser/rmuser.8 b/adduser/rmuser.8
index 88195cded1a970c178b547107307f7549b32b963..e24d5eedf868b7c009bc24733bb264db568d4e0a 100644 (file)
--- a/adduser/rmuser.8
+++ b/adduser/rmuser.8
@@ -1,5 +1,5 @@
-.\" Copyright 1995, 1996
-.\"     Guy Helmer, Madison, South Dakota 57042.  All rights reserved.
+.\" Copyright 1995, 1996, 1997
+.\"     Guy Helmer, Ames, Iowa 50014.  All rights reserved.

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


@@ -24,58 +24,140 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"

-.\"    $Id$
+.\" $FreeBSD$

 .\"
 .\"

-.Dd July 16, 1996
+.Dd May 10, 2002

 .Dt RMUSER 8
 .Os
 .Sh NAME
 .Nm rmuser
 .Nd remove users from the system
 .Sh SYNOPSIS
 .Dt RMUSER 8
 .Os
 .Sh NAME
 .Nm rmuser
 .Nd remove users from the system
 .Sh SYNOPSIS

-.Nm rmuser
-.Op Ar username
+.Nm
+.Op Fl yv
+.Op Fl f Ar file
+.Op Ar username ...

 .Sh DESCRIPTION
 .Sh DESCRIPTION

-The 
-.Nm rmuser
-utility removes a user's 
+The
+.Nm
+utility removes one or more users submitted on the command line
+or from a file.
+In removing a user from the system, this utility:
+.Bl -enum
+.It
+Removes the user's

 .Xr crontab 1
 .Xr crontab 1

-entry (if any) and any 
+entry (if any).
+.It
+Removes any

 .Xr at 1
 .Xr at 1

-jobs belonging to the user,
-then removes a user from the system's local password file, removes
-the user's home directory if it is owned by the user, and removes
-the user's incoming mail file if it exists.  The username is removed
-from any groups to which it belongs in the file
+jobs belonging to the user.
+.It
+Sends a
+.Dv SIGKILL
+signal to all processes owned by the user.
+.It
+Removes the user from the system's local password file.
+.It
+Removes the user's home directory (if it is owned by the user),
+including handling of symbolic links in the path to the actual home
+directory.
+.It
+Removes the incoming mail and POP daemon mail files belonging to the
+user from
+.Pa /var/mail .
+.It
+Removes all files owned by the user from
+.Pa /tmp , /var/tmp ,
+and
+.Pa /var/tmp/vi.recover .
+.It
+Removes the username from all groups to which it belongs in

 .Pa /etc/group .
 .Pa /etc/group .

-If a group becomes empty and the group name is the same as the username,
-the group is removed (this complements
-.Xr adduser 8 's
-per-user unique groups).
+(If a group becomes empty and the group name is the same as the username,
+the group is removed; this complements
+.Xr adduser 8 Ns 's
+per-user unique groups.)
+.It
+Removes all message queues, shared memory segments and
+semaphores owned by the user.
+.El

 .Pp
 .Pp

-.Nm rmuser
-politely refuses to remove users whose uid is 0 (typically root), since
-it seemed like a good idea at the time
-.Nm rmuser
-was written.
+The
+.Nm
+utility refuses to remove users whose UID is 0 (typically root), since
+certain actions (namely, killing all the user's processes, and perhaps
+removing the user's home directory) would cause damage to a running system.
+If it is necessary to remove a user whose UID is 0, see
+.Xr vipw 8
+for information on directly editing the password file.

 .Pp
 .Pp

-.Nm rmuser
-shows the selected user's password file entry and asks for confirmation
-that you wish to remove the user.  If the user's home directory is owned
-by the user (and not by any other user),
-.Nm rmuser
-asks whether you wish to remove the user's home directory and everything
-below.
+If
+.Nm
+was not invoked with the
+.Fl y
+option, it will
+show the selected user's password file entry and ask for confirmation
+that the user be removed.
+It will then ask for confirmation to delete
+the user's home directory.
+If the answer is in the affirmative, the home
+directory and any files and subdirectories under it will be deleted only if
+they are owned by the user.
+See
+.Xr pw 8
+for more details.

 .Pp
 .Pp

-Available options:
+As
+.Nm
+operates, it informs the user regarding the current activity.
+If any
+errors occur, they are posted to standard error and, if it is possible for
+.Nm
+to continue, it will.

 .Pp
 .Pp

-.Bl -tag -width username
-.It Ar \&username
-Identifies the user to be removed; if not present,
-.Nm rmuser
-interactively asks for the user to be removed.
+The options are as follows:
+.Bl -tag -width ".Ar username"
+.It Fl f Ar file
+The
+.Nm
+utility will get a list of users to be removed from
+.Ar file ,
+which will contain one user per line.
+Anything following a hash mark
+.Pq Ql # ,
+including the hash mark itself, is considered a comment and will not
+be processed.
+If the file is owned by anyone other than a user with
+UID 0, or is writable by anyone other than the owner,
+.Nm
+will refuse to continue.
+.It Fl y
+Implicitly answer
+.Dq Li yes
+to any and all prompts.
+Currently, this includes
+prompts on whether to remove the specified user and whether to remove
+the home directory.
+This option requires that either the
+.Fl f
+option be used, or one or more user names be given as command line
+arguments.
+.It Fl v
+Enable verbose mode.
+Normally,
+the output includes one line per removed user;
+however,
+with this option
+.Nm
+will be much more chatty about the steps taken.
+.It Ar username
+Identifies one or more users to be removed; if not present,
+.Nm
+interactively asks for one or more users to be removed.
+.El

 .Sh FILES
 .Sh FILES

-.Bl -tag -width /etc/master.passwd -compact
+.Bl -tag -width "Pa /etc/master.passwd" -compact

 .It Pa /etc/master.passwd
 .It Pa /etc/passwd
 .It Pa /etc/group
 .It Pa /etc/master.passwd
 .It Pa /etc/passwd
 .It Pa /etc/group


@@ -90,15 +172,39 @@ interactively asks for the user to be removed.
 .Xr passwd 1 ,
 .Xr group 5 ,
 .Xr passwd 5 ,
 .Xr passwd 1 ,
 .Xr group 5 ,
 .Xr passwd 5 ,

-.Xr addgroup 8 ,

 .Xr adduser 8 ,
 .Xr adduser 8 ,

+.Xr pw 8 ,

 .Xr pwd_mkdb 8 ,
 .Xr pwd_mkdb 8 ,

-.Xr rmgroup 8 ,

 .Xr vipw 8
 .Sh HISTORY
 The
 .Nm
 .Xr vipw 8
 .Sh HISTORY
 The
 .Nm

-command appeared in 
-.Fx 2.1.5 .
-.\" .Sh AUTHOR
-.\" Guy Helmer, Madison, South Dakota
+utility appeared in
+.Fx 2.2 .
+.Sh BUGS
+The
+.Nm
+utility does not comprehensively search the file system for all files
+owned by the removed user and remove them; to do so on a system
+of any size is prohibitively slow and I/O intensive.
+It is also unable to remove symbolic links that were created by the
+user in
+.Pa /tmp
+or
+.Pa /var/tmp ,
+as symbolic links on
+.Bx 4.4
+file systems do not contain information
+as to who created them.
+Also, there may be other files created in
+.Pa /var/mail
+other than
+.Pa /var/mail/ Ns Ar username
+and
+.Pa /var/mail/.pop. Ns Ar username
+that are not owned by the removed user but should be removed.
+.Pp
+The
+.Nm
+utility has no knowledge of YP/NIS, and it operates only on the
+local password file.