LSREALM(1)

📦 version 2.2.3, in arch rolling

💅 LSREALM(1) — like, the whole manual, bestie

okay so real quick: this is the lsrealm page from the User Contributed Perl Documentation, and it's genuinely one of the most chill little tools in the whole DNSSEC-Tools universe. no cap. let's get into it ✨

🌸 NAME

lsrealm — list the realms in a DNSSEC-Tools realm file. that's it. that's the whole job. she's a lister. an icon. 💅

🦋 SYNOPSIS

lsrealm [options] <realm-files>

🎀 DESCRIPTION

so this script lists the contents of the realm files you point it at. and here's the thing — all the realm files get loaded before any output shows up. so it's giving "let me gather everyone first, then I'll introduce them." 🙈

if any realms have duplicated names — and like, this can happen within one file or across multiple files, it's not picky — then the later realm is the one whose data gets displayed. the earlier one? ghosted. 💀

the output for each realm depends on three things: the selected records, the selected attributes, and the selected output format. each option in those groups gets its own little deep dive in the next section, but the three base output formats get described right here 👑

  • -terse → you want the bare minimum of output. minimal. lowkey.
  • -long → you want a lot. the whole lore. 🫶

and the record-selection + attribute-selection options can be combined with -terse to show exactly the set of realm fields you need. curated. bespoke. main character energy.

the default output format — the one you get when you pass neither -terse nor -long — is that perfect middle ground between terse and long. not too much, not too little. just right. 🍓

here's the field breakdown for each format (i kept every single yes/no, don't worry):

realm name

  • default: yes
  • terse: yes
  • long: yes

state

  • default: yes
  • terse: no
  • long: yes

config directory

  • default: no
  • terse: no
  • long: yes

realm directory

  • default: no
  • terse: no
  • long: yes

rollrec file

  • default: no
  • terse: no
  • long: yes

administrator

  • default: no
  • terse: no
  • long: yes

directory

  • default: no
  • terse: no
  • long: yes

display flag

  • default: no
  • terse: no
  • long: yes

manager

  • default: no
  • terse: no
  • long: yes

manager arguments

  • default: no
  • terse: no
  • long: yes

user

  • default: no
  • terse: no
  • long: yes

so yeah — -terse is literally just the name (plus whatever else you specifically asked for), default is name + state, and -long is the full glow-up where every single field shows up. 💖

✨ OPTIONS ✨

there are three types of options lsrealm recognizes, bestie:

  1. record-selection options
  2. attribute-selection options
  3. output-format options

each type gets its own subsection below. iykyk 🧚

🔍 Record-selection Options

these options pick which records lsrealm will display. by default, all records are displayed — so choosing one of these restricts what you see. it's giving "you can have the whole menu, or you can be decisive."

⚠️ heads up: these options are mutually exclusive. pick one. not both. please. 💀
  • -active — list all active records in the realm file. 🔥
  • -inactive — list all inactive records in the realm file. 😴

🎯 Attribute-selection Options

these options choose which attributes of the records get displayed. mix and match, queen. 🌈

  • -admin — the record's administrator value is included in the output. and if a realm doesn't have an administrator value, you get the value (defadmin) instead. she's the default for a reason 💅
  • -args — the record's user-defined arguments for the realm's rollover manager.
  • -configdir — the record's configuration directory is included in the output. this value is the filename only, unless you also pass -fullpaths — in which case the full pathname gets printed. ✨
  • -display — the record's display flag (the one used by grandvizier) is included in the output.
  • -manager — the record's manager field, which tells you which rollover manager is used for the realm. the default is rollerd, but individual installations may use other managers. 🤷‍♀️
  • -realmdir — the record's realm directory is included in the output. this value is the filename only, unless you pass -fullpaths, and then it's the full pathname. 🦋
  • -rollrec — the record's rollrec file is included in the output. again: filename only, unless -fullpaths is given, in which case — say it with me — full pathname. 🎀
  • -state — include each realm record's state in the output. the state is either "active" or "inactive". oh and btw, this field is part of the default output. so you're getting it anyway unless you go terse. 👑
  • -user — the record's user field, which is the user the realm's manager will be executed with. small thing though: this field is not yet implemented. 🙈

💫 Output-format Options

these options pick the type of output lsrealm gives you.

  • -count — only a count of matching realms in the realm file is given. just a number. no vibes, just math. 🔢
  • -fullpaths — display pathname data as the full pathname given in the realm file. if you don't specify this option, only the filename itself gets displayed.
  • -headers — display explanatory column headers. yes, labels. we love context. 🏷️
  • -terse — terse output is given. only the record name and any other fields you specifically selected are included. minimalism, but make it functional. ✨
  • -long — long output is given. all record fields are included. the full story, no skips. 🔥
  • -help — display a usage message. a little help, a little guidance. 🫶
  • -Version — displays the version information for lsrealm and the DNSSEC-Tools package. 👑

Copyright 2012-2014 SPARTA, Inc. All rights reserved. see the COPYING file included with the DNSSEC-Tools package for details. 📄

💜 AUTHOR

Wayne Morrison, tewok@tislabs.com — certified author of this page, we appreciate them fr fr 🫡

🔗 SEE ALSO

  • dtrealms(8)
  • grandvizier(8)
  • realminit(8)
  • Net::DNS::SEC::Tools::realm.pm(3)
  • file-realm(5)

aaand that's the whole page!! 🎉 this was LSREALM(1), perl v5.44.0, dated 2026-10-17 — mwah, and good luck out there, bestie 💖🌸

📦 where this page comes from