📄 term::ui.3
字号:
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05).\".\" Standard preamble:.\" ========================================================================.de Sh \" Subsection heading.br.if t .Sp.ne 5.PP\fB\\$1\fR.PP...de Sp \" Vertical space (when we can't use .PP).if t .sp .5v.if n .sp...de Vb \" Begin verbatim text.ft CW.nf.ne \\$1...de Ve \" End verbatim text.ft R.fi...\" Set up some character translations and predefined strings. \*(-- will.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left.\" double quote, and \*(R" will give a right double quote. \*(C+ will.\" give a nicer C++. Capital omega is used to do unbreakable dashes and.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,.\" nothing in troff, for use with C<>..tr \(*W-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'.ie n \{\. ds -- \(*W-. ds PI pi. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch. ds L" "". ds R" "". ds C` "". ds C' ""'br\}.el\{\. ds -- \|\(em\|. ds PI \(*p. ds L" ``. ds R" '''br\}.\".\" Escape single quotes in literal strings from groff's Unicode transform..ie \n(.g .ds Aq \(aq.el .ds Aq '.\".\" If the F register is turned on, we'll generate index entries on stderr for.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index.\" entries marked with X<> in POD. Of course, you'll have to process the.\" output yourself in some meaningful fashion..ie \nF \{\. de IX. tm Index:\\$1\t\\n%\t"\\$2"... nr % 0. rr F.\}.el \{\. de IX...\}.\".\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2)..\" Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff.if n \{\. ds #H 0. ds #V .8m. ds #F .3m. ds #[ \f1. ds #] \fP.\}.if t \{\. ds #H ((1u-(\\\\n(.fu%2u))*.13m). ds #V .6m. ds #F 0. ds #[ \&. ds #] \&.\}. \" simple accents for nroff and troff.if n \{\. ds ' \&. ds ` \&. ds ^ \&. ds , \&. ds ~ ~. ds /.\}.if t \{\. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u". ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'.\}. \" troff and (daisy-wheel) nroff accents.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'.ds 8 \h'\*(#H'\(*b\h'-\*(#H'.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#].ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#].ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#].ds ae a\h'-(\w'a'u*4/10)'e.ds Ae A\h'-(\w'A'u*4/10)'E. \" corrections for vroff.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'. \" for low resolution devices (crt and lpr).if \n(.H>23 .if \n(.V>19 \\{\. ds : e. ds 8 ss. ds o a. ds d- d\h'-1'\(ga. ds D- D\h'-1'\(hy. ds th \o'bp'. ds Th \o'LP'. ds ae ae. ds Ae AE.\}.rm #[ #] #H #V #F C.\" ========================================================================.\".IX Title "Term::UI 3".TH Term::UI 3 "2007-12-18" "perl v5.10.0" "Perl Programmers Reference Guide".\" For nroff, turn off justification. Always turn off hyphenation; it makes.\" way too many mistakes in technical documents..if n .ad l.nh.SH "NAME"Term::UI \- Term::ReadLine UI made easy.SH "SYNOPSIS".IX Header "SYNOPSIS".Vb 2\& use Term::UI;\& use Term::ReadLine;\&\& my $term = Term::ReadLine\->new(\*(Aqbrand\*(Aq);\&\& my $reply = $term\->get_reply(\& prompt => \*(AqWhat is your favourite colour?\*(Aq,\& choices => [qw|blue red green|],\& default => blue,\& );\&\& my $bool = $term\->ask_yn(\& prompt => \*(AqDo you like cookies?\*(Aq,\& default => \*(Aqy\*(Aq,\& );\&\&\& my $string = q[some_command \-option \-\-no\-foo \-\-quux=\*(Aqthis thing\*(Aq];\&\& my ($options,$munged_input) = $term\->parse_options($string);\&\&\& ### don\*(Aqt have Term::UI issue warnings \-\- default is \*(Aq1\*(Aq\& $Term::UI::VERBOSE = 0;\&\& ### always pick the default (good for non\-interactive terms)\& ### \-\- default is \*(Aq0\*(Aq\& $Term::UI::AUTOREPLY = 1;\& \& ### Retrieve the entire session as a printable string:\& $hist = Term::UI::History\->history_as_string;\& $hist = $term\->history_as_string;.Ve.SH "DESCRIPTION".IX Header "DESCRIPTION"\&\f(CW\*(C`Term::UI\*(C'\fR is a transparent way of eliminating the overhead of havingto format a question and then validate the reply, informing the userif the answer was not proper and re-issuing the question..PPSimply give it the question you want to ask, optionally with choicesthe user can pick from and a default and \f(CW\*(C`Term::UI\*(C'\fR will \s-1DWYM\s0..PPFor asking a yes or no question, there's even a shortcut..SH "HOW IT WORKS".IX Header "HOW IT WORKS"\&\f(CW\*(C`Term::UI\*(C'\fR places itself at the back of the \f(CW\*(C`Term::ReadLine\*(C'\fR \&\f(CW@ISA\fR array, so you can call its functions through your term object..PP\&\f(CW\*(C`Term::UI\*(C'\fR uses \f(CW\*(C`Term::UI::History\*(C'\fR to record all interactionswith the commandline. You can retrieve this history, or alterthe filehandle the interaction is printed to. See the \&\f(CW\*(C`Term::UI::History\*(C'\fR manpage or the \f(CW\*(C`SYNOPSIS\*(C'\fR for details..SH "METHODS".IX Header "METHODS".ie n .Sh "$reply\fP = \f(CW$term\fP\->get_reply( prompt => 'question?', [choices => \e@list, default => \f(CW$list\fP[0], multi => \s-1BOOL\s0, print_me => ""extra text to print & record"", allow => \f(CW$ref] );".el .Sh "\f(CW$reply\fP = \f(CW$term\fP\->get_reply( prompt => 'question?', [choices => \e@list, default => \f(CW$list\fP[0], multi => \s-1BOOL\s0, print_me => ``extra text to print & record'', allow => \f(CW$ref\fP] );".IX Subsection "$reply = $term->get_reply( prompt => 'question?', [choices => @list, default => $list[0], multi => BOOL, print_me => extra text to print & record, allow => $ref] );"\&\f(CW\*(C`get_reply\*(C'\fR asks a user a question, and then returns the reply to thecaller. If the answer is invalid (more on that below), the question willbe reposed, until a satisfactory answer has been entered..PPYou have the option of providing a list of choices the user can pick fromusing the \f(CW\*(C`choices\*(C'\fR argument. If the answer is not in the list of choicespresented, the question will be reposed..PPIf you provide a \f(CW\*(C`default\*(C'\fR answer, this will be returned when either\&\f(CW$AUTOREPLY\fR is set to true, (see the \f(CW\*(C`GLOBAL VARIABLES\*(C'\fR section furtherbelow), or when the user just hits \f(CW\*(C`enter\*(C'\fR..PPYou can indicate that the user is allowed to enter multiple answers bytoggling the \f(CW\*(C`multi\*(C'\fR flag. Note that a list of answers will then bereturned to you, rather than a simple string..PPBy specifying an \f(CW\*(C`allow\*(C'\fR hander, you can yourself validate the answera user gives. This can be any of the types that the Params::Check \f(CW\*(C`allow\*(C'\fR function allows, so please refer to that manpage for details..PPFinally, you have the option of adding a \f(CW\*(C`print_me\*(C'\fR argument, which issimply printed before the prompt. It's printed to the same file handleas the rest of the questions, so you can use this to keep track of afull session of Q&A with the user, and retrieve it later using the\&\f(CW\*(C`Term::UI\->history_as_string\*(C'\fR function..PPSee the \f(CW\*(C`EXAMPLES\*(C'\fR section for samples of how to use this function..ie n .Sh "$bool\fP = \f(CW$term\->ask_yn( prompt => ""your question"", [default => (y|1,n|0), print_me => ""extra text to print & record""] )".el .Sh "\f(CW$bool\fP = \f(CW$term\fP\->ask_yn( prompt => ``your question'', [default => (y|1,n|0), print_me => ``extra text to print & record''] )".IX Subsection "$bool = $term->ask_yn( prompt => your question, [default => (y|1,n|0), print_me => extra text to print & record] )"Asks a simple \f(CW\*(C`yes\*(C'\fR or \f(CW\*(C`no\*(C'\fR question to the user, returning a booleanindicating \f(CW\*(C`true\*(C'\fR or \f(CW\*(C`false\*(C'\fR to the caller..PPThe \f(CW\*(C`default\*(C'\fR answer will automatically returned, if the user hits \&\f(CW\*(C`enter\*(C'\fR or if \f(CW$AUTOREPLY\fR is set to true. See the \f(CW\*(C`GLOBAL VARIABLES\*(C'\fRsection further below..PPAlso, you have the option of adding a \f(CW\*(C`print_me\*(C'\fR argument, which issimply printed before the prompt. It's printed to the same file handle
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -