xref: /illumos-gate/usr/src/man/man3head/utmpx.h.3head (revision e86372a01d2d16a5dd4a64e144ed978ba17fe7dd)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.

UTMPX.H 3HEAD "Apr 16, 2007"
NAME
utmpx.h, utmpx - user accounting database definitions
SYNOPSIS

#include <utmpx.h>
DESCRIPTION

The <utmpx.h> header defines the utmpx structure, which includes the following members:

char ut_user[]; /* user login name */
char ut_id[]; /* unspecified initialization */
 /* process identifier */
char ut_line[]; /* device name */
pid_t ut_pid; /* process ID */
short ut_type; /* type of entry */

for X/Open compilation environments:

struct ut_exit_status ut_exit; /* process termination/exit status*/

for all other compilation environments:

struct exit_status ut_exit; /* process termination/exit status*/
struct timeval ut_tv; /* time entry was made */
int ut_session; /* session ID, used for windowing */
short ut_syslen; /* significant length of ut_host */
 /* including terminating null */
char ut_host[]; /* remote host name */

The pid_t type is defined through typedef as described in <sys/types.h>.

The timeval structure is defined as described in <sys/time.h>.

Inclusion of the <utmpx.h> header can also make visible all symbols from <sys/time.h>.

The following symbolic constants are defined as possible values for the ut_type member of the utmpx structure: EMPTY

No valid user accounting information.

BOOT_TIME

Identifies time of system boot.

OLD_TIME

Identifies time when system clock changed.

NEW_TIME

Identifies time after system clock changed.

USER_PROCESS

Identifies a process.

INIT_PROCESS

Identifies a process spawned by the init process.

LOGIN_PROCESS

Identifies the session leader of a logged-in user.

DEAD_PROCESS

Identifies a session leader who has exited.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

endutxent(3C), time.h(3HEAD), types.h(3HEAD), attributes(5), standards(5)