home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / altsrcs / 2 / 2621 / README < prev   
Encoding:
Text File  |  1991-01-29  |  1.7 KB  |  62 lines
  1.  
  2.     @(#) README    1.1 91/01/27 
  3.  
  4.     Written 1991 by Christian Schlichtherle
  5.             (chris@attron.ruhr.sub.org)
  6.     No copyright unless you remove this header. The author
  7.     disclaims any warranty.
  8.  
  9.     README - Documentation file for list(C).
  10.  
  11. NAME
  12.  
  13.     list - Prints documented listings.
  14.  
  15. SYNTAX
  16.  
  17.     list [-A] [<pathname> ...]
  18.     list -u [<directory> ...]
  19.  
  20. DESCRIPTION
  21.  
  22.     list(C) prints a documented listing on standard output. The
  23.     output is formated. The first field contains the filename,
  24.     the second field the size of the file in bytes. The rest of
  25.     the line contains the description for the file. The lines
  26.     are sorted in increasing ASCII collating sequence (like
  27.     ls(C)). The "-A" option indicates that files beginning with
  28.     a period are listed for non-super users too (like ls(C)).
  29.  
  30.     The description for the files is held in the file ".list"
  31.     in the directory where the file reside. This file is
  32.     formatted as follows: The first field contains the filename
  33.     and the rest of the line contains the description for the
  34.     file. The lines are sorted in increasing ASCII collating
  35.     sequence.
  36.  
  37.     The second form of the command 'list -u [<directory> ...]'
  38.     updates the ".list" file. The lines are sorted, descriptions
  39.     for nonexistent files are thrown away and the output is
  40.     formatted.
  41.  
  42. FILES
  43.     
  44.     .list        Description file for listing
  45.  
  46. SEE ALSO
  47.  
  48.     ls(C), sort(C), join(C), awk(C)
  49.  
  50. NOTES
  51.  
  52.     Whitespace in the description field of the ".list" file is
  53.     replaced by a single space character.
  54.  
  55.     Filenames must not contain escape sequences for printf().
  56.  
  57.     If your awk bails out you will have to substitute the line
  58.     "print substr($0, i + 2);" with "print substr($0, i + 2,
  59.     255);" or "print substr($0, i + 2, length($1) - i - 1);". I
  60.     used this because it shows better performance (need not
  61.     process length($1)).
  62.