mingw/html/lib/Term/Complete.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>Term::Complete - Perl word completion module</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:" />
   8 </head>
   9
  10 <body style="background-color: white">
  11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  13 <big><strong><span class="block">&nbsp;Term::Complete - Perl word completion module</span></strong></big>
  14 </td></tr>
  15 </table>
  16
  17 <p><a name="__index__"></a></p>
  18 <!-- INDEX BEGIN -->
  19
  20 <ul>
  21
  22         <li><a href="#name">NAME</a></li>
  23         <li><a href="#synopsis">SYNOPSIS</a></li>
  24         <li><a href="#description">DESCRIPTION</a></li>
  25         <li><a href="#diagnostics">DIAGNOSTICS</a></li>
  26         <li><a href="#bugs">BUGS</a></li>
  27         <li><a href="#author">AUTHOR</a></li>
  28 </ul>
  29 <!-- INDEX END -->
  30
  31 <hr />
  32 <p>
  33 </p>
  34 <h1><a name="name">NAME</a></h1>
  35 <p>Term::Complete - Perl word completion module</p>
  36 <p>
  37 </p>
  38 <hr />
  39 <h1><a name="synopsis">SYNOPSIS</a></h1>
  40 <pre>
  41     $input = Complete('prompt_string', \@completion_list);
  42     $input = Complete('prompt_string', @completion_list);</pre>
  43 <p>
  44 </p>
  45 <hr />
  46 <h1><a name="description">DESCRIPTION</a></h1>
  47 <p>This routine provides word completion on the list of words in
  48 the array (or array ref).</p>
  49 <p>The tty driver is put into raw mode and restored using an operating
  50 system specific command, in UNIX-like environments <code>stty</code>.</p>
  51 <p>The following command characters are defined:</p>
  52 <dl>
  53 <dt><strong><a name="item__3ctab_3e">&lt;tab&gt;</a></strong>
  54
  55 <dd>
  56 <p>Attempts word completion.
  57 Cannot be changed.</p>
  58 </dd>
  59 </li>
  60 <dt><strong><a name="item__5ed">^D</a></strong>
  61
  62 <dd>
  63 <p>Prints completion list.
  64 Defined by <em>$Term::Complete::complete</em>.</p>
  65 </dd>
  66 </li>
  67 <dt><strong><a name="item__5eu">^U</a></strong>
  68
  69 <dd>
  70 <p>Erases the current input.
  71 Defined by <em>$Term::Complete::kill</em>.</p>
  72 </dd>
  73 </li>
  74 <dt><strong><a name="item__3cdel_3e_2c__3cbs_3e">&lt;del&gt;, &lt;bs&gt;</a></strong>
  75
  76 <dd>
  77 <p>Erases one character.
  78 Defined by <em>$Term::Complete::erase1</em> and <em>$Term::Complete::erase2</em>.</p>
  79 </dd>
  80 </li>
  81 </dl>
  82 <p>
  83 </p>
  84 <hr />
  85 <h1><a name="diagnostics">DIAGNOSTICS</a></h1>
  86 <p>Bell sounds when word completion fails.</p>
  87 <p>
  88 </p>
  89 <hr />
  90 <h1><a name="bugs">BUGS</a></h1>
  91 <p>The completion character &lt;tab&gt; cannot be changed.</p>
  92 <p>
  93 </p>
  94 <hr />
  95 <h1><a name="author">AUTHOR</a></h1>
  96 <p>Wayne Thompson</p>
  97 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  98 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  99 <big><strong><span class="block">&nbsp;Term::Complete - Perl word completion module</span></strong></big>
 100 </td></tr>
 101 </table>
 102
 103 </body>
 104
 105 </html>