Current File : //usr/man/man3head/utmpx.h.3head

'\" te
.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\"  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 Sun OS 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. 
.TH utmpx.h 3HEAD "16 Apr 2007" "SunOS 5.11" "Headers"
.SH NAME
utmpx.h, utmpx \- user accounting database definitions
.SH SYNOPSIS
.LP
.nf
#include <utmpx.h>
.fi

.SH DESCRIPTION
.sp
.LP
The \fB<utmpx.h>\fR header defines the \fButmpx\fR structure, which includes the following members:
.sp
.in +2
.nf
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 */
.fi
.in -2

.sp
.LP
for X/Open compilation environments:
.sp
.in +2
.nf
struct ut_exit_status ut_exit; /* process termination/exit status*/
.fi
.in -2

.sp
.LP
for all other compilation environments:
.sp
.in +2
.nf
struct exit_status    ut_exit;    /* process termination/exit status*/
.fi
.in -2

.sp
.in +2
.nf
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 */
.fi
.in -2

.sp
.LP
The \fBpid_t\fR type is defined through \fBtypedef\fR as described in \fB<sys/types.h>\fR.
.sp
.LP
The \fBtimeval\fR structure is defined as described in \fB<sys/time.h>\fR.
.sp
.LP
Inclusion of the \fB<utmpx.h>\fR header can also make visible all symbols from \fB<sys/time.h>\fR.
.sp
.LP
The following symbolic constants are defined as possible values for the \fBut_type\fR member of the \fButmpx\fR structure:
.sp
.ne 2
.mk
.na
\fB\fBEMPTY\fR\fR
.ad
.RS 17n
.rt  
No valid user accounting information.
.RE

.sp
.ne 2
.mk
.na
\fB\fBBOOT_TIME\fR\fR
.ad
.RS 17n
.rt  
Identifies time of system boot.
.RE

.sp
.ne 2
.mk
.na
\fB\fBOLD_TIME\fR\fR
.ad
.RS 17n
.rt  
Identifies time when system clock changed.
.RE

.sp
.ne 2
.mk
.na
\fB\fBNEW_TIME\fR\fR
.ad
.RS 17n
.rt  
Identifies time after system clock changed.
.RE

.sp
.ne 2
.mk
.na
\fB\fBUSER_PROCESS\fR\fR
.ad
.RS 17n
.rt  
Identifies a process.
.RE

.sp
.ne 2
.mk
.na
\fB\fBINIT_PROCESS\fR\fR
.ad
.RS 17n
.rt  
Identifies a process spawned by the \fBinit\fR process.
.RE

.sp
.ne 2
.mk
.na
\fB\fBLOGIN_PROCESS\fR\fR
.ad
.RS 17n
.rt  
Identifies the session leader of a logged-in user.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDEAD_PROCESS\fR\fR
.ad
.RS 17n
.rt  
Identifies a session leader who has exited.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBendutxent\fR(3C), \fBtime.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)