share/man/man3head/utmpx.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH UTMPX.H 3HEAD "Apr 16, 2007"
  12 .SH NAME
  13 utmpx.h, utmpx \- user accounting database definitions
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <utmpx.h>
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fB<utmpx.h>\fR header defines the \fButmpx\fR structure, which includes
  24 the following members:
  25 .sp
  26 .in +2
  27 .nf
  28 char                  ut_user[];  /* user login name */
  29 char                  ut_id[];    /* unspecified initialization */
  30                                   /* process identifier */
  31 char                  ut_line[];  /* device name */
  32 pid_t                 ut_pid;     /* process ID */
  33 short                 ut_type;    /* type of entry */
  34 .fi
  35 .in -2
  36
  37 .sp
  38 .LP
  39 for X/Open compilation environments:
  40 .sp
  41 .in +2
  42 .nf
  43 struct ut_exit_status ut_exit; /* process termination/exit status*/
  44 .fi
  45 .in -2
  46
  47 .sp
  48 .LP
  49 for all other compilation environments:
  50 .sp
  51 .in +2
  52 .nf
  53 struct exit_status    ut_exit;    /* process termination/exit status*/
  54 .fi
  55 .in -2
  56
  57 .sp
  58 .in +2
  59 .nf
  60 struct timeval        ut_tv;      /* time entry was made */
  61 int                   ut_session; /* session ID, used for windowing */
  62 short                 ut_syslen;  /* significant length of ut_host */
  63                                   /* including terminating null */
  64 char                  ut_host[];  /* remote host name */
  65 .fi
  66 .in -2
  67
  68 .sp
  69 .LP
  70 The \fBpid_t\fR type is defined through \fBtypedef\fR as described in
  71 \fB<sys/types.h>\fR.
  72 .sp
  73 .LP
  74 The \fBtimeval\fR structure is defined as described in \fB<sys/time.h>\fR.
  75 .sp
  76 .LP
  77 Inclusion of the \fB<utmpx.h>\fR header can also make visible all symbols from
  78 \fB<sys/time.h>\fR.
  79 .sp
  80 .LP
  81 The following symbolic constants are defined as possible values for the
  82 \fBut_type\fR member of the \fButmpx\fR structure:
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBEMPTY\fR\fR
  87 .ad
  88 .RS 17n
  89 No valid user accounting information.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBBOOT_TIME\fR\fR
  96 .ad
  97 .RS 17n
  98 Identifies time of system boot.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBOLD_TIME\fR\fR
 105 .ad
 106 .RS 17n
 107 Identifies time when system clock changed.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBNEW_TIME\fR\fR
 114 .ad
 115 .RS 17n
 116 Identifies time after system clock changed.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBUSER_PROCESS\fR\fR
 123 .ad
 124 .RS 17n
 125 Identifies a process.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBINIT_PROCESS\fR\fR
 132 .ad
 133 .RS 17n
 134 Identifies a process spawned by the \fBinit\fR process.
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBLOGIN_PROCESS\fR\fR
 141 .ad
 142 .RS 17n
 143 Identifies the session leader of a logged-in user.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBDEAD_PROCESS\fR\fR
 150 .ad
 151 .RS 17n
 152 Identifies a session leader who has exited.
 153 .RE
 154
 155 .SH ATTRIBUTES
 156 .sp
 157 .LP
 158 See \fBattributes\fR(5) for descriptions of the following attributes:
 159 .sp
 160
 161 .sp
 162 .TS
 163 box;
 164 c | c
 165 l | l .
 166 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 167 _
 168 Interface Stability     Standard
 169 .TE
 170
 171 .SH SEE ALSO
 172 .sp
 173 .LP
 174 \fBendutxent\fR(3C), \fBtime.h\fR(3HEAD), \fBtypes.h\fR(3HEAD),
 175 \fBattributes\fR(5), \fBstandards\fR(5)