.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "LIGHTS 1"
.TH LIGHTS 1 2023-07-29 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
lights \- DNSSEC\-Tools Rollover Overview GUI Display
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  lights [options]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBlights\fR gives a very simple overview of the rollover status of a set of
zones.  The rollover status counts are given in a "traffic light" display.
In contrast, \fBblinkenlights\fR gives a detailed display of the roll status
of a set of zones.  \fBlights\fR gives very little control over \fBrollerd\fR,
the way \fBblinkenlights\fR does.  \fBlights\fR can halt \fBrollerd\fR's execution
only.
.PP
The rollover status is retrieved in one of two ways.  By default, \fBrollerd\fR
is contacted via the \fBrollctl\fR command.  Alternately, if the \fB\-rrf\fR option
is given, then zone status is read directly from a \fBrollrec\fR file.  The
default method gets the status directly from \fBrollerd\fR and the user need
not know the location of the relevant \fBrollrec\fR file.  However, that method
will not get zone status until \fBrollerd\fR is available to respond to the
information request.  Consequently, the alternate method allows \fBlights\fR
to bypass communicating with \fBrollerd\fR and not having to wait for \fBrollerd\fR
to be available.
.PP
A window is created that has three colored sections \- green, yellow, and red.
The green section displays a count of those zones that are in "normal" status;
that is, they are not in rollover.  The yellow section displays a count of
those zones that are in rollover.  The red section displays a count of those
zones that are in need of attention.  A common cause for this last state is
because a zone is in phase 5 of KSK rollover and is waiting for its parent
zone to publish the child's new DS record.
.PP
Clicking on the color rows in the main window will bring up a dialog box that
lists the zones in that state.  This list will not automatically update as
zones change rollover state.
.SH OPTIONS
.IX Header "OPTIONS"
\&\fBlights\fR supports the following options.
.IP "\fB\-interval wait-time\fR" 4
.IX Item "-interval wait-time"
Interval between checks of zone rollover status  By default, \fIwait-time\fR is
given in minutes.  This can be adjusted by specifying one of the following
time-unit suffixes.
.Sp
* s \- seconds
.Sp
* m \- minutes
.Sp
* h \- hours
.Sp
Examples:
.Sp
* \fI\-interval 24\fR \- 24 minutes
.Sp
* \fI\-interval 24s\fR \- 24 seconds
.Sp
* \fI\-interval 24m\fR \- 24 minutes
.Sp
* \fI\-interval 24h\fR \- 24 hours
.IP "\fB\-rrf rollrec-file\fR" 4
.IX Item "-rrf rollrec-file"
A \fBrollrec\fR file to be read for zone status.
.IP \fB\-labels\fR 4
.IX Item "-labels"
Labels will be given for each color field in the GUI.
.IP \fB\-verbose\fR 4
.IX Item "-verbose"
Give verbose output.
.IP \fB\-help\fR 4
.IX Item "-help"
Give a usage message and exit.
.IP \fB\-Version\fR 4
.IX Item "-Version"
Displays the version information for \fBlights\fR and the DNSSEC-Tools
package.
.SH REQUIREMENTS
.IX Header "REQUIREMENTS"
\&\fBlights\fR is implemented in Perl/Tk, so both Perl and Perl/Tk must be
installed on your system.
.SH "KNOWN ISSUES"
.IX Header "KNOWN ISSUES"
The following are known issues.  These will be resolved in the fullness of time.
.IP \(bu 4
Resizing the window leaves the color blobs in their original size.
This is an issue with the Tk widget used to display the color stripes.
Other display methods are being investigated...
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2010\-2014 SPARTA, Inc.  All rights reserved.
See the COPYING file included with the DNSSEC-Tools package for details.
.SH AUTHOR
.IX Header "AUTHOR"
Wayne Morrison, tewok@tislabs.com
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBblinkenlights\|(8)\fR,
\&\fBbubbles\|(8)\fR,
\&\fBrollerd\|(8)\fR,
\&\fBrollrec\|(5)\fR