summaryrefslogtreecommitdiffstats
path: root/man3/login.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-24 04:52:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-24 04:52:22 +0000
commit3d08cd331c1adcf0d917392f7e527b3f00511748 (patch)
tree312f0d1e1632f48862f044b8bb87e602dcffb5f9 /man3/login.3
parentAdding debian version 6.7-2. (diff)
downloadmanpages-3d08cd331c1adcf0d917392f7e527b3f00511748.tar.xz
manpages-3d08cd331c1adcf0d917392f7e527b3f00511748.zip
Merging upstream version 6.8.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man3/login.3')
-rw-r--r--man3/login.3151
1 files changed, 0 insertions, 151 deletions
diff --git a/man3/login.3 b/man3/login.3
deleted file mode 100644
index a77a728..0000000
--- a/man3/login.3
+++ /dev/null
@@ -1,151 +0,0 @@
-'\" t
-.\" Derived from text written by Martin Schulze (or taken from glibc.info)
-.\" and text written by Paul Thompson - both copyright 2002.
-.\"
-.\" SPDX-License-Identifier: GPL-2.0-or-later
-.\"
-.TH login 3 2023-10-31 "Linux man-pages 6.7"
-.SH NAME
-login, logout \- write utmp and wtmp entries
-.SH LIBRARY
-System utilities library
-.RI ( libutil ", " \-lutil )
-.SH SYNOPSIS
-.nf
-.B #include <utmp.h>
-.P
-.BI "void login(const struct utmp *" ut );
-.BI "int logout(const char *" ut_line );
-.fi
-.SH DESCRIPTION
-The utmp file records who is currently using the system.
-The wtmp file records all logins and logouts.
-See
-.BR utmp (5).
-.P
-The function
-.BR login ()
-takes the supplied
-.IR "struct utmp" ,
-.IR ut ,
-and writes it to both the utmp and the wtmp file.
-.P
-The function
-.BR logout ()
-clears the entry in the utmp file again.
-.SS GNU details
-More precisely,
-.BR login ()
-takes the argument
-.I ut
-struct, fills the field
-.I ut\->ut_type
-(if there is such a field) with the value
-.BR USER_PROCESS ,
-and fills the field
-.I ut\->ut_pid
-(if there is such a field) with the process ID of the calling process.
-Then it tries to fill the field
-.IR ut\->ut_line .
-It takes the first of
-.IR stdin ,
-.IR stdout ,
-.I stderr
-that is a terminal, and
-stores the corresponding pathname minus a possible leading
-.I /dev/
-into this field, and then writes the struct to the utmp file.
-On the other hand,
-if no terminal name was found, this field is filled with "???"
-and the struct is not written to the utmp file.
-After this, the struct is written to the wtmp file.
-.P
-The
-.BR logout ()
-function searches the utmp file for an entry matching the
-.I ut_line
-argument.
-If a record is found, it is updated by zeroing out the
-.I ut_name
-and
-.I ut_host
-fields, updating the
-.I ut_tv
-timestamp field and setting
-.I ut_type
-(if there is such a field) to
-.BR DEAD_PROCESS .
-.SH RETURN VALUE
-The
-.BR logout ()
-function returns 1 if the entry was successfully written to the
-database, or 0 if an error occurred.
-.SH FILES
-.TP
-.I /var/run/utmp
-user accounting database, configured through
-.B _PATH_UTMP
-in
-.I <paths.h>
-.TP
-.I /var/log/wtmp
-user accounting log file, configured through
-.B _PATH_WTMP
-in
-.I <paths.h>
-.SH ATTRIBUTES
-For an explanation of the terms used in this section, see
-.BR attributes (7).
-.TS
-allbox;
-lb lb lbx
-l l l.
-Interface Attribute Value
-T{
-.na
-.nh
-.BR login (),
-.BR logout ()
-T} Thread safety T{
-.na
-.nh
-MT-Unsafe race:utent
-sig:ALRM timer
-T}
-.TE
-.P
-In the above table,
-.I utent
-in
-.I race:utent
-signifies that if any of the functions
-.BR setutent (3),
-.BR getutent (3),
-or
-.BR endutent (3)
-are used in parallel in different threads of a program,
-then data races could occur.
-.BR login ()
-and
-.BR logout ()
-calls those functions,
-so we use race:utent to remind users.
-.SH VERSIONS
-The member
-.I ut_user
-of
-.I struct utmp
-is called
-.I ut_name
-in BSD.
-Therefore,
-.I ut_name
-is defined as an alias for
-.I ut_user
-in
-.IR <utmp.h> .
-.SH STANDARDS
-BSD.
-.SH SEE ALSO
-.BR getutent (3),
-.BR utmp (5)