[apple/system_cmds.git] / newgrp.tproj / newgrp.1

.\" Copyright (c) 2002 Tim J. Robbins.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 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 THE AUTHOR 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
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR 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/usr.bin/newgrp/newgrp.1,v 1.3 2005/01/17 07:44:25 ru Exp $
.\"
.Dd May 23, 2002
.Dt NEWGRP 1
.Os
.Sh NAME
.Nm newgrp
.Nd change to a new group
.Sh SYNOPSIS
.Nm
.Op Fl l
.Op Ar group
.Sh DESCRIPTION
The
.Nm
utility creates a new shell execution environment with modified
real and effective group IDs.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl l
Simulate a full login.
The environment and umask are set to what would be expected if the user
actually logged in again.
.El
.Pp
If the
.Ar group
operand is present, a new shell is started with the specified effective
and real group IDs.
The user will be prompted for a password if they are not a member of the
specified group.
.Pp
Otherwise, the real, effective and supplementary group IDs are restored to
those from the current user's password database entry.
.Sh EXIT STATUS
The
.Nm
utility attempts to start the shell regardless of whether group IDs
were successfully changed.
.Pp
If an error occurs and the shell cannot be started,
.Nm
exits >0.
Otherwise, the exit status of
.Nm
is the exit status of the shell.
.Sh SEE ALSO
.Xr csh 1 ,
.Xr groups 1 ,
.Xr login 1 ,
.Xr sh 1 ,
.Xr su 1 ,
.Xr umask 1 ,
.Xr group 5 ,
.Xr passwd 5 ,
.Xr environ 7
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001 .
.Sh HISTORY
A
.Nm
utility appeared in
.At v6 .
.Sh BUGS
Group passwords are inherently insecure as there is no way to stop
users obtaining the crypted passwords from the group database.
Their use is discouraged.
Commit	Line	Data
34d340d7 A	1	.\" Copyright (c) 2002 Tim J. Robbins.
	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\"
	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	14	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	15	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	16	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	17	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	18	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	19	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	20	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	21	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	22	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	23	.\" SUCH DAMAGE.
	24	.\"
ef8ad44b	25	.\" $FreeBSD: src/usr.bin/newgrp/newgrp.1,v 1.3 2005/01/17 07:44:25 ru Exp $
34d340d7 A	26	.\"
	27	.Dd May 23, 2002
	28	.Dt NEWGRP 1
	29	.Os
	30	.Sh NAME
	31	.Nm newgrp
	32	.Nd change to a new group
	33	.Sh SYNOPSIS
ef8ad44b	34	.Nm
34d340d7 A	35	.Op Fl l
	36	.Op Ar group
	37	.Sh DESCRIPTION
	38	The
ef8ad44b A	39	.Nm
	40	utility creates a new shell execution environment with modified
	41	real and effective group IDs.
34d340d7 A	42	.Pp
	43	The options are as follows:
	44	.Bl -tag -width indent
	45	.It Fl l
	46	Simulate a full login.
ef8ad44b A	47	The environment and umask are set to what would be expected if the user
ef8ad44b A	48	actually logged in again.
34d340d7 A	49	.El
	50	.Pp
	51	If the
	52	.Ar group
ef8ad44b A	53	operand is present, a new shell is started with the specified effective
	54	and real group IDs.
	55	The user will be prompted for a password if they are not a member of the
	56	specified group.
34d340d7	57	.Pp
ef8ad44b A	58	Otherwise, the real, effective and supplementary group IDs are restored to
	59	those from the current user's password database entry.
	60	.Sh EXIT STATUS
34d340d7	61	The
ef8ad44b	62	.Nm
34d340d7 A	63	utility attempts to start the shell regardless of whether group IDs
	64	were successfully changed.
	65	.Pp
	66	If an error occurs and the shell cannot be started,
ef8ad44b	67	.Nm
34d340d7 A	68	exits >0.
34d340d7 A	69	Otherwise, the exit status of
ef8ad44b	70	.Nm
34d340d7 A	71	is the exit status of the shell.
	72	.Sh SEE ALSO
	73	.Xr csh 1 ,
	74	.Xr groups 1 ,
	75	.Xr login 1 ,
	76	.Xr sh 1 ,
	77	.Xr su 1 ,
	78	.Xr umask 1 ,
	79	.Xr group 5 ,
	80	.Xr passwd 5 ,
	81	.Xr environ 7
	82	.Sh STANDARDS
	83	The
ef8ad44b	84	.Nm
34d340d7 A	85	utility conforms to
	86	.St -p1003.1-2001 .
	87	.Sh HISTORY
	88	A
ef8ad44b	89	.Nm
34d340d7 A	90	utility appeared in
	91	.At v6 .
	92	.Sh BUGS
ef8ad44b A	93	Group passwords are inherently insecure as there is no way to stop
ef8ad44b A	94	users obtaining the crypted passwords from the group database.
34d340d7	95	Their use is discouraged.