LSREALM(1)

πŸ“¦
version 2.2.3 Β· 2 versions
, in fedora 43

πŸ’– LSREALM πŸ’–

okay bestie, gather round, because this is lsrealm, a little Perl script that lives in the DNSSEC-Tools package and does exactly one job: it lists the realms in a realm file. that's it. that's the whole vibe. it's giving "quietly essential". πŸ’…


✨ SYNOPSIS ✨

lsrealm [options] <realm-files>

🌸 DESCRIPTION 🌸

so basically, this script lists out the contents of the realm files you hand it. all the realm files get loaded before anything gets displayed, so it's not like a live trickle situation, it's a whole-load-then-show moment. and here's the tea: if any realms have duplicated names β€” whether that's inside one single file or spread across multiple files β€” then the later realm wins. that's the one whose data you'll see. earlier one? ghosted. πŸ’€

what actually shows up for each realm in a realm file depends on three things, and honestly they're the whole personality of this tool:

  • the selected records
  • the selected attributes
  • the selected output format

every single option in those groups gets its own detailed moment in the next section, don't worry. but the three base output formats? let me introduce you right now.

  • -terse means you want a minimal amount of output. bare minimum. the "i'm in a hurry" format.
  • -long means you want a great deal of output. the "tell me everything, i have time" format.
  • and the record-selection + attribute-selection options can be used together with -terse so you get exactly the set of realm fields you actually need. curated. iconic.

the default output format is what you get when neither -terse nor -long is given β€” it's the middle ground between terse and long. the sensible one. the "i'm not doing too much" one. πŸŽ€

and here's the field breakdown, because you deserve to know exactly which fields show up in which format:

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

✨ OPTIONS ✨

so lsrealm recognizes three types of options, and yes they're each getting their own subsection because they're each that girl:

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

πŸŽ€ Record-selection Options πŸŽ€

these options pick which records lsrealm will display. by default, all records get displayed β€” so if you reach for one of these, you're actively narrowing things down. choosing. selective. we love that for you.

⚠️ heads up bestie: these options are mutually exclusive. pick one. not both. the audacity of picking both is not permitted here.
  • -active β€” lists all the active records in the realm file.
  • -inactive β€” lists all the inactive records in the realm file.

πŸ¦‹ Attribute-selection Options πŸ¦‹

these options pick which attributes of the records get displayed. mix and match, it's your world.

  • -admin β€” the record's administrator value gets included in the output. and if a realm doesn't have an administrator value? then you get the value (defadmin) instead. no silence, no blank, just (defadmin). πŸ’œ
  • -args β€” the record's user-defined arguments for the realm's rollover manager.
  • -configdir β€” the record's configuration directory gets included in the output. this value will be the filename only, unless you also pass -fullpaths β€” in which case the full pathname gets printed instead.
  • -display β€” the record's display flag, the one used by grandvizier, gets 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. so like, don't assume, but also, probably rollerd.
  • -realmdir β€” the record's realm directory gets included in the output. this value will be the filename only, unless the -fullpaths option is given β€” in which case the full pathname gets printed.
  • -rollrec β€” the record's rollrec file gets included in the output. this value will be the filename only, unless the -fullpaths option is given β€” in which case the full pathname gets printed.
  • -state β€” includes each realm record's state in the output. that state will be either active or inactive. and fun fact: this field is part of the default output already, so it shows up whether you ask or not. πŸ’…
  • -user β€” the record's user field, which is the user the realm's manager will be executed with. > ⚠️ and bestie, listen: this field is not yet implemented. so. yeah. know that going in. 😭

🌈 Output-format Options 🌈

these options pick the type of output lsrealm gives you. this is the glow-up stage.

  • -count β€” only a count of matching realms in the realm file is given. just a number. no notes. πŸ’€
  • -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. short and sweet by default.
  • -headers β€” display explanatory column headers.
  • -terse β€” terse output is given. only the record name and any other fields you specifically selected are included in the output. minimal. lean. efficient. 🧚
  • -long β€” long output is given. all record fields are included. every last one. no crumbs left behind. πŸ‘‘
  • -help β€” display a usage message.
  • -Version β€” displays the version information for lsrealm and the DNSSEC-Tools package. (capital V, bestie, don't @ me)

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


🫢 SEE ALSO 🫢

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

and that's the whole page, bestie!! this one's from the DNSSEC-Tools crew, written by perl v5.42.0 and dated 2025-07-23 β€” go forth and list some realms, you've got this πŸ’…βœ¨πŸŒΈ

πŸ“¦ where this page comes from