.\" 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 "LSREALM 1p"
.TH LSREALM 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"
lsrealm \- List the realms in a DNSSEC\-Tools realm file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  lsrealm [options] <realm\-files>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This script lists the contents of the specified \fIrealm\fR files.  All \fIrealm\fR
files are loaded before the output is displayed.  If any \fIrealm\fRs have
duplicated names, whether within one file or across multiple files, the later
\&\fIrealm\fR will be the one whose data are displayed.
.PP
The output displayed for each realm in a \fIrealm\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 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 \fIrealm\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
The table below shows the fields displayed for each output format.
.PP
.Vb 10
\&    realm field          default        terse        long
\&    \-\-\-\-\-\-\-\-\-\-\-\-\-        \-\-\-\-\-\-\-        \-\-\-\-\-        \-\-\-\-
\&    realm name             yes           yes         yes
\&    state                  yes           no          yes
\&    config directory       no            no          yes
\&    realm directory        no            no          yes
\&    rollrec file           no            no          yes
\&    administrator          no            no          yes
\&    directory              no            no          yes
\&    display flag           no            no          yes
\&    manager                no            no          yes
\&    manager arguments      no            no          yes
\&    user                   no            no          yes
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
There are three types of options recognized by \fBlsrealm\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 \fBlsrealm\fR.
By default, all records will be displayed; selecting one or the other of
these options will restrict the records shown.
.PP
These options are mutually exclusive.
.IP "\fB\-active\fR" 4
.IX Item "-active"
List all active records in the \fIrealm\fR file.
.IP "\fB\-inactive\fR" 4
.IX Item "-inactive"
List all inactive records in the \fIrealm\fR file.
.SS "Attribute-selection Options"
.IX Subsection "Attribute-selection Options"
These options select the attributes of the records that will be displayed
by \fBlsrealm\fR.
.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 \fIrealm\fR, then the value
\&\*(L"(defadmin)\*(R" will be given.
.IP "\fB\-args\fR" 4
.IX Item "-args"
The record's user-defined arguments for the realm's rollover manager.
.IP "\fB\-configdir\fR" 4
.IX Item "-configdir"
The record's configuration directory is included in the output.
This value will be the filename only, unless the \fB\-fullpaths\fR option
is given.  In that case, the full pathname will be printed.
.IP "\fB\-display\fR" 4
.IX Item "-display"
The record's display flag, used by \fBgrandvizier\fR is included in the output.
.IP "\fB\-manager\fR" 4
.IX Item "-manager"
The record's manager field, indicating which rollover manager is used for the
realm..  The default is \fBrollerd\fR, but individual installations may use other
managers.
.IP "\fB\-realmdir\fR" 4
.IX Item "-realmdir"
The record's realm directory is included in the output.
This value will be the filename only, unless the \fB\-fullpaths\fR option
is given.  In that case, the full pathname will be printed.
.IP "\fB\-rollrec\fR" 4
.IX Item "-rollrec"
The record's \fIrollrec\fR file is included in the output.
This value will be the filename only, unless the \fB\-fullpaths\fR option
is given.  In that case, the full pathname will be printed.
.IP "\fB\-state\fR" 4
.IX Item "-state"
Include each \fIrealm\fR record's state in the output.  The state will be
either \*(L"active\*(R" or \*(L"inactive\*(R".
This field is part of the default output.
.IP "\fB\-user\fR" 4
.IX Item "-user"
The record's user field, which is the user the realm's manager will be
executed with.  \fIThis field is not yet implemented.\fR
.SS "Output-format Options"
.IX Subsection "Output-format Options"
These options select the type of output that will be given by \fIlsrealm\fR.
.IP "\fB\-count\fR" 4
.IX Item "-count"
Only a count of matching realms in the \fIrealm\fR file is given.
.IP "\fB\-fullpaths\fR" 4
.IX Item "-fullpaths"
Display pathname data as the full pathname given in the realm file.
If this option is not specified, only the filename itself will be displayed.
.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 \fBlsrealm\fR and the DNSSEC-Tools package.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 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(BIdtrealms\fB\|(8)\fR,
\&\fB\f(BIgrandvizier\fB\|(8)\fR,
\&\fB\f(BIrealminit\fB\|(8)\fR
.PP
\&\fB\f(BINet::DNS::SEC::Tools::realm.pm\fB\|(3)\fR
.PP
\&\fB\f(BIfile\-realm\fB\|(5)\fR