home *** CD-ROM | disk | FTP | other *** search
/ The AGA Experience 2 / agavol2.iso / software / utilities / comms / metamail-2.3a / man / richtext.1 < prev    next >
Text File  |  1992-06-14  |  5KB  |  131 lines
  1.  
  2.  
  3.  
  4. richtext(1)              USER COMMANDS                richtext(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      richtext - View a richtext document, typically a  mail  mes-
  10.      sage
  11.  
  12. SYNOPSIS
  13.      richtext [-c] [-f] [-n] [-p] [-t] [file]
  14.  
  15. DESCRIPTION
  16.      The _r_i_c_h_t_e_x_t program allows users to view  "richtext"  files
  17.      on  an  ASCII  terminal.  It uses termcap(5) capabilities to
  18.      highlight text that is supposed to be bold or italic, and to
  19.      underline  text  that is supposed to be underlined.  It also
  20.      implements most of the richtext commands  that  have  to  do
  21.      with indentation and justification, as well as the "excerpt"
  22.      and "signature" commands.
  23.  
  24.      Richtext is a very simple markup language for  sending  rich
  25.      text  through  the  mail.   It  is  not  to be confused with
  26.      Microsoft's RTF (Rich Text Format).  It is part of the  MIME
  27.      standard for multimedia Internet mail.
  28.  
  29.      The _r_i_c_h_t_e_x_t program takes raw richtext output on its  stan-
  30.      dard  input  or from a file and produces formatted output on
  31.      its standard output, which is assumed to be a terminal.   It
  32.      is intended primarily for use by the metamail(1) program.
  33.  
  34.      The program will also repair the raw input to match  up  any
  35.      richtext command pairs that are out of order.
  36.  
  37. OPTIONS
  38.      When invoked with no options, _r_i_c_h_t_e_x_t expects raw  richtext
  39.      on  its standard input, which is corrected, and then format-
  40.      ted output is written on its standard output.  The following
  41.      options can alter that behaviour:
  42.  
  43.      -c      This option directs _r_i_c_h_t_e_x_t to just correct the raw
  44.              richtext  and  write  the  corrected  version to its
  45.              standard output, without performing any formatting.
  46.  
  47.      -f      This option directs _r_i_c_h_t_e_x_t to use  termcap-derived
  48.              escape  codes  for  bold  and  italic  text, even if
  49.              _r_i_c_h_t_e_x_t is called in a pipe.
  50.  
  51.      -n      This option directs _r_i_c_h_t_e_x_t to not do  any  correc-
  52.              tion to the raw richtext it receives.
  53.  
  54.      -p      This enables the use of a pager which reports "Press
  55.              RETURN  to  go  on"  after each screen-full of data.
  56.              Alternatively,   if   the    environment    variable
  57.              MM_USEPAGER  is present, then the pager will also be
  58.              used.  This option and the environment variable have
  59.              no  effect  if  either  standard  input  or standard
  60.  
  61.  
  62.  
  63. Sun Release 4.1      Last change: Release 1                     1
  64.  
  65.  
  67.  
  68.  
  69. richtext(1)              USER COMMANDS                richtext(1)
  70.  
  71.  
  72.  
  73.              output is redirected.
  74.  
  75.      -a      This option, which is only available under DOS, tog-
  76.              gles  whether or not to use ANSI mode for highlight-
  77.              ing bold, italic, or underlined text.
  78.  
  79.      -t      This option directs _r_i_c_h_t_e_x_t  NOT  to  use  termcap-
  80.              derived  escape codes for bold and italic text, even
  81.              if _r_i_c_h_t_e_x_t is called in a terminal.   Instead,  "*"
  82.              and "_" will be used to highlight the affected text.
  83.  
  84. X11 Resources
  85.      If you're using the xterm program, you can control what font
  86.      is used for bold text using the "xterm*boldFont" resource.
  87.  
  88. SEE ALSO
  89.      metamail(1), mailto(1), termcap(5)
  90.  
  91. BUGS
  92.      This is a very quick hack, really -- an attempt  to  provide
  93.      minimal  richtext support for an ASCII terminal.  The author
  94.      makes no pretense of having gotten every single case right.
  95.  
  96. COPYRIGHT
  97.      Copyright  (c)  1991  Bell  Communications  Research,   Inc.
  98.      (Bellcore)
  99.  
  100.      Permission  to  use,  copy,  modify,  and  distribute   this
  101.      material  for any purpose and without fee is hereby granted,
  102.      provided that the above copyright notice and this permission
  103.      notice  appear  in all copies, and that the name of Bellcore
  104.      not be used in advertising or publicity pertaining  to  this
  105.      material  without  the specific, prior written permission of
  106.      an authorized representative of Bellcore.  BELLCORE MAKES NO
  107.      REPRESENTATIONS  ABOUT  THE  ACCURACY OR SUITABILITY OF THIS
  108.      MATERIAL FOR ANY PURPOSE.  IT IS PROVIDED "AS  IS",  WITHOUT
  109.      ANY EXPRESS OR IMPLIED WARRANTIES.
  110.  
  111. AUTHORS
  112.      Nathaniel S. Borenstein
  113.      Richtext   correction   algorithm   by    Rhys    Weatherley
  114.      (rhys@cs.uq.oz.au).
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  125.  
  126.  
  127. Sun Release 4.1      Last change: Release 1                     2
  128.  
  129.  
  130.  
  131.