home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / c / curmudge.zip / CURMUDGE.DOC < prev    next >
Text File  |  1993-03-06  |  7KB  |  167 lines
  1. Curmudgeon -- by JSR.
  2.  
  3. Cur∙mud∙geon\, kêr-''mêj-ên n. [origin unknown]
  4.   1. archaic: a crusty, ill-tempered, churlish old man
  5.   2. modern: anyone who hates hypocrisy and pretense and has the termerity
  6.      to say so; anyone with the habit of pointing out unpleasant facts
  7.      in an engaging and humorous manner
  8.  
  9.  
  10. Curmudge is a simple program to display quotations/authors on the screen.
  11. I personally have it called from my autoexec.bat file so that it displays
  12. a different random quotation each time I turn my computer on.
  13.  
  14.  
  15. Command line syntax:
  16.  
  17.   CURMUDGE [/Ppathname] [/R] [/S###] [/A] [/D] [/N] [/? | /H]\
  18.  
  19.      /Ppathname      set Path to CURMUDGE.IDX and CURMUDGE.DAT
  20.      /R              display a Random quote
  21.      /S###           display a Specific quote (### = quote number)
  22.      /A              display All quotes
  23.      /D              display Definition of a Curmudgeon
  24.      /N              create New data files
  25.      /H or /?        display this Help screen
  26.  
  27.  
  28. As you have probably discovered, running Curmudge without any command line
  29. parameters simply displays a help screen like the one shown above.  In order
  30. to get Curmudge to display a quotation you must pass it one or more
  31. command line parameters.  Note that command line parameters may be in
  32. upper or lower case.
  33.  
  34.  
  35. Explaination of the command line parameters.
  36.  
  37.    /Ppathname ... used to set the path to the CURMUDGE.IDX and CURMUDGE.DAT
  38.                   data files.  If no path is given or is incorrect,
  39.                   Curmudge will also look in the current directory and the
  40.                   directory that the program CURMUDGE.EXE is in (used if
  41.                   CURMUDGE is in the DOS search path).
  42.  
  43.                   i.e.
  44.                   C:>CURMUDGE /Pc:\useless\utils\
  45.  
  46.                   or wherever you decide to store your data files.
  47.  
  48.                   I suggest storing your data files in the same directory
  49.                   that you have CURMUDGE.EXE at, then you won't have any
  50.                   need to use the /P option at all.
  51.  
  52.  
  53.    /R             Display a random quotation. Curmudge will select at
  54.                   random one of the quotations stored in its data file
  55.                   and display it.
  56.  
  57.                   i.e.
  58.                   C:>CURMUDGE /R
  59.  
  60.  
  61.    /S###          Display a specific quote number.  This is essentially
  62.                   the same as the /R parameter except it will display a
  63.                   specific quotation.  The quotations are numbered from 0
  64.                   so the first quote is number 0 and the second quote is
  65.                   number 1, etc.  If you have 10 quotations in your data
  66.                   file, the last one is number 9, not number 10.  If you
  67.                   pass an invalid number, curmudge will give an error
  68.                   message and abort.  The only invalid number that is
  69.                   allowed is -1.  -1 causes Curmudge to select a random
  70.                   quotation.  This is the same as using /R.
  71.  
  72.                   i.e.
  73.                   C:>CURMUDGE /S23
  74.  
  75.  
  76.    /A             Displays all the quotations in the data files, pausing
  77.                   every fourth one.  This gives you a way to read all the
  78.                   quotations.  You can press Escape if you do not wish to
  79.                   read through all of the quotes, as there 200+ quotes
  80.                   supplied with the program, it takes a while to scroll
  81.                   through them all four at a time.
  82.  
  83.                   i.e.
  84.                   C:>CURMUDGE /A
  85.  
  86.  
  87.    /D             Display the definition of a curmudgeon (as seen at the
  88.                   top of this file.)
  89.  
  90.                   i.e.
  91.                   C:>CURMUDGE /D
  92.  
  93.  
  94.    /N             Create new CURMUDGE.DAT and CURMUDGE.IDX files from
  95.                   CURMUDGE.IN.  To use this parameter, CURMUDGE.IN must
  96.                   be in the current directory.  If CURMUDGE.DAT and/or
  97.                   CURMUDGE.IDX are also in the current directory, you will
  98.                   have an option of overwritting them or aborting the
  99.                   operation.  CURMUDGE.IN must be formatted in the following
  100.                   manner.  Notice that the /P parameter is not used in
  101.                   this context.
  102.  
  103.                   `
  104.                   This is my quotation.
  105.                   ~By me
  106.                   `
  107.                   This is my next quotation.
  108.                   ~Someone else
  109.  
  110.                   etc.
  111.  
  112.                   The grieve character (`) also called backwards apostrophy
  113.                   says that the quotation starts on the next line, anything
  114.                   else on the same line as the grieve character will be
  115.                   ignored.  The quotation may span several lines if
  116.                   necessary.  The tilde character (~) marks the line that
  117.                   the author is stored on.  Note that the grieve and the
  118.                   tilde characters must both be the first character on
  119.                   the line.  You may edit the file CURMUDGE.IN with any
  120.                   standard ascii text editor to add new quotations or to
  121.                   remove any quotations that you find offensive.  Nothing
  122.                   is sacred in the quotations supplied with this program.
  123.                   After you have edited the CURMUDGE.IN file, simply run
  124.                   Curmudge with the /N parameter.
  125.  
  126.                   !!NOTICE!!
  127.                   The ONLY file you may safely edit is CURMUDGE.IN.
  128.                   While CURMUDGE.DAT may look like a simple text file,
  129.                   it is not, it also contains some embedded control
  130.                   characters which you cannot enter with a standard text
  131.                   editor, and the Curmudge program uses CURMUDGE.IDX
  132.                   to allow high-speed access to CURMUDGE.DAT, so editing
  133.                   the CURMUDGE.DAT file would invalidate the indexes in
  134.                   CURMUDGE.IDX.
  135.  
  136.  
  137.    /H or /?       I won't bother explaining these here.
  138.  
  139.  
  140.  
  141. Examples of command lines.
  142.  
  143. C:>CURMUDGE /D /R
  144.    Displays the definition of a curmudgeon followed by a random quotation.
  145.  
  146. C:>CURMUDGE /Pc:\curmdir /S0
  147.    Displays the first quotation from the CURMUDGE.DAT and CURMUDGE.IDX files
  148.    located in the directory c:\curmdir
  149.  
  150. C:>CURMUDGE /N /A
  151.    Creates new data files from CURMUDGE.IN then displays all of the
  152.    quotations four at a time.
  153.  
  154. C:>CURMUDGE /R /R
  155.    Displays two random quotations.
  156.  
  157.  
  158. You can mix and match parameters to your liking.  If the program doesn't
  159. understand something you send it, it will either ignore it or abort so
  160. you can't hurt anything.
  161.  
  162.  
  163.  
  164. I hereby dedicate this program to the public domain.  If you have any
  165. questions or comments, I may be contacted as JON RUSSELL on the
  166. DreamWeaver BBS   817-668-1375
  167.