home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / sysutl / sh1_111.arc / XTR.DOC < prev    next >
Text File  |  1987-03-01  |  5KB  |  118 lines
  1. xtr - Extraction utility   Ver 1.00        (C) 1987 Noam Naaman
  2.  
  3. 0. Disclaimer, Trademarks, my name and address etc.
  4.  
  5.   I make no representation or warranties with respect to the
  6.   contents hereof and specifically disclaim any implied warranties
  7.   to the suitability of this program for any particular purpose.
  8.   You must determine that yourself.  In addition, you should
  9.   understand that using a program of this type on an IBM PC or
  10.   compatible has inherent risks and that you may inadvertently
  11.   damage or destroy valuable programs or data.  I expressly
  12.   decline to assume liability for any use of this program by you,
  13.   and your use of this program constitutes your agreement to hold
  14.   me blameless.
  15.  
  16.   BUT if someone finds a bug and goes to the trouble of telling me,
  17.   I would be more than happy to fix it and upload an update.
  18.   I also welcome any other comments and suggestions.
  19.  
  20.   Noam Naaman
  21.   406 Prospect Ave #4K
  22.   Hackensack, NJ 07601
  23.  
  24.   CompuServe 72447,420
  25.  
  26.   (201) 343-7242
  27.  
  28.  
  29. 1. Description
  30.  
  31.   xtr is a text line extraction program which can selectively let
  32.   lines pass through to standard output.
  33.   xtr may receive its input from a file or from standard input
  34.   making it a "filter" in Unix terminology.
  35.   Why xtr? There are many reasons but I'll give a few examples:
  36.  
  37.     1.1 After a session with a BBS with capture on, you have a file
  38.         cluttered with lines like:
  39.           L(ist) (-) M(ore) R(eply) H(elp) Q(uit) >
  40.           < More - C(ontinuous) Y/N >
  41.         To get rid of these lines before printing the capture file,
  42.         run xtr on this file and delete all lines equal to the two
  43.         above.
  44.  
  45.     1.2 In the same file mentioned above, there is a list of ARC 
  46.         files which can be downloaded from that BBS. You would like
  47.         to print only lines which contain an ARC file description
  48.         and then sort the file names.
  49.         All you have to do is xtr the file with the appropriate key
  50.         and pipe it to sort.exe.
  51.  
  52. 2. What is a key?
  53.  
  54.   A key is a string of characters which is used by xtr to determine
  55.   the status of each incoming text line. Up to 200 keys may be
  56.   defined. Each input line will be tested with all keys until there
  57.   are no more keys or a positive comparison is encountred.
  58.   There are two ways to define keys:
  59.  
  60.     2.1 Single key definition on command line. A key may be specified
  61.         on the command line by preceding it with -s (e.g. -sKEYSTRING).
  62.         If you need only one or two keys, this is the preferred
  63.         method.
  64.  
  65.     2.2 Key file definition. You may create a text file which will
  66.         be read by xtr prior to processing incoming text. Each line
  67.         in the key file should contain a single string starting in
  68.         column 1.
  69.  
  70. 3. Command line options
  71.  
  72.   Command line options define the way in which xtr will process
  73.   its input. Options should have at least one space between each
  74.   other.
  75.  
  76.      -k<file>           Specify file name containing keys.
  77.      -i<file>           Specify input file. default is standard input.
  78.      -c<number>         Specify field's 1st column. default is column 1.
  79.      -w<number>         Specify field width. default is 1.
  80.      -s<string>         Specify single key. Can be repeated.
  81.      -x<file>           Specify extract file. Write to this file all
  82.                         line which are not being output to standard output.
  83.      -v                 Reverse selection. Output lines which do not
  84.                         equal to any key.
  85.      -f                 Floating. Lines will be scanned for occurance of key
  86.                         as opposed to a comparison starting at a fixed column.
  87.  
  88. 4. Examples
  89.  
  90.   Extract all lines of a DIR listing having .ARC as suffix and then sort
  91.   them.
  92.  
  93.     dir | xtr -s.ARC -f | sort
  94.  
  95.   Extract all lines of a DIR listing having .ARC as suffix and then sort
  96.   them. All other lines are to be saved in a file called "others".
  97.  
  98.     dir | xtr -s.ARC -f -xothers | sort
  99.  
  100.   Extract all lines of a DIR listing having a file name which starts with
  101.   ABC and sort them. 
  102.   All other lines are to be saved in a file called "others".
  103.  
  104.     dir | xtr -sABC -c1 -w3 | sort
  105.  
  106.   Extract all lines of a DIR listing having a file name which starts with
  107.   ABC, XXX, ZZZ or QWE. Use a key file. Take input from a file called tmp.
  108.   First create a key file (call it key1) which will have 4 line:
  109.   ABC
  110.   XXX
  111.   ZZZ
  112.   QWE
  113.   (eof)
  114.  
  115.     dir > tmp
  116.     xtr -kkey1 -c1 -w3 -itmp
  117.  
  118.