[apple/libc.git] / util / login.3

.\" Copyright (c) 1995
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software developed by the Computer Systems
.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
.\" BG 91-66 and contributed to Berkeley.
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
.\"
.Dd December 14, 1995
.Dt LOGIN 3
.Os
.Sh NAME
.Nm login ,
.Nm logout ,
.Nm logwtmp
.Nd login utility functions (DEPRECATED)
.Sh SYNOPSIS
.Fd #include <util.h>
.Ft void
.Fn login "struct utmp *ut"
.Ft int
.Fn logout "const char *line"
.Ft void
.Fn logwtmp "const char *line" "const char *name" "const char *host"
.Sh DESCRIPTION
The
.Fn login ,
.Fn logout ,
and
.Fn logwtmp
functions are
.Sy DEPRECATED ;
use
.Xr pututxline 3
instead.
.Pp
These functions operate on the database of current users in
.Pa /var/run/utmpx
and the system log file.
Superuser permission is required.
.Pp
The
.Fn login
function updates the
.Pa /var/run/utmpx
files with user information contained in
.Fa ut
(after converting to a struct utmpx, as described in
.Xr pututxline 3 ) .
.Pp
The
.Fn logout
function removes the entry from
.Pa /var/run/utmpx
corresponding to the device
.Fa line .
.Pp
The
.Fn logwtmp
function adds an entry to
the system log file.
Since
.Fn login
will add the appropriate entry
during a login,
.Fn logwtmp
is usually used for logouts.
.Sh RETURN VALUES
.Fn logout
returns non-zero if it was able to find and delete an entry for
.Fa line ,
and zero if there is no entry for
.Fa line
in
.Pa /var/run/utmpx .
However, there is no error indication due to lack of permissions.
.Sh FILES
.Bl -tag -width /var/run/wtmp -compact
.It Pa /dev/\(**
.It Pa /var/run/utmpx
.El
.Sh SEE ALSO
.Xr pututxline 3 ,
.Xr utmp 5 ,
.Xr utmpx 5
Commit	Line	Data
224c7076	1	.\" Copyright (c) 1995
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
224c7076 A	4	.\" This code is derived from software developed by the Computer Systems
	5	.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
	6	.\" BG 91-66 and contributed to Berkeley.
	7	.\"
e9ce8d39 A	8	.\" Redistribution and use in source and binary forms, with or without
	9	.\" modification, are permitted provided that the following conditions
	10	.\" are met:
	11	.\" 1. Redistributions of source code must retain the above copyright
	12	.\" notice, this list of conditions and the following disclaimer.
	13	.\" 2. Redistributions in binary form must reproduce the above copyright
	14	.\" notice, this list of conditions and the following disclaimer in the
	15	.\" documentation and/or other materials provided with the distribution.
	16	.\" 3. All advertising materials mentioning features or use of this software
	17	.\" must display the following acknowledgement:
	18	.\" This product includes software developed by the University of
	19	.\" California, Berkeley and its contributors.
	20	.\" 4. Neither the name of the University nor the names of its contributors
	21	.\" may be used to endorse or promote products derived from this software
	22	.\" without specific prior written permission.
	23	.\"
	24	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	.\" SUCH DAMAGE.
	35	.\"
224c7076 A	36	.Dd December 14, 1995
224c7076 A	37	.Dt LOGIN 3
e9ce8d39 A	38	.Os
e9ce8d39 A	39	.Sh NAME
224c7076 A	40	.Nm login ,
	41	.Nm logout ,
	42	.Nm logwtmp
	43	.Nd login utility functions (DEPRECATED)
e9ce8d39	44	.Sh SYNOPSIS
224c7076 A	45	.Fd #include <util.h>
	46	.Ft void
	47	.Fn login "struct utmp *ut"
e9ce8d39	48	.Ft int
224c7076 A	49	.Fn logout "const char *line"
	50	.Ft void
	51	.Fn logwtmp "const char line" "const char name" "const char *host"
e9ce8d39 A	52	.Sh DESCRIPTION
e9ce8d39 A	53	The
224c7076 A	54	.Fn login ,
	55	.Fn logout ,
	56	and
	57	.Fn logwtmp
	58	functions are
	59	.Sy DEPRECATED ;
	60	use
	61	.Xr pututxline 3
	62	instead.
	63	.Pp
	64	These functions operate on the database of current users in
	65	.Pa /var/run/utmpx
	66	and the system log file.
	67	Superuser permission is required.
	68	.Pp
e9ce8d39	69	The
224c7076 A	70	.Fn login
	71	function updates the
	72	.Pa /var/run/utmpx
	73	files with user information contained in
	74	.Fa ut
	75	(after converting to a struct utmpx, as described in
	76	.Xr pututxline 3 ) .
5b2abdfb	77	.Pp
5b2abdfb	78	The
224c7076 A	79	.Fn logout
	80	function removes the entry from
	81	.Pa /var/run/utmpx
	82	corresponding to the device
	83	.Fa line .
	84	.Pp
	85	The
	86	.Fn logwtmp
	87	function adds an entry to
	88	the system log file.
	89	Since
	90	.Fn login
	91	will add the appropriate entry
	92	during a login,
	93	.Fn logwtmp
	94	is usually used for logouts.
	95	.Sh RETURN VALUES
	96	.Fn logout
	97	returns non-zero if it was able to find and delete an entry for
	98	.Fa line ,
	99	and zero if there is no entry for
	100	.Fa line
	101	in
	102	.Pa /var/run/utmpx .
	103	However, there is no error indication due to lack of permissions.
5b2abdfb	104	.Sh FILES
224c7076 A	105	.Bl -tag -width /var/run/wtmp -compact
	106	.It Pa /dev/\(**
	107	.It Pa /var/run/utmpx
5b2abdfb	108	.El
e9ce8d39	109	.Sh SEE ALSO
224c7076 A	110	.Xr pututxline 3 ,
	111	.Xr utmp 5 ,
	112	.Xr utmpx 5