App::Sp...rameter(3)

💅 NAME 💅

okay so bestie, this page is App::Spec::Parameter — and it's giving App::Spec objects representing command line parameters. The manual name is User Contributed Perl Documentation, and the page header title is App::Sp...rameter(3); folding that in right here so you're not confused later. 💖

🌸 SYNOPSIS 🌸

Short and iconic: this class inherits from App::Spec::Argument. That's the whole synopsis, no cap. 🫶

✨ METHODS ✨

These are the methods on deck, bestie.

🛠️ build

Use it like this:

my $param = App::Spec::Parameter->build(
    name => 'verbose',
    summary => 'lala',
);

The example passes name => 'verbose' and summary => 'lala', and that's literally it. Slay. 🌟

📏 to_usage_header

Call it on your param like this:

my $param_usage_header = $param->to_usage_header;
# results
# if multiple and required
# <$name>+
# if multiple
# [<$name>+]
# if required
# <$name>
# else
# [<$name>}

The comments are the cheat sheet for what the result looks like depending on whether it's multiple and required, just multiple, required, or neither. Keep that last # [<$name>} exactly as shown, bestie — character for character, no editing. 💅

that's the whole page, babe. 🎀 This is from perl v5.42.0, dated 2025-03-26, and the footer title is App::Sp...rameter(3). periodt. ✨🦋