share/man/man8/utmpd.8

   1 '\" te
   2 .\" Copyright 2015 Shruti V Sampat <shrutisampat@gmail.com>
   3 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" Copyright 1989 AT&T
   5 .\" 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.
   6 .\" 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.
   7 .\" 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]
   8 .TH UTMPD 8 "April 9, 2016"
   9 .SH NAME
  10 utmpd \- utmpx monitoring daemon
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fButmpd\fR [\fB-debug\fR]
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .LP
  19 The \fButmpd\fR daemon monitors the \fB/var/log/utmpx\fR file. See
  20 \fButmpx\fR(4) (and \fButmp\fR(4) for historical information).
  21 .sp
  22 .LP
  23 \fButmpd\fR receives requests from \fBpututxline\fR(3C) by way of a named pipe.
  24 It maintains a table of processes and uses \fBpoll\fR(2) on \fB/proc\fR files
  25 to detect process termination. When \fButmpd\fR detects that a process has
  26 terminated, it checks that the process has removed its \fButmpx\fR entry from
  27 \fB/var/log/utmpx\fR. If the process' \fButmpx\fR entry has not been removed,
  28 \fButmpd\fR removes the entry. By periodically scanning the
  29 \fB/var/log/utmpx\fR file, \fButmpd\fR also monitors processes that are not in
  30 its table.
  31 .SH OPTIONS
  32 .ne 2
  33 .na
  34 \fB\fB-debug\fR\fR
  35 .ad
  36 .sp .6
  37 .RS 4n
  38 Run in debug mode, leaving the process connected to the controlling terminal.
  39 Write debugging information to standard output.
  40 .RE
  41
  42 .SH EXIT STATUS
  43 .LP
  44 The following exit values are returned:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB0\fR\fR
  49 .ad
  50 .sp .6
  51 .RS 4n
  52 Successful completion.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB>0\fR\fR
  59 .ad
  60 .sp .6
  61 .RS 4n
  62 An error occurred.
  63 .RE
  64
  65 .SH FILES
  66 .ne 2
  67 .na
  68 \fB\fB/etc/default/utmpd\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 You can set default values for the flags listed below. For example:
  73 \fBSCAN_PERIOD=600\fR
  74 .sp
  75 The values for these flags should be greater than 0. If values read
  76 from the file are found to be less than or equal to 0, or containing
  77 invalid characters, the default values mentioned below are retained.
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBSCAN_PERIOD\fR\fR
  82 .ad
  83 .sp .6
  84 .RS 4n
  85 The number of seconds that \fButmpd\fR sleeps between checks of \fB/proc\fR to
  86 see if monitored processes are still alive. The default is 300.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBMAX_FDS\fR\fR
  93 .ad
  94 .sp .6
  95 .RS 4n
  96 The maximum number of processes that \fButmpd\fR attempts to monitor. The
  97 default value is 4096.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBWTMPX_UPDATE_FREQ\fR\fR
 104 .ad
 105 .sp .6
 106 .RS 4n
 107 The number of seconds that \fButmpd\fR sleeps between read accesses of the
 108 \fBwtmpx\fR file. The \fBwtmpx\fR file's last access time is used by
 109 \fBinit\fR(8) on reboot to determine when the operating system became
 110 unavailable. The default is 60.
 111 .RE
 112
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fB/var/log/utmpx\fR\fR
 119 .ad
 120 .sp .6
 121 .RS 4n
 122 File containing user and accounting information for commands such as
 123 \fBwho\fR(1), \fBwrite\fR(1), and \fBlogin\fR(1).
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB/proc\fR\fR
 130 .ad
 131 .sp .6
 132 .RS 4n
 133 Directory containing files for processes whose \fButmpx\fR entries are being
 134 monitored.
 135 .RE
 136
 137 .SH SEE ALSO
 138 .LP
 139 \fBsvcs\fR(1), \fBinit\fR(8), \fBsvcadm\fR(8), \fBpoll\fR(2),
 140 \fBpututxline\fR(3C), \fBproc\fR(4), \fButmp\fR(4), \fButmpx\fR(4),
 141 \fBattributes\fR(5), \fBsmf\fR(5)
 142 .SH NOTES
 143 .LP
 144 If the filesystem holding \fB/var/log/wtmpx\fR is mounted with options which
 145 inhibit or defer access time updates, an unknown amount of error will be
 146 introduced into the \fButmp\fR \fBDOWN_TIME\fR record's timestamp in the event
 147 of an uncontrolled shutdown (for example, a crash or loss of power ).
 148 Controlled shutdowns will update the modify time of \fB/var/log/wtmpx\fR, which
 149 will be used on the next boot to determine when the previous shutdown occurred,
 150 regardless of access time deferral or inhibition.
 151 .sp
 152 .LP
 153 The \fButmpd\fR service is managed by the service management facility,
 154 \fBsmf\fR(5), under the service identifier:
 155 .sp
 156 .in +2
 157 .nf
 158 svc:/system/utmp:default
 159 .fi
 160 .in -2
 161 .sp
 162
 163 .sp
 164 .LP
 165 Administrative actions on this service, such as enabling, disabling, or
 166 requesting restart, can be performed using \fBsvcadm\fR(8). The service's
 167 status can be queried using the \fBsvcs\fR(1) command.