home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d7xx / d747 / aush.lha / AUSH / ExtraCmds.lha / englishdocs / nl.doc < prev    next >
Text File  |  1992-09-04  |  3KB  |  94 lines
  1. NAME
  2.     nl - line numbering filter
  3.  
  4. SYNOPSIS
  5.     nl [ -htype ] [ -btype ] [ -ftype ] [ -vstart ] [ -iincr ]
  6.        [ -p ] [ -lnum ] [ -ssep ] [ -wwidth ] [ -nfmt ]
  7.        [ -dxx ] [ file... ]
  8.  
  9. DESCRIPTION
  10.     nl reads lines from the named files, or the standard input if no file
  11.     is named, and reproduces the lines on the standard output.  Lines are
  12.     numbered on the left in accordance with the command options in effect.
  13.     nl views the text it reads in terms of logical pages.  Line numbering
  14.     is reset at the start of each logical page.  A logical page consists
  15.     of a header, a body, and a footer section.  Empty sections are valid.
  16.     Different line numbering options are independently available for
  17.     header, body, and footer. The start of logical page sections are sig-
  18.     naled by input lines containing nothing but the following delimiter
  19.     character(s):
  20.  
  21.     Line contents:        start of:
  22.  
  23.     \:\:\:            header
  24.  
  25.     \:\:            body
  26.  
  27.     \:            footer
  28.  
  29.     Unless optioned otherwise, nl assumes the text being read is in a
  30.     single logical page body.  Command options may appear in any order.
  31.     If a file name is -, standard input will be used.
  32.     The options are:
  33.  
  34.     -btype    Specifies which logical page body lines are to be numbered.
  35.         Recognized types and their meaning are:
  36.  
  37.         a    number all lines
  38.         t    number lines with printable text only
  39.         n    no line numbering
  40.  
  41.         Default type for logical page body is t (text lines numbered).
  42.  
  43.     -htype    Same as -btype except for header.  Default type for logical
  44.         page header is n (no lines numbered).
  45.  
  46.     -ftype    Same as -btype except for footer. Default for logical page
  47.         footer is n (no lines numbered).
  48.  
  49.     -vstart start is the initial value used to number logical page lines.
  50.         Default is 1.
  51.  
  52.     -iincr    incr is the increment value used to number logical page lines.
  53.         Default is 1.
  54.  
  55.     -p    Do not restart numbering at logical page delimiters.
  56.  
  57.     -lnum    num is the number of blank lines to be considered as one.
  58.         For example, -l2 results in only the second adjacent blank
  59.         being numbered (if the appropriate -ha, -ba, and/or -fa
  60.         option is set).
  61.         Default is 1.
  62.  
  63.     -ssep    sep is the character(s) used in separating the line number
  64.         and the corresponding text line.  Default sep is a tab.
  65.  
  66.     -wwidth width is the number of characters to be used for the line
  67.         number.
  68.         Default number is 6.
  69.  
  70.     -nfmt    fmt is the line numbering format.
  71.         Recognized values are:    ln, left justified, leading zeroes
  72.         suppressed; rn, right justified, leading zeroes supressed;
  73.         rz, right justified, leading zeroes kept.
  74.         Default fmt is rn (right justified).
  75.  
  76.     -dxx    The delimiter characters specifying the start of a logical
  77.         page section may be changed from the default characters (\:)
  78.         to two user-specified characters.
  79.  
  80. RETURN CODES
  81.     0 if all went well
  82.     1 in case of bad argument (fatal)
  83.     2 if at least one file couldn't be opened (non fatal)
  84.  
  85. CHANGES FROM UNIX
  86.     Several files can be specified
  87.     Two characters must be specified for -d option
  88.     pexpr type for -h/-b/-f options is not supported
  89.  
  90. AUTHOR
  91.     Denis GOUNELLE
  92.     Last modified 04-Sep-92
  93.  
  94.