Getopt...::List(3pm)

✨ Getopt::Yath::Option::List — Options that can take multiple values 💅

okay bestie, settle in, because this is the Getopt...::List(3pm) page from the User Contributed Perl Documentation, and it's literally about options that can hold multiple values at once. group-chat energy, but make it command line. 🎀

---

🌸 NAME 🌸

Getopt::Yath::Option::List — Options that can take multiple values. slay.

---

🌈 DESCRIPTION 🌈

So here's the tea 🍓: this thing can take multiple values. Every time you hit it with --opt VAL, it just appends a value onto the list. Casual. Effortless. Iconic.

--no-opt will empty the list entirely — like, poof, gone, no trace, main character exit. 💀

And if a split_on parameter is provided, then a single use can set multiple values at once. For example, if split_on is set to , and you do --opt foo,bar, then both foo and bar get added to the list. one command, two values, we love efficiency. ✨

---

🦋 SYNOPSIS 🦋

option copy_env => (
    short => 'e',
    type => 'List',
    description => "Specify environment variables to pass along with their current values",
    long_examples => [ ' HOME', ' SHELL' ],
    short_examples => [ ' HOME', ' SHELL' ],
);

look at her. she's doing so much. 👑

---

💖 METHODS 💖

Every single method from Getopt::Yath::Option is inherited — you get all of it for free, no cap. The ones below are the overridden or otherwise noteworthy girlies:

• requires_arg: true
• allows_list: true — Each use of --opt VAL appends to the list. --no-opt empties it. literally the whole personality.
• normalize_value(@input) — If the input looks like a JSON array (e.g., '["a","b"]'), it is decoded and the elements are returned. And if split_on is set? Values are split on that delimiter before normalization, bestie. order matters. 🧚
• get_initial_value — Checks from_env_vars for initial values. And unlike the base class, multiple environment variables can each contribute a value — every env var pulls its weight. Returns an empty arrayref if no environment values are found. 🫶

---

🎀 ADDITIONAL ATTRIBUTES 🎀

• split_on => $delimiter — A string or regex to split values on. For example, with split_on => ',', then --opt foo,bar adds both foo and bar to the list. one flag, two entries, no notes. 🌟

---

🔥 SOURCE 🔥

The source code repository for Getopt-Yath can be found at http://github.com/Test-More/Getopt-Yath/ — go be nosy, she's open source. 💜

---

👑 MAINTAINERS 👑

Chad Granum <exodist@cpan.org>

---

⭐ AUTHORS ⭐

Chad Granum <exodist@cpan.org>

---

🌸 COPYRIGHT 🌸

Copyright Chad Granum <exodist7@gmail.com>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/

---

This was perl v5.40.1, documented on 2026-05-10, and that's the whole Getopt...::List(3pm) page babes — read it, love it, go append to a list responsibly. bye bestie! 💅✨🎀