home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat4 / fspec.z / fspec
Encoding:
Text File  |  1998-10-20  |  3.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. FFFFSSSSPPPPEEEECCCC((((4444))))                                                              FFFFSSSSPPPPEEEECCCC((((4444))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      fspec - format specification in text files
  10.  
  11. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  12.      It is sometimes convenient to maintain text files on the UNIX system with
  13.      non-standard tabs, (i.e., tabs which are not set at every eighth column).
  14.      Such files must generally be converted to a standard format, frequently
  15.      by replacing all tabs with the appropriate number of spaces, before they
  16.      can be processed by UNIX system commands.  A format specification
  17.      occurring in the first line of a text file specifies how tabs are to be
  18.      expanded in the remainder of the file.
  19.  
  20.      A format specification consists of a sequence of parameters separated by
  21.      blanks and surrounded by the brackets <<<<:::: and ::::>>>>.  Each parameter consists
  22.      of a keyletter, possibly followed immediately by a value.  The following
  23.      parameters are recognized:
  24.  
  25.        tttt_t_a_b_s    The tttt parameter specifies the tab settings for the file.  The
  26.                 value of _t_a_b_s must be one of the following:
  27.  
  28.                   1. a list of column numbers separated by commas, indicating
  29.                      tabs set at the specified columns;
  30.  
  31.                   2. a ---- followed immediately by an integer _n, indicating tabs
  32.                      at intervals of _n columns;
  33.  
  34.                   3. a ---- followed by the name of a ``canned'' tab
  35.                      specification.
  36.  
  37.                 Standard tabs are specified by tttt----8888, or equivalently,
  38.                 tttt1111,,,,9999,,,,11117777,,,,22225555,,,,etc.  The canned tabs which are recognized are
  39.                 defined by the _t_a_b_s(1) command.
  40.  
  41.        ssss_s_i_z_e    The ssss parameter specifies a maximum line size.  The value of
  42.                 _s_i_z_e must be an integer.  Size checking is performed after
  43.                 tabs have been expanded, but before the margin is prepended.
  44.  
  45.        mmmm_m_a_r_g_i_n  The mmmm parameter specifies a number of spaces to be prepended
  46.                 to each line.  The value of _m_a_r_g_i_n must be an integer.
  47.  
  48.        dddd        The dddd parameter takes no value.  Its presence indicates that
  49.                 the line containing the format specification is to be deleted
  50.                 from the converted file.
  51.  
  52.        eeee        The eeee parameter takes no value.  Its presence indicates that
  53.                 the current format is to prevail only until another format
  54.                 specification is encountered in the file.
  55.  
  56.      Default values, which are assumed for parameters not supplied, are tttt----8888
  57.      and mmmm0000.  If the ssss parameter is not specified, no size checking is
  58.      performed.  If the first line of a file does not contain a format
  59.      specification, the above defaults are assumed for the entire file.  The
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. FFFFSSSSPPPPEEEECCCC((((4444))))                                                              FFFFSSSSPPPPEEEECCCC((((4444))))
  71.  
  72.  
  73.  
  74.      following is an example of a line containing a format specification:
  75.  
  76.            * <:t5,10,15 s72:> *
  77.  
  78.      If a format specification can be disguised as a comment, it is not
  79.      necessary to code the dddd parameter.
  80.  
  81. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  82.      ed(1), newform(1), tabs(1)
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  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.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.