9103 opengroup acknowledgement should be properly formatted in man pages
[unleashed.git] / usr / src / man / man3head / utmpx.h.3head
blobdf0c3f11324d503eda0a1b01be707c6344a2064b
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document.  The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
44 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
45 .\"
46 .TH UTMPX.H 3HEAD "Apr 16, 2007"
47 .SH NAME
48 utmpx.h, utmpx \- user accounting database definitions
49 .SH SYNOPSIS
50 .LP
51 .nf
52 #include <utmpx.h>
53 .fi
55 .SH DESCRIPTION
56 .sp
57 .LP
58 The \fB<utmpx.h>\fR header defines the \fButmpx\fR structure, which includes
59 the following members:
60 .sp
61 .in +2
62 .nf
63 char                  ut_user[];  /* user login name */
64 char                  ut_id[];    /* unspecified initialization */
65                                   /* process identifier */
66 char                  ut_line[];  /* device name */
67 pid_t                 ut_pid;     /* process ID */
68 short                 ut_type;    /* type of entry */
69 .fi
70 .in -2
72 .sp
73 .LP
74 for X/Open compilation environments:
75 .sp
76 .in +2
77 .nf
78 struct ut_exit_status ut_exit; /* process termination/exit status*/
79 .fi
80 .in -2
82 .sp
83 .LP
84 for all other compilation environments:
85 .sp
86 .in +2
87 .nf
88 struct exit_status    ut_exit;    /* process termination/exit status*/
89 .fi
90 .in -2
92 .sp
93 .in +2
94 .nf
95 struct timeval        ut_tv;      /* time entry was made */
96 int                   ut_session; /* session ID, used for windowing */
97 short                 ut_syslen;  /* significant length of ut_host */
98                                   /* including terminating null */
99 char                  ut_host[];  /* remote host name */
101 .in -2
105 The \fBpid_t\fR type is defined through \fBtypedef\fR as described in
106 \fB<sys/types.h>\fR.
109 The \fBtimeval\fR structure is defined as described in \fB<sys/time.h>\fR.
112 Inclusion of the \fB<utmpx.h>\fR header can also make visible all symbols from
113 \fB<sys/time.h>\fR.
116 The following symbolic constants are defined as possible values for the
117 \fBut_type\fR member of the \fButmpx\fR structure:
119 .ne 2
121 \fB\fBEMPTY\fR\fR
123 .RS 17n
124 No valid user accounting information.
128 .ne 2
130 \fB\fBBOOT_TIME\fR\fR
132 .RS 17n
133 Identifies time of system boot.
137 .ne 2
139 \fB\fBOLD_TIME\fR\fR
141 .RS 17n
142 Identifies time when system clock changed.
146 .ne 2
148 \fB\fBNEW_TIME\fR\fR
150 .RS 17n
151 Identifies time after system clock changed.
155 .ne 2
157 \fB\fBUSER_PROCESS\fR\fR
159 .RS 17n
160 Identifies a process.
164 .ne 2
166 \fB\fBINIT_PROCESS\fR\fR
168 .RS 17n
169 Identifies a process spawned by the \fBinit\fR process.
173 .ne 2
175 \fB\fBLOGIN_PROCESS\fR\fR
177 .RS 17n
178 Identifies the session leader of a logged-in user.
182 .ne 2
184 \fB\fBDEAD_PROCESS\fR\fR
186 .RS 17n
187 Identifies a session leader who has exited.
190 .SH ATTRIBUTES
193 See \fBattributes\fR(5) for descriptions of the following attributes:
198 box;
199 c | c
200 l | l .
201 ATTRIBUTE TYPE  ATTRIBUTE VALUE
203 Interface Stability     Standard
206 .SH SEE ALSO
209 \fBendutxent\fR(3C), \fBtime.h\fR(3HEAD), \fBtypes.h\fR(3HEAD),
210 \fBattributes\fR(5), \fBstandards\fR(5)