home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / AUDREY11.ZIP / AUDREY.DOC next >
Text File  |  1994-06-25  |  11KB  |  275 lines
  1.  
  2.  
  3.                   ┌┐
  4.                   ││
  5.                   ├┤
  6.                   ││
  7.                   ││ UDREY    ..    v1.1
  8.  
  9.  
  10.                   User/System "Infoform" Generator for WWIV 4.23/4.24
  11.  
  12.                   Copyright (c) 1994 Devin Carraway (AquaMaestro)
  13.  
  14.  
  15. ────────────────────────────────────────
  16. INTRODUCTION
  17. ────────────────────────────────────────
  18.  
  19. Audrey is a highly flexible "infoform" generator for WWIV systems.  In many
  20. places in WWIV, it would be nice to print out a bit of extra information -
  21. Audrey reads your input file, and generates a corresponding output file with
  22. the appropriate information filled in.  In WWIV versions 4.23 and above,
  23. there are several places where WWIV will, if it finds a filename, print
  24. out a file from the GFILES directory - CHAINS.MSG, for example, when a user
  25. enters the chain menu.  Audrey is written to take advantage of these
  26. opportunities.
  27.  
  28.  
  29. ────────────────────────────────────────
  30. A BRIEF EXAMPLE
  31. ────────────────────────────────────────
  32.  
  33. Let's say you have a file, AUDREY.INP, containing the following:
  34.  
  35. 2Greetings, 1%PNAME%2, and welcome to 1%SYSTEMNAME%2!
  36.  
  37. 3Your information for today, 1%DATE%3, at 1%TIME%3 is as follows:
  38.  
  39.                  Name (Handle)  : %NAME#%
  40.                  Real Name      : %REALNAME%
  41.                  Last On        : %LASTON%
  42.                  First On       : %FIRSTON%
  43.                  Illegal Logons : %ILLEGAL%
  44.  
  45.                  SL: %SL%   DSL: %DSL%
  46.  
  47.                  Uploads  : %ULK%k in %UL% files
  48.                  Downloads: %DLK%k in %DL% files
  49.                  Ratio    : %RATIO%
  50.  
  51.  
  52. Now, suppose you run Audrey on this file.  On my system, using my account,
  53. the following output is produced:
  54.  
  55.  
  56. 2Greetings, 1Aquamaestro2, and welcome to 1Atlantica2!
  57.  
  58. 3Your information for today, 106/25/943, at 103:44:123 is as follows:
  59.  
  60.                  Name (Handle)  : AQUAMAESTRO #1
  61.                  Real Name      : Devin Carraway
  62.                  Last On        : 06/25/94
  63.                  First On       : 07/14/90
  64.                  Illegal Logons : 0
  65.  
  66.                  SL: 255   DSL: 255
  67.  
  68.                  Uploads  : 875142147k in 8745 files
  69.                  Downloads: 1152%k in 12 files
  70.                  Ratio    : 99.998
  71.  
  72. Neat, huh?
  73.  
  74. ────────────────────────────────────────
  75. ORIGIN OF THE PROGRAM
  76. ────────────────────────────────────────
  77.  
  78. Recently, I happened upon a copy of "Up and Down" v1.02, written by The
  79. Wandering Witness, a Sysop in my area.  It was a simple program in BASIC that
  80. read CHAIN.TXT to produce UPLOAD.MSG and DOWNLOAD.MSG within the GFILES
  81. directory.  When a user uploaded or downloaded from within the BBS, the file
  82. would display.  UP&DOWN produced nice output, a useful disclaimer appropriate
  83. to the action (uploading or downloading).
  84.  
  85. My main complaints with UP&DOWN were that it was inadequately configurable,
  86. the thing was going to look pretty much how it was hardcoded to look, though
  87. the colors could be changed (apologies for that error, TWW).  Also, it seemed
  88. that it was spending too much formatting effort, when the whole thing could be
  89. made configurable quite easily.  Audrey evolved from this general notion.
  90.  
  91.  
  92. ────────────────────────────────────────
  93. INSTALLATION AND USE
  94. ────────────────────────────────────────
  95.  
  96. Audrey should be run from your main WWIV directory.  It will try to open
  97. CHAIN.TXT, or CHAIN.xxx if the WWIV_INSTANCE environmental variable is > 1.
  98. Audrey also will use CONFIG.DAT and USER.LST.  If Audrey fails to find any
  99. of these files, it exits.
  100.  
  101. Commandline format is as follows:
  102.  
  103.         AUDREY [/I:<InputFN>] [/O:<OutputFN>] [/D]
  104.  
  105.                 /I:xxx - 'xxx' is the filename and (if needed) path to the
  106.                          .INP-format file (described later on).
  107.  
  108.                 /O:xxx - 'xxx' is the filename and (if needed) path under
  109.                          which Audrey will generate the output file.
  110.  
  111.                 /D     - This tells Audrey to read UPLOAD.INP and DOWNLOAD.INP,
  112.                          and generate UPLOAD.MSG and DOWNLOAD.MSG within your
  113.                          GFILES directory.  This saves running Audrey twice.
  114.  
  115.         Audrey will, by default, look for AUDREY.INP, and output to AUDREY.OUT.
  116.  
  117.  
  118. ────────────────────────────────────────
  119. .INP-FORMAT FILES
  120. ────────────────────────────────────────
  121.  
  122. Audrey's input files can have any DOS-legal filename - I will use .INP here.
  123.  
  124. Within the .INP files, absolutely anything is legal.  If Audrey finds any of
  125. the variable strings within the file, it will replace it in the output file
  126. with the variable's value.  Lines longer than 160 lines are truncated at the
  127. 160th character.  No other changes are made.
  128.  
  129. The following variables can be used within the input files.  Remember that
  130. none of these produce unit indicators (if applicable), punctuation, etc.
  131.  
  132. %NAME%        <---    Handle, in caps (ie 'AQUAMAESTRO')
  133. %NAME#%       <---    Handle and usernumber (ie 'AQUAMAESTRO #1')
  134. %PNAME%       <---    Handle, properized (ie 'Aquamaestro')
  135. %PNAME#%      <---    Handle, properized with usernumber (ie 'Aquamaestro #1')
  136. %REALNAME%    <---    Real name
  137. %USERNUM%     <---    User number
  138. %LASTON%      <---    Date last on (ie '06/25/94')
  139. %FIRSTON%     <---    Date first on
  140. %CALLSIGN%    <---    HAM callsign
  141. %VOICEPHONE%  <---    Voice phone number
  142. %DATAPHONE%   <---    Data phone number
  143. %STREET%      <---    Street Address
  144. %CITY%        <---    City
  145. %STATE%       <---    2-character state abbreviation
  146. %COUNTRY%     <---    Country
  147. %ZIP%         <---    ZIP code
  148. %NOTE%        <---    Sysop note
  149. %SL%          <---    SL (Security Level)
  150. %DSL%         <---    DSL (Transfer Security Level)
  151. %UL%          <---    Files uploaded
  152. %DL%          <---    Files downloaded
  153. %ULK%         <---    K uploaded
  154. %DLK%         <---    K downloaded
  155. %FP%          <---    Filepoints
  156. %GOLD%        <---    Gold
  157. %RATIO%       <---    Transfer ratio (UploadK/DownloadK)
  158. %REQ_RATIO%   <---    System's required transfer ratio
  159. %PC_RATIO%    <---    System's required post/call ratio
  160. %CURSPEED%    <---    Current modem speed string (ie '14400/v.32bis')
  161. %SYSTEMNAME%  <---    BBS name
  162. %SYSOPNAME%   <---    Sysop name (handle)
  163. %SYSTEMPHONE% <---    System phone number
  164. %SYSTEMWWIV#% <---    System's WWIV reg#
  165. %MSGSDIR%     <---    MSGS directory path
  166. %GFILESDIR%   <---    GFILES directory path
  167. %DATADIR%     <---    DATA directory path
  168. %DLOADSDIR%   <---    DLOADS (main) directory path
  169. %TEMPDIR%     <---    Main TEMP directory path
  170. %NUP%         <---    Newuser password
  171. %AGE%         <---    Age, in years
  172. %DEFPROT%     <---    User's default transfer protocol number
  173. %SCREENCHARS% <---    Screen width (ie 80)
  174. %SCREENLINES% <---    Screen height (ie 25)
  175. %NUM_EXTENDED%<---    Lines to print in extended transfer descriptions
  176. %EXEMPT%      <---    Numeric exemption
  177. %ILLEGAL%     <---    Illegal logons (only meaningful at logon)
  178. %WAITING%     <---    Mail waiting
  179. %ONTODAY%     <---    Times on today
  180. %B_MON%       <---    Birth month
  181. %B_DAY%       <---    Birth date
  182. %B_YR%        <---    Birth year
  183. %LANG%        <---    Language number
  184. %MSGPOST%     <---    Messages posted
  185. %EMAILSENT%   <---    E-Mail sent
  186. %ETODAY%      <---    E-Mail sent today
  187. %FBSENT%      <---    Feedback sent
  188. %FBTODAY%     <---    Feedback sent today
  189. %POSTTODAY%   <---    Posts today
  190. %LOGONS%      <---    Times logged on
  191. %CHAINSRUN%   <---    Chains (games) run
  192. %BANKTIME%    <---    Time in timebank
  193. %WWIVREG#%    <---    WWIV registration number
  194. %C_FREE_B%    <---    Free space on C: (bytes)
  195. %C_FREE_K%    <---    Free space on C: (K)
  196. %C_FREE_MBD%  <---    Free space on C: (MB to 2 decimal places)
  197. %C_FREE_MB%   <---    Free space on C: (MB, rounded to nearest integer)
  198. %D_FREE_B%    <---    Free space on D: (bytes)
  199. %D_FREE_K%    <---    Free space on D: (K)
  200. %D_FREE_MBD%  <---    Free space on D: (MB to 2 decimal places)
  201. %D_FREE_MB%   <---    Free space on D: (MB, rounded to nearest integer)
  202. %E_FREE_B%    <---    Free space on E: (bytes)
  203. %E_FREE_K%    <---    Free space on E: (K)
  204. %E_FREE_MBD%  <---    Free space on E: (MB to 2 decimal places)
  205. %E_FREE_MB%   <---    Free space on E: (MB, rounded to nearest integer)
  206. %F_FREE_B%    <---    Free space on F: (bytes)
  207. %F_FREE_K%    <---    Free space on F: (K)
  208. %F_FREE_MBD%  <---    Free space on F: (MB to 2 decimal places)
  209. %F_FREE_MB%   <---    Free space on F: (MB, rounded to nearest integer)
  210.  
  211. ────────────────────────────────────────
  212. SUGGESTIONS
  213. ────────────────────────────────────────
  214.  
  215. Some suggestions on useful places to use Audrey can be found in SAMPLES.DOC,
  216. included in the Audrey ZIP (ARJ/LZH, whatever).
  217.  
  218.  
  219. ────────────────────────────────────────
  220. ABOUT THE PROGRAM
  221. ────────────────────────────────────────
  222.  
  223. Audrey is written in C, compiled using Borland C++ v4.0.  The source code is
  224. approximately 700 lines long.  Audrey requires about 58k free memory to run.
  225.  
  226. Audrey's execution time to process this documentation file was 2.59 seconds,
  227. according to a UNIX-style ptime process timer.
  228.  
  229.  
  230. ────────────────────────────────────────
  231. WHO IS 'AUDREY,' ANYWAY?
  232. ────────────────────────────────────────
  233.  
  234. Audrey was the name of a woman in a story I once read, in her thirties, with
  235. a good marriage and a child.  She was anorgasmic, which means that she has
  236. never had an orgasm (ever).  The story was quite touching, actually.
  237.  
  238.  
  239. ────────────────────────────────────────
  240. LEGAL MATTERS
  241. ────────────────────────────────────────
  242.  
  243. Whatever this program does, good or bad, may indeed BE my fault.  But you can't
  244. do anything about it.
  245.  
  246. This program is freeware.  It may be freely distributed by electronic means so
  247. long as no money is charged for the exchange.
  248.  
  249. CDROM vendors are free to include this file in their publishings so long as its
  250. original contents (see README.TXT) are preserved intact and no files are added
  251. to the archive.
  252.  
  253. Shareware floppy vendors are forbidden to distribute this program and may not
  254. use it for any purpose.  You are parasites feeding off the work of good
  255. programmers and should all be shot.
  256.  
  257.  
  258. ────────────────────────────────────────
  259. CONTACTING THE AUTHOR
  260. ────────────────────────────────────────
  261.  
  262. If for some reason you feel the urge to contact me, or care to drop me a note
  263. to let me know you gave the program a try, my mail addresses are as follows:
  264.  
  265. I really appreciate getting mail from people who have used my programs.  If
  266. you find Audrey interesting or useful, please drop me a note.
  267.  
  268. MicroNet: 1@1
  269. IceNET  : 1@7704
  270. WWIVnet : 1@7724 (before switchover)
  271. WWIVnet : 1@11724 (after switchover)
  272. Internet: dcarrawa@nermal.santarosa.edu
  273. BBS/Fax : 707/539-8361
  274.  
  275.