$reply = $term->get_reply( prompt => 'question?', [choices => \@list, default => $list[0], preput => "text to put as default user input", multi => BOOL, print_me => "extra text to print & record", allow => $ref] );

You have the option of providing a list of choices the user can pick from using the "choices" argument. If the answer is not in the list of choices presented, the question will be reposed.

If you provide a "default" answer, this will be returned when either $AUTOREPLY is set to true, (see the "GLOBAL VARIABLES" section further below), or when the user just hits "enter".

The "preput" argument allows to specify a text that will be inserted to the prompt line as the initial input which may be edited, deleted or accepted by the user. If you supply the empty string as the "preput" argument then the "default" value will be preputted. It will only work if the underlying readline module provide support for it (now it is supported only by the "Term::Readline::Gnu").

You can indicate that the user is allowed to enter multiple answers by toggling the "multi" flag. Note that a list of answers will then be returned to you, rather than a simple string.

By specifying an "allow" handler, you can yourself validate the answer a user gives. This can be any of the types that the Params::Check "allow" function allows, so please refer to that manpage for details.

Finally, you have the option of adding a "print_me" argument, which is simply printed before the prompt. It's printed to the same file handle as the rest of the questions, so you can use this to keep track of a full session of Q&A with the user, and retrieve it later using the "Term::UI->history_as_string" function.

See the "EXAMPLES" section for samples of how to use this function.

$bool = $term->ask_yn( prompt => "your question", [default => (y|1,n|0), print_me => "extra text to print & record"] )

The "default" answer will automatically returned, if the user hits "enter" or if $AUTOREPLY is set to true. See the "GLOBAL VARIABLES" section further below.

Also, you have the option of adding a "print_me" argument, which is simply printed before the prompt. It's printed to the same file handle as the rest of the questions, so you can use this to keep track of a full session of Q&A with the user, and retrieve it later using the "Term::UI->history_as_string" function.

See the "EXAMPLES" section for samples of how to use this function.

($opts, $munged) = $term->parse_options( STRING );

Consider this example:

    my $str =   q[command --no-foo --baz --bar=0 --quux=bleh ] .
                q[--option="some'thing" -one-dash -single=blah' arg];

    my ($options,$munged) =  $term->parse_options($str);

    ### $options would contain: ###
    $options = {
                'foo'       => 0,
                'bar'       => 0,
                'one-dash'  => 1,
                'baz'       => 1,
                'quux'      => 'bleh',
                'single'    => 'blah\'',
                'option'    => 'some\'thing'
    };

    ### and this is the munged version of the input string,
    ### ie what's left of the input minus the options
    $munged = 'command arg';

As you can see, you can either use a single or a double "-" to indicate an option. If you prefix an option with "no-" and do not give it a value, it will be set to 0. If it has no prefix and no value, it will be set to 1. Otherwise, it will be set to its value. Note also that it can deal fine with single/double quoting issues.

$str = $term->history_as_string

Consult the "Term::UI::History" man page for details.

$Term::UI::VERBOSE

$Term::UI::AUTOREPLY

$Term::UI::INVALID

$Term::UI::History::HISTORY_FH

This defaults to *STDOUT.

Basic get_reply sample

    ### ask a user (with an open question) for their favourite colour
    $reply = $term->get_reply( prompt => 'Your favourite colour? );

which would look like:

    Your favourite colour?

and $reply would hold the text the user typed.

get_reply with choices

    ### now provide a list of choices, so the user has to pick one
    $reply = $term->get_reply(
                prompt  => 'Your favourite colour?',
                choices => [qw|red green blue|] );

which would look like:

      1> red
      2> green
      3> blue

    Your favourite colour?

$reply will hold one of the choices presented. "Term::UI" will repose the question if the user attempts to enter an answer that's not in the list of choices. The string presented is held in the $Term::UI::INVALID variable (see the "GLOBAL VARIABLES" section for details.

get_reply with choices and default

    ### provide a sensible default option -- everyone loves blue!
    $reply = $term->get_reply(
                prompt  => 'Your favourite colour?',
                choices => [qw|red green blue|],
                default => 'blue' );

which would look like:

      1> red
      2> green
      3> blue

    Your favourite colour? [3]:

Note the default answer after the prompt. A user can now just hit "enter" (or set $Term::UI::AUTOREPLY -- see the "GLOBAL VARIABLES" section) and the sensible answer 'blue' will be returned.

get_reply using print_me & multi

    ### allow the user to pick more than one colour and add an
    ### introduction text
    @reply = $term->get_reply(
                print_me    => 'Tell us what colours you like',
                prompt      => 'Your favourite colours?',
                choices     => [qw|red green blue|],
                multi       => 1 );

which would look like:

    Tell us what colours you like
      1> red
      2> green
      3> blue

    Your favourite colours?

An answer of "3 2 1" would fill @reply with "blue green red"

get_reply & allow

    ### pose an open question, but do a custom verification on
    ### the answer, which will only exit the question loop, if
    ### the answer matches the allow handler.
    $reply = $term->get_reply(
                prompt  => "What is the magic number?",
                allow   => 42 );

Unless the user now enters 42, the question will be reposed over and over again. You can use more sophisticated "allow" handlers (even subroutines can be used). The "allow" handler is implemented using "Params::Check"'s "allow" function. Check its manpage for details.

an elaborate ask_yn sample

    ### ask a user if he likes cookies. Default to a sensible 'yes'
    ### and inform him first what cookies are.
    $bool = $term->ask_yn( prompt   => 'Do you like cookies?',
                           default  => 'y',
                           print_me => 'Cookies are LOVELY!!!' );

would print:

    Cookies are LOVELY!!!
    Do you like cookies? [Y/n]:

If a user then simply hits "enter", agreeing with the default, $bool would be set to "true". (Simply hitting 'y' would also return "true". Hitting 'n' would return "false")

We could later retrieve this interaction by printing out the Q&A history as follows:

    print $term->history_as_string;

which would then print:

    Cookies are LOVELY!!!
    Do you like cookies? [Y/n]:  y

There's a chance we're doing this non-interactively, because a console is missing, the user indicated he just wanted the defaults, etc.

In this case, simply setting $Term::UI::AUTOREPLY to true, will return from every question with the default answer set for the question. Do note that if "AUTOREPLY" is true, and no default is set, "Term::UI" will warn about this and return "undef".