Skip to content

Commit

Permalink
Update defaults declarations
Browse files Browse the repository at this point in the history
 * Add missing declarations
 * Change nomenclature from on/off to enabled/disabled
 * Update formatting
  • Loading branch information
mattias-p committed Nov 12, 2024
1 parent 7a52559 commit 84003af
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions script/zonemaster-cli
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ Print the effective profile used in JSON format, then exit.

Limit the testing suite to run only the specified tests.
Can be specified multiple times.
(default: all test cases)

=for :man This can be the name of a testing module, in which case all test cases from
that module will be run, or the name of a module followed by a slash and the
Expand All @@ -125,7 +126,7 @@ This option is case-insensitive.
=item B<--level>=LEVEL

Specify the minimum level of a message to be printed.
Default: NOTICE
(default: NOTICE)

=for :man Messages with this level
(or higher) will be printed. The levels are, from highest to lowest:
Expand All @@ -139,6 +140,7 @@ not useful for most users.
=item B<--stop-level>=LEVEL

Specify the minimum severity level after which the testing suite is terminated.
(default: CRITICAL)

=for :man The levels are, from highest to lowest: CRITICAL, ERROR, WARNING, NOTICE,
INFO, DEBUG, DEBUG2 and DEBUG3.
Expand All @@ -148,14 +150,14 @@ INFO, DEBUG, DEBUG2 and DEBUG3.
=item B<--[no-]progress>

Print an activity indicator ("spinner").
Default: on (if the process' standard output is a TTY)
(default: enabled if the process' standard output is a TTY)

=for :man Useful to know that something is happening during a run.

=item B<--[no-]ipv4>, B<--[no-]ipv6>

Enable or disable queries over IPv4 or IPv6.
Default: both enabled
(default: both enabled)

=begin :man

Expand All @@ -182,14 +184,14 @@ the given profile JSON file.
=item B<--[no-]json>

Print results as JSON instead of human language.
Default: off
(default: disabled)

=begin :man

=item B<--[no-]json-stream>

Stream the results as JSON.
Default: off
(default: disabled)

=for :man Useful to follow the progress in a machine-readable way.

Expand All @@ -203,6 +205,7 @@ to human language.
=item B<--locale>=LOCALE

Specify which locale to be used by the translation system.
(default: system locale or English)

=for :man If not given, the
translation system itself will look at environment variables to try and guess.
Expand All @@ -214,22 +217,22 @@ locale, and if that doesn't exist either, to English.
=item B<--[no-]time>

Print the timestamp for each message.
Default: on
(default: enabled)

=item B<--[no-]show-level>

Print the severity level for each message.
Default: on
(default: enabled)

=item B<--[no-]show-module>

Print the name of the module which produced the message.
Default: off
(default: disabled)

=item B<--[no-]show-testcase>

Print the name of the test case (test case identifier) which produced the message.
Default: off
(default: disabled)

=end :man

Expand All @@ -245,17 +248,18 @@ Default: off

Print a summary, at the end of a run, of the numbers of messages for each severity
level that were logged during the run.
Default: off
(default: disabled)

=item B<--[no-]nstimes>

Print a summary, at the end of a run, of the times (in milliseconds) the zone's
name servers took to answer.
(default: disabled)

=item B<--[no-]elapsed>

Print elapsed time (in seconds) at end of a run.
Default: off
(default: disabled)

=back

Expand Down

0 comments on commit 84003af

Please sign in to comment.