.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LSROLL 1p"
.TH LSROLL 1p "2012-06-21" "perl v5.14.2" "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"
lsroll \- List the rollrecs in a DNSSEC\-Tools rollrec file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  lsroll [options] <rollrec\-files>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This script lists the contents of the specified \fIrollrec\fR files.  All
\&\fIrollrec\fR files are loaded before the output is displayed.  If any
\&\fIrollrec\fRs have duplicated names, whether within one file or across
multiple files, the later \fIrollrec\fR will be the one whose data are
displayed.
.SH "OUTPUT FORMATS"
.IX Header "OUTPUT FORMATS"
The output displayed for each zone in a \fIrollrec\fR file depends on the
selected records, the selected attributes, and the selected output format.
Each option in these option groups is described in detail in the next section.
The three base output formats, along with the default \fB\-skip\fR format, are
described here.
.PP
The \fB\-terse\fR option indicates that a minimal amount of output is desired;
the \fB\-long\fR option indicates that a great deal of output is desired.  The
record-selection and attribute-selection options may be used in conjunction
with \fB\-terse\fR to display exactly the set of \fIrollrec\fR fields needed.
.PP
The default output format is that used when neither \fB\-terse\fR nor \fB\-long\fR
is given, and is a middle ground between terse and long output.
.PP
If the \fB\-skip\fR option is given, then the default output format is a little
more restricted than the normal default.  Some \fIrollrec\fR fields don't make
sense in the context of a skip records, and so are given as \*(L"\-\-\-\*(R".  These
fields are the \s-1KSK\s0 rollover phase, the \s-1ZSK\s0 rollover phase, the \s-1TTL\s0 value, and
the phase start.
.PP
The table below shows the fields displayed for each output format.
.PP
.Vb 10
\&    rollrec field        default        terse        long       skip
\&    \-\-\-\-\-\-\-\-\-\-\-\-\-        \-\-\-\-\-\-\-        \-\-\-\-\-        \-\-\-\-       \-\-\-\-
\&    rollrec name           yes           yes         yes        yes
\&    rollrec type           no            no          yes        no
\&    zonename               no            no          yes        yes
\&    zone file              yes           no          yes        yes
\&    zonegroup              no            no          yes        no
\&    keyrec file            yes           no          yes        yes
\&    KSK phase              yes           no          yes        no
\&    ZSK phase              yes           no          yes        no
\&    administrator          no            no          yes        no
\&    directory              no            no          yes        no
\&    logging level          no            no          yes        no
\&    TTL value              no            no          yes        no
\&    display flag           no            no          yes        no
\&    phase start            no            no          yes        no
\&    last KSK rollover      no            no          yes        no
\&    last ZSK rollover      no            no          yes        no
\&    zonesigner arguments   no            no          yes        no
.Ve
.PP
The \fIrollrec\fR name field is often the same as its zonename, but this is not
necessarily the case.  The \fIrollrec\fR name can contain spaces, while the
zonename can't.  For this reason, \fBlsroll\fR displays the \fIrollrec\fR name in
quotes, even if the name contains no spaces.  This is intended to allow for
easier parsing by other programs.
.SH "OPTIONS"
.IX Header "OPTIONS"
There are three types of options recognized by \fBlsroll\fR:  record-selection
options, attribute-selection options, and output-format options.  Each type
is described in the subsections below.
.SS "Record-selection Options"
.IX Subsection "Record-selection Options"
These options select the records that will be displayed by \fBlsroll\fR.
By default, all records will be displayed; selecting one or the other of
these options will restrict the records shown.
.PP
In order to simplify the \fBlsroll\fR code and keep it easily understandable,
these options are mutually exclusive.
.IP "\fB\-roll\fR" 4
.IX Item "-roll"
List all \*(L"roll\*(R" records in the \fIrollrec\fR file.
.IP "\fB\-skip\fR" 4
.IX Item "-skip"
List all \*(L"skip\*(R" records in the \fIrollrec\fR file.
.SS "Attribute-selection Options"
.IX Subsection "Attribute-selection Options"
These options select the attributes of the records that will be displayed
by \fBlsroll\fR.
.IP "\fB\-type\fR" 4
.IX Item "-type"
Include each \fIrollrec\fR record's type in the output.  The type will be either
\&\*(L"roll\*(R" or \*(L"skip\*(R".
.IP "\fB\-zonename\fR" 4
.IX Item "-zonename"
The record's zonename is included in the output.  The zonename is distinct
from the record's \fIrollrec\fR name, which is always included in the output.
While these two fields are often the same, they need not be.  In split-zone
zones, the \fIrollrec\fR names must be different, while the \fIzonename\fR field
is the same.
.IP "\fB\-zonefile\fR" 4
.IX Item "-zonefile"
The record's zonefile is included in the output.  This field is part
of the default output.
.IP "\fB\-zg\fR" 4
.IX Item "-zg"
The record's zonegroup is included in the output, enclosed in double quotes.
If a \fIrollrec\fR does not contain a zonegroup, then the value "" is given.
.IP "\fB\-keyrec\fR" 4
.IX Item "-keyrec"
The record's \fIkeyrec\fR file is included in the output.
This field is part of the default output.
.IP "\fB\-kskphase\fR" 4
.IX Item "-kskphase"
The record's \s-1KSK\s0 rollover phase are included in the output.
If this option is given with the \fB\-zskphase\fR option, then the output will
follow the format described for the \fB\-phases\fR option.
This field is part of the default output.
.IP "\fB\-zskphase\fR" 4
.IX Item "-zskphase"
The record's \s-1ZSK\s0 rollover phase are included in the output.
If this option is given with the \fB\-kskphase\fR option, then the output will
follow the format described for the \fB\-phases\fR option.
This field is part of the default output.
.IP "\fB\-phases\fR" 4
.IX Item "-phases"
The record's \s-1KSK\s0 and \s-1ZSK\s0 rollover phases are included in the output.
The listing is given with the \s-1KSK\s0 phase first, followed by the \s-1ZSK\s0 phase.
.Sp
Examples of output from this option are:
.Sp
.Vb 4
\&    KSK phase   ZSK phase       output
\&        0           0            0/0
\&        3           0            3/0
\&        0           5            0/5
.Ve
.IP "\fB\-admin\fR" 4
.IX Item "-admin"
The record's administrator value is included in the output.
If an administrator value is not included in a \fIrollrec\fR, then the value
\&\*(L"(defadmin)\*(R" will be given.
.IP "\fB\-directory\fR" 4
.IX Item "-directory"
The name of the directory that holds the zone's files is included in the
output.  If a zone directory is not included in a \fIrollrec\fR, then the value
\&\*(L"(defdir)\*(R" will be given.
.IP "\fB\-loglevel\fR" 4
.IX Item "-loglevel"
The \fBrollerd\fR logging level for this zone.  This value may be given in
the \fIrollrec\fR file in either the textual or numeric form.  The textual form
of the logging level will be displayed, not the numeric.
If a logging level value is not included in a \fIrollrec\fR, then the value
\&\*(L"(deflog)\*(R" will be given.
If an undefined logging level value is included in a \fIrollrec\fR, then the
value \*(L"(unknownlog)\*(R" will be given.
.IP "\fB\-ttl\fR" 4
.IX Item "-ttl"
The record's \s-1TTL\s0 value is included in the output.
.IP "\fB\-display\fR" 4
.IX Item "-display"
The record's display flag, used by \fBblinkenlights\fR, is included in the output.
.IP "\fB\-phstart\fR" 4
.IX Item "-phstart"
The record's rollover phase is included in the output.
If no rollover has yet been performed for this zone, an empty date is given.
.IP "\fB\-lastksk\fR" 4
.IX Item "-lastksk"
The record's last \s-1KSK\s0 rollover date is included in the output.
If no \s-1KSK\s0 rollover has yet been performed for this zone, an empty date is given.
.IP "\fB\-lastzsk\fR" 4
.IX Item "-lastzsk"
The record's last \s-1ZSK\s0 rollover date is included in the output.
If no \s-1ZSK\s0 rollover has yet been performed for this zone, an empty date is given.
.IP "\fB\-zsargs\fR" 4
.IX Item "-zsargs"
The record's user-defined \fBzonesigner\fR arguments are included in the output.
If no arguments have been set for this zone, then the value \*(L"(none)\*(R" is given.
.IP "\fB\-zonegroup\fR" 4
.IX Item "-zonegroup"
The zonegroups defined in the \fIrollrec\fR are listed, enclosed in double
quotes.  All other \fIrollrec\fR fields are ignored.  If the \fI\-long\fR option
is specified, then each zonegroup name will be accompanied by the number
of \fIrollrec\fR entries in that zonegroup.
.SS "Output-format Options"
.IX Subsection "Output-format Options"
These options select the type of output that will be given by \fIlsroll\fR.
.IP "\fB\-count\fR" 4
.IX Item "-count"
Only a count of matching keyrecs in the \fIrollrec\fR file is given.
.IP "\fB\-headers\fR" 4
.IX Item "-headers"
Display explanatory column headers.
.IP "\fB\-terse\fR" 4
.IX Item "-terse"
Terse output is given.  Only the record name and any other fields specifically
selected are included in the output.
.IP "\fB\-long\fR" 4
.IX Item "-long"
Long output is given.  All record fields are included.
.IP "\fB\-help\fR" 4
.IX Item "-help"
Display a usage message.
.IP "\fB\-Version\fR" 4
.IX Item "-Version"
Displays the version information for \fBlsroll\fR and the DNSSEC-Tools package.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2005\-2012 \s-1SPARTA\s0, Inc.  All rights reserved.
See the \s-1COPYING\s0 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"
\&\fB\f(BIblinkenlights\fB\|(8)\fR,
\&\fB\f(BIrollchk\fB\|(8)\fR,
\&\fB\f(BIrollinit\fB\|(8)\fR,
\&\fB\f(BIrollerd\fB\|(8)\fR
.PP
\&\fB\f(BINet::DNS::SEC::Tools::rollrec.pm\fB\|(3)\fR
.PP
\&\fB\f(BIfile\-rollrec\fB\|(5)\fR