home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / gcc263-utildoc.lha / gnu / man / man1 / fmt.1 < prev    next >
Encoding:
Text File  |  1994-12-19  |  4.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. FMT(1L)                                                   FMT(1L)
  5.  
  6.  
  7. NNAAMMEE
  8.        fmt - simple optimal text formatter
  9.  
  10. SSYYNNOOPPSSIISS
  11.        ffmmtt  [-cstu]  [-width]  [-w  width]  [-p prefix] [--crown-
  12.        margin]  [--split-only]  [--tagged-paragraph]  [--uniform-
  13.        spacing]    [--width=width]   [--prefix=prefix]   [--help]
  14.        [--version] [file ...]
  15.  
  16. DDEESSCCRRIIPPTTIIOONN
  17.        This manual page documents the GNU version of ffmmtt.  ffmmtt is
  18.        a simple text formatter that fills and joins lines to pro-
  19.        duce output lines of (up to) the specified _w_i_d_t_h  (default
  20.        75).  However ffmmtt uses a bbeesstt--ffiitt line breaking algorithm,
  21.        by a simple version of "Breaking Paragraphs  into  Lines",
  22.        Donald  E.  Knuth and Michael F. Plass, _S_o_f_t_w_a_r_e_-_-_P_r_a_c_t_i_c_e
  23.        _a_n_d _E_x_p_e_r_i_e_n_c_e 1111 (1981) 1119-1184.
  24.  
  25.        ffmmtt concatenates the _f_i_l_es listed as arguments.   If  none
  26.        are given, ffmmtt formats text from the standard input.
  27.  
  28.        Blank lines are preserved in the output, as is the spacing
  29.        between words (unless _-_u is used).   In  contrast  to  BSD
  30.        ffmmtt,  tabs are expanded on input and re-introduced on out-
  31.        put.
  32.  
  33.        Indentation is preserved in the output,  and  input  lines
  34.        with differing indentation are not joined (unless _-_c or _-_t
  35.        is used).  Note that although  the  BSD  ffmmtt  manual  also
  36.        states  this,  the BSD version does in fact join following
  37.        lines with less indentation.
  38.  
  39.        ffmmtt prefers breaking lines at the end of a  sentence,  and
  40.        tries  to avoid line breaks after the first word of a sen-
  41.        tence or before the last word of a sentence.   A  sentence
  42.        break  is  defined  as  either the end of a paragraph or a
  43.        word ending in [.?!], followed by two  spaces  or  end  of
  44.        line, ignoring any intervening parentheses or quotes.
  45.  
  46.    OOPPTTIIOONNSS
  47.        _-_c_, _-_-_c_r_o_w_n_-_m_a_r_g_i_n
  48.               Crown margin mode.  Preserve the indentation of the
  49.               first two lines within a paragraph, and  align  the
  50.               left  margin  of  each subsequent line with that of
  51.               the second line.
  52.  
  53.        _-_t_, _-_-_t_a_g_g_e_d_-_p_a_r_a_g_r_a_p_h
  54.               Tagged paragraph mode: just like crown mode, except
  55.               that  the  indentation of the first line of a para-
  56.               graph must be different from the indentation of the
  57.               second.   Otherwise  the first line is treated as a
  58.               one-line paragraph.
  59.  
  60.  
  61.  
  62.  
  63.  
  64. FSF                     GNU Text Utilities                      1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. FMT(1L)                                                   FMT(1L)
  71.  
  72.  
  73.        _-_s_, _-_-_s_p_l_i_t_-_o_n_l_y
  74.               Split lines only.  Do not join short lines to  form
  75.               longer  ones.   This prevents sample lines of code,
  76.               and other such "formatted" text, from being  unduly
  77.               combined.
  78.  
  79.        _-_u_, _-_-_u_n_i_f_o_r_m_-_s_p_a_c_i_n_g
  80.               Uniform  spacing.   Reduce spacing between words to
  81.               one space, except at the end  of  a  sentence  (two
  82.               spaces).
  83.  
  84.        _-_w_i_d_t_h_, _-_w _w_i_d_t_h_, _-_-_w_i_d_t_h_=_w_i_d_t_h
  85.               Fill  output  lines to up to _w_i_d_t_h columns (default
  86.               75).  ffmmtt prefers to make lines about  7%  shorter,
  87.               to give it room to balance line lengths.
  88.  
  89.        _-_p_, _-_-_p_r_e_f_i_x_=_p_r_e_f_i_x
  90.               Only lines beginning with the prefix (possibly pre-
  91.               ceded by white space) are re-arranged;  the  prefix
  92.               (with  any  preceding  white space) is stripped for
  93.               the formatting and re-attached  to  each  formatted
  94.               output line.  One use is to format certain kinds of
  95.               program comments, while leaving the code unchanged.
  96.  
  97.        _-_-_h_e_l_p Print a usage message and exit with a non-zero sta-
  98.               tus.
  99.  
  100.        _-_-_v_e_r_s_i_o_n
  101.               Print version information on standard  output  then
  102.               exit.
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. FSF                     GNU Text Utilities                      2
  131.  
  132.  
  133.