home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / USEREP16.ZIP / USEREP.DOC < prev    next >
Text File  |  1992-05-03  |  4KB  |  88 lines
  1. USEREP - PCBoard 14.x User File Report Generator, Version 1.6
  2.  
  3. Copyright (C) 1988 - 1992, S. David Klein
  4.  
  5. Permission is hereby granted to reproduce and disseminate USEREP.BAS and
  6. USEREP.EXE, so long as no alterations are made and no remuneration is
  7. received in exchange.
  8.  
  9. This program generates a report showing user name, last date on, expiration
  10. date, security level, times on, last message read in the main message base, #
  11. uploads, # downloads, and ratio of downloads to uploads.  The output report
  12. file can be in three formats:  normal, for viewing or printing; comma-
  13. delimited, for import into a database program; or comma-delimited quoted
  14. strings, the standard mail-merge format.
  15.  
  16. The users file is opened shared read-only, and as a result USEREP will run in a
  17. network environment with PCBoard nodes up and running.  USEREP shells out to
  18. SORTF [(c) by Vernon D.  Buerg, used with permission] to provide sorting of
  19. the report by any of the seven items listed.  SORTF.COM need only be in the
  20. path; it is not necessary that it be in the default directory.  Sorting is
  21. provided only for the normal report file; for the import format files, sorting
  22. is skipped since it is assumed another program will be used to examine the
  23. information in these files.
  24.  
  25. USEREP will look in the default directory for a file called USEREP.CFG.  This
  26. file should consist of at least 3 lines.  The first line should contain the
  27. full name, with path, of your USERS file.  The second line should contain the
  28. full name, with path, of the report file to be generated.  The third line
  29. should contain a code letter indicating the output file format desired.  The
  30. code letters are:
  31.  
  32.                 (N) Normal output file
  33.                 (C) Comma-delimited file
  34.                 (M) Mail-merge file
  35.  
  36. See the sample config file, USEREP.CFG, for an example of how to set up the
  37. file.
  38.  
  39. If either of the import format files is selected (C,M), USEREP will generate
  40. the output report immediately after examining the users file.  For the normal
  41. format report, once the program has examined the USERS file, it will ask on
  42. which item(s), if any, to key the sort of the report file.  The key numbers
  43. are:
  44.  
  45.                 (1) Last Date On
  46.                 (2) Expiration Date
  47.                 (3) Security Level
  48.                 (4) # Times On
  49.                 (5) Last Msg. Read
  50.                 (6) # Uploads
  51.                 (7) # Downloads
  52.                 (8) Ratio of DL/UL
  53.  
  54. If a key of (N) is given, no sort will be performed.  If you desire to run
  55. USEREP in unattended mode (e.g., from an event batch file), you can place the
  56. primary and secondary sort keys, and sort order, on the command line and USEREP
  57. will use those in place of your keyboard input.  For example, the command line:
  58.  
  59.                 USEREP 8 1 D
  60.  
  61. will generate, without keyboard input, a report file sorted first by ratio and
  62. second by last date on, in descending order.  If you do not desire a secondary
  63. key, use the letter N as the second key on the command line (e.g., USEREP 8 N
  64. A).  If you do not desire any sort at all, use the letter N as the first sort
  65. key on the command line (e.g., USEREP N).  Except in this latter case, for
  66. unattended operation both keys and the sort order must be on the command line
  67. or USEREP will ask for keyboard input.
  68.  
  69. The program is written and compiled with MicroSoft QuickBasic 4.5.
  70.  
  71. The author makes no warranties, either express or implied, with regard to this
  72. program and hereby disclaims any and all implied warranties of merchantability
  73. and fitness for a particular purpose.  In no event will the author be liable
  74. for incidental or consequential damages, including, but not limited to,
  75. destruction of data or damage to your equipment.
  76.  
  77. Your comments on USEREP are welcome.  The author may be contacted on his
  78. PCBoard system:
  79.  
  80. Software Society South, North Brunswick, NJ - (908) 846-9664
  81.  
  82. The system supports 1200/2400/9600/19200 connects with a USR HST Dual Standard
  83. modem.
  84.  
  85. This program archive contains the files USEREP.BAS, USEREP.CFG,
  86. USEREP.DOC, and USEREP.EXE.
  87.  
  88.