home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / perl5 / Pod::Text.z / Pod::Text
Encoding:
Text File  |  1998-10-30  |  1.9 KB  |  67 lines
  1.  
  2.  
  3.  
  4. PPPPoooodddd::::::::TTTTeeeexxxxtttt((((3333))))                                                      PPPPoooodddd::::::::TTTTeeeexxxxtttt((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      Pod::Text - convert POD data to formatted ASCII text
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.              use Pod::Text;
  13.  
  14.              pod2text("perlfunc.pod");
  15.  
  16.      Also:
  17.  
  18.              pod2text [B<-a>] [B<->I<width>] < input.pod
  19.  
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      Pod::Text is a module that can convert documentation in the POD format
  23.      (such as can be found throughout the Perl distribution) into formatted
  24.      ASCII.  Termcap is optionally supported for boldface/underline, and can
  25.      enabled via $Pod::Text::termcap=1. If termcap has not been enabled, then
  26.      backspaces will be used to simulate bold and underlined text.
  27.  
  28.      A separate _p_o_d_2_t_e_x_t program is included that is primarily a wrapper for
  29.      Pod::Text.
  30.  
  31.      The single function pod2text() can take the optional options ----aaaa for an
  32.      alternative output format, then a ----_w_i_d_t_h option with the max terminal
  33.      width, followed by one or two arguments. The first should be the name of
  34.      a file to read the pod from, or "<&STDIN" to read from STDIN. A second
  35.      argument, if provided, should be a filehandle glob where output should be
  36.      sent.
  37.  
  38. AAAAUUUUTTTTHHHHOOOORRRR
  39.      Tom Christiansen <_t_c_h_r_i_s_t@_m_o_x._p_e_r_l._c_o_m>
  40.  
  41. TTTTOOOODDDDOOOO
  42.      Cleanup work. The input and output locations need to be more flexible,
  43.      termcap shouldn't be a global variable, and the terminal speed needs to
  44.      be properly calculated.
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.