svn commit: r201780 - user/ed/utmpx/include

[Ed Schouten]

Author: ed
Date: Fri Jan  8 10:15:11 2010
New Revision: 201780
URL: http://svn.freebsd.org/changeset/base/201780

Log:
  Document the definitions in <utmpx.h>.

Modified:
  user/ed/utmpx/include/utmpx.h

Modified: user/ed/utmpx/include/utmpx.h
==============================================================================
--- user/ed/utmpx/include/utmpx.h	Fri Jan  8 10:14:27 2010	(r201779)
+++ user/ed/utmpx/include/utmpx.h	Fri Jan  8 10:15:11 2010	(r201780)
@@ -39,34 +39,35 @@ typedef	__pid_t		pid_t;
 #endif
 
 struct utmpx {
-	char		ut_user[32];
-	char		ut_id[8];
-	char		ut_line[32];
+	char		ut_user[32];	/* User login name. */
+	char		ut_id[8];	/* Process identifier. */
+	char		ut_line[32];	/* Device name. */
 #if __BSD_VISIBLE
-	char		ut_host[128];
+	char		ut_host[128];	/* Remote hostname. */
 #else
 	char		__ut_host[128];
 #endif
-	pid_t		ut_pid;
-	short		ut_type;
-#define	EMPTY		0
-#define	BOOT_TIME	1
-#define	OLD_TIME	2
-#define	NEW_TIME	3
-#define	USER_PROCESS	4
-#define	INIT_PROCESS	5
-#define	LOGIN_PROCESS	6
-#define	DEAD_PROCESS	7
+	pid_t		ut_pid;		/* Process ID. */
+	short		ut_type;	/* Type of entry. */
+	struct timeval	ut_tv;		/* Time entry was made. */
+};
+
+#define	EMPTY		0	/* No valid user accounting information. */
+#define	BOOT_TIME	1	/* Time of system boot. */
+#define	OLD_TIME	2	/* Time when system clock changed. */
+#define	NEW_TIME	3	/* Time after system clock changed. */
+#define	USER_PROCESS	4	/* A process. */
+#define	INIT_PROCESS	5	/* A process spawned by the init process. */
+#define	LOGIN_PROCESS	6	/* The session leader of a logged-in user. */
+#define	DEAD_PROCESS	7	/* A session leader who has exited. */
 #if __BSD_VISIBLE
-#define	SHUTDOWN_TIME	8
+#define	SHUTDOWN_TIME	8	/* Time of system shutdown. */
 #endif
-	struct timeval	ut_tv;
-};
 
 #if __BSD_VISIBLE
-#define	UTXDB_ACTIVE	0
-#define	UTXDB_LASTLOGIN	1
-#define	UTXDB_LOG	2
+#define	UTXDB_ACTIVE	0	/* Active login sessions. */
+#define	UTXDB_LASTLOGIN	1	/* Last login sessions. */
+#define	UTXDB_LOG	2	/* Log indexed by time. */
 #endif
 
 __BEGIN_DECLS