d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ea1376dfbb
freebsd-dev/lib/libutil/logout.3

72 lines
2.2 KiB
Groff
Raw Normal View History

Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.\"
.\" Copyright (c) 1996 Joerg Wunsch
.\"
.\" 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 DEVELOPERS ``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 DEVELOPERS 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.
.\"
Add #include <sys/types.h> in synopsis, now required for libutil.h.
1997-05-11 08:50:33 +00:00
.\" $Id: logout.3,v 1.4 1997/02/22 15:08:28 peter Exp $
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.\" "
.Dd December 29, 1996
.Os
.Dt LOGOUT 3
.Sh NAME
.Nm logout
.Nd remove an entry from the utmp file
.Sh SYNOPSIS
Add #include <sys/types.h> in synopsis, now required for libutil.h.
1997-05-11 08:50:33 +00:00
.Fd #include <sys/types.h>
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Fd #include <libutil.h>
.Ft int
.Fn logout "char *line"
.Pp
Link with
.Va -lutil
on the
.Xr cc 1
command line.
.Sh DESCRIPTION
The function
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn logout
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
searches the
.Xr utmp 5
file for the slot described by
.Ar line
(usually a tty name). If such a slot could be found, it will be updated
with a record where the
.Em name
and
.Em host
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
fields are empty, and the time stamp field is updated to the current time.
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Sh RETURN VALUES
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn Logout
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
returns 1 if the slot described by
.Ar line
has been found and updated, 0 otherwise.
.Sh SEE ALSO
.Xr login 3 ,
.Xr utmp 5 ,
.Xr wtmp 5
.Sh BUGS
The calling interface of
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn logout
is inconsistent with that of
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Xr login 3 .
Reference in New Issue Copy Permalink