home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / altsrcs / 3 / 3624 / archie.readme < prev    next >
Encoding:
Text File  |  1991-07-13  |  3.8 KB  |  103 lines
  1. # Copyright (C) Khun Yee Fung clipper@csd.uwo.ca
  2. # You can do anything to this program except selling it for profit or
  3. # pretending you wrote it.
  4.  
  5. This is a archie client written in Perl using the prospero protocol.
  6. It is standalone with no dependance on the prospero code in
  7. prospero.tar.Z on june.cs.washington.edu. I am not sure this program
  8. is useful as there is also a standalone archie program in that file
  9. archive, except that you have to compile the propero file system too.
  10. Anyhow.
  11.  
  12. To start things off, modify the file archie.depend. You should also
  13. move archie in the directory where you store you perl scripts. The
  14. library files should be in the perl library.
  15.  
  16. As I don't have a full document of the propero, some of the details in
  17. prospero might be misunderstood by me. I read the source code of the
  18. prospero file system to get information on the prospero protocol. I do
  19. have the file called protocol.txt from june.cs.washington.edu, but it
  20. is not complete. I would like to have a pointer to a fuller
  21. description, including the header information of the packets.
  22.  
  23. This program is in the alpha testing stage. I need people to test,
  24. improve, and suggest, to make it better. It is written on a Sun 3/50.
  25. It might not work on other machines. If you port it to another machine
  26. type, please send me the diffs, thanks.
  27.  
  28. As the documentation is not yet written, as it is still under revision,
  29. the following is a simple description of the program:
  30.  
  31. 1. The options are:
  32.     Search options
  33.     -case   Case sensitive search
  34.         -nocase Case insensitive search
  35.         -reg    Regular expression search
  36.     -exact  Exact match search
  37.  
  38.     Number of hits
  39.     -match #  # is the number of maximum hits, the default is 100.
  40.  
  41.     Archie Host
  42.     -host host  host is the archie host. Quiche.cs.mcgill.ca is
  43.                 the default server.
  44.  
  45.     Print option
  46.         -along      Do the print along the way when the query is being
  47.                     carried out. I don't know whether quiche outputs
  48.                     full entries in each packet, this option might not
  49.                     be useful later on.
  50.  
  51.     Format options
  52.        This program attempts to free the user from a fixed format. As
  53.        I expect this program to be piped to another program to sort
  54.        and/or analyse the results, the output format should be as
  55.        flexible as possible. Therefore I include a format string that
  56.        the user can specify to print the output in a particular way.
  57.  
  58.         -format string  The format string is given.
  59.         -ffile filename The file name containing the format string is given.
  60.  
  61.        Right now, the format string is very simple. The fields allowed are:
  62.  
  63.        $host   : the host name of an entry
  64.        $type   : whether the entry is about a directory or a file
  65.        $modes  : the protection mode of the file/directory
  66.        $size   : a 10 character-field for the size of the file/directory
  67.        $date   : the last modified date of the file
  68.        $name   : the name of the file/directory
  69.  
  70.       The default format string is:
  71.  
  72.       Host $host
  73.  
  74.           Location: $dir
  75.             $type $modes $size $date $name
  76.  
  77.      That is, an entry will look like this:
  78.  
  79.       Host rusmv1.rus.uni-stuttgart.de
  80.  
  81.           Location: /soft/tex/machines/atari/passautex
  82.                  File -rw-rw-r--     148864 1991 Feb 14 11:34 GMT TeXDraw-1,41-ST.lzh
  83.  
  84.  
  85. Things to be done:
  86.  
  87. 1, A default sorting option.
  88.  
  89. 2, Clean up the code.
  90.  
  91. 3, Get a full description of the protocol and archie entry-sending behaviour.
  92.  
  93. 4, Clean up the resolver code for the people without a resolver library.
  94.  
  95. 5, Comment the code as well as the prospero file system code.
  96.  
  97. 6, I am sure I can think of other things to improve.
  98.  
  99. Please send your comments, criticisms, diffs, etc. to me at
  100. clipper@csd.uwo.ca. Yes, you can even criticise my programming style.
  101.  
  102. Khun Yee
  103.