home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / bbs / auu100.zip / auu.doc < prev    next >
Text File  |  1993-07-24  |  10KB  |  361 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.          █████╗  ██╗   ██╗ ██╗   ██╗
  8.         ██╔══██╗ ██║   ██║ ██║   ██║
  9.         ███████║ ██║   ██║ ██║   ██║
  10.         ██╔══██║ ██║   ██║ ██║   ██║
  11.         ██║  ██║ ╚██████╔╝ ╚██████╔╝
  12.         ╚═╝  ╚═╝  ╚═════╝   ╚═════╝
  13.  
  14.  
  15.         AUU
  16.  
  17.         Auto User Upgrader
  18.  
  19.  
  20.  
  21.         A user security maintenance robot
  22.  
  23.         for RemoteAccess 2.xx
  24.  
  25.  
  26.  
  27.         Written by Hamish N. Moffatt,
  28.  
  29.         Titanic Software
  30.  
  31.         3:635/552@fidonet
  32.  
  33.  
  34.  
  35.         Documentation
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.         AUU 1.00 for RemoteAccess 2.00                          Page 1
  63.  
  64.  
  65.         Introduction
  66.         ============================================================
  67.  
  68.         AUU, which stands for "Auto User Upgrader", is a maintenance
  69.         robot program for the RemoteAccess BBS program, version 2.00
  70.         or compatible.  AUU was designed to be  a replacement for Bo
  71.         Bendtsen's RAQUSER program, which doesn't seem to be updated
  72.         for RemoteAccess 2.xx.
  73.  
  74.         AUU can welcome new users to your BBS  and upgrade your best
  75.         users  to  higher  security  levels.  AUU  is  also  totally
  76.         configurable, allowing you to set up your security system as
  77.         you want it. AUU is still easy to configure, however.
  78.  
  79.         AUU can also write  a simple screen  of statistics  in ASCII, 
  80.         ANSI and AVATAR flavours, giving various information such as
  81.         the percentage of users  who have called more  than once and
  82.         the amount of files downloaded in kilobytes, among others.
  83.  
  84.  
  85.         Features
  86.         ============================================================
  87.  
  88.         AUU can
  89.  
  90.           - Send messages to your new users, welcoming them to your
  91.             system;
  92.  
  93.           - Upgrade your users based on
  94.  
  95.               . the number of calls they have made,
  96.  
  97.               . the number of messages they have written,
  98.  
  99.               . the number of kilobytes they have uploaded;
  100.  
  101.           - Control user security  based on their upload / download
  102.             ratios;
  103.  
  104.           - Send messages to users when their  security level is up
  105.             or downgraded.
  106.  
  107.           - AUU is totally configurable.  All security levels,  up-
  108.             grade controls, ratios, message texts and subjects etc.
  109.             can be configured to your tastes.
  110.  
  111.           - AUU's  message texts  may contain  $metastrings,  which
  112.             AUU will substitute for values such as the user's ratio
  113.             (required / current), the security they are being moved
  114.             to or from, their names, and other information.
  115.  
  116.           - AUU can write a statistics screen with various informat
  117.             -ion about the users in your user file.
  118.  
  119.  
  120.  
  121.  
  122.         AUU has  been  tested with  RemoteAccess 2.00 GAMMA 1,  and
  123.         various RemoteAccess 2.00 beta versions.  AUU will not work
  124.         with RemoteAccess 1.xx or other BBS programs.
  125.  
  126.  
  127.         Configuration
  128.         ===========================================================
  129.  
  130.         AUU is configured through the text file AUU.CFG.  To set up
  131.         AUU,  edit AUU.CFG with your  favourite text editor,  which
  132.         must save in straight text format  -  do not use fancy word
  133.         processors which  may have their own file format.  QEdit or
  134.         Microsoft DOS' 5 or later's EDIT will work fine.
  135.  
  136.         Specific details of AUU.CFG can be found in AUU.CFG itself.
  137.         Exact configuration details will not be discussed here.
  138.  
  139.         AUU's message text files (whose filenames are configured in
  140.         AUU.CFG), generally .AUU files, contain the text to be used
  141.         in messages to  your users.  These too may be edited with a
  142.         text editor. Some samples can be found inside SAMPLES.ARJ.
  143.  
  144.         AUU  supports the a number of macros (metrastrings)  in the
  145.         message  text files.  When a message is sent AUU to  a user,
  146.         AUU will  replace these macros  with the value for the that
  147.         user.
  148.  
  149.  
  150.         Macro                   Meaning
  151.         ===========================================================
  152.         $name                   The user's name, eg Hamish Moffatt
  153.         $firstname              The user's firstname, eg Hamish
  154.  
  155.         $fromlevel              The security level the user is
  156.                                 being moved from, eg 50
  157.         $tolevel                The security level the user is
  158.                                 being moved to, eg 75.
  159.  
  160.         $calls                  Number of calls the user has made
  161.                                 to the BBS, eg 20.
  162.         $uploadk                The number of kilobytes the user has
  163.                                 uploaded, eg 2048.
  164.         $uploadf                The number of files the user has
  165.                                 uploaded, eg 30.
  166.         $messages               The number of messages the user has
  167.                                 written, eg 45.
  168.  
  169.         $ratio                  The ratio required by the user's
  170.                                 security level ("1:x"), eg 1:7.
  171.         $currentratio           The user's current upload/download
  172.                                 ratio ("1:x"), eg 1:20.
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.         For example,
  184.  
  185.         ===========================================================
  186.         
  187.         Hello $firstname,
  188.  
  189.         Since you've written $messages messages, you've been
  190.         upgraded from security $fromlevel to $tolevel.
  191.         Congratulations!
  192.  
  193.         Hamish Moffatt
  194.  
  195.         translates to
  196.  
  197.         ===========================================================
  198.  
  199.         Hello Hamish,
  200.  
  201.         Since you've written 20 messages, you've been
  202.         upgraded from security 50 to 75.
  203.         Congratulations!
  204.  
  205.         Hamish Moffatt
  206.  
  207.  
  208.         Running AUU
  209.         ===========================================================
  210.  
  211.         AUU is run by simply typing
  212.  
  213.                 AUU
  214.  
  215.         or the same  from a batch file.  AUU requires  and takes no
  216.         command line options. AUU will display, on the screen, what
  217.         it is doing.
  218.  
  219.         AUU will only write messages to new users on the first time
  220.         it is run each day. This is to prevent users from receiving
  221.         more than one message. Additionally,  AUU will only process
  222.         new users  since it was last run,  and AUU will not process
  223.         today's new users - only those who are new between when AUU
  224.         was last run and yesterday.  If this were not the case, AUU
  225.         would not know who had already been sent messages.
  226.  
  227.         AUU will upgrade users and check ratios at  any time of the
  228.         day, though; you may run AUU however many times you like in
  229.         a day and AUU  will do everything on its first run,  and on
  230.         subsequent runs ignore the new user processing.
  231.  
  232.         AUU maintains a  small file called AUU.DAT,  which contains
  233.         the  date on which  AUU was last run.  AUU will create this
  234.         file if it is missing. When AUU is first installed, it will
  235.         not start  processing new users until  the next day,  as it
  236.         has not been run before.
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.         Registration / Legal information
  245.         ===========================================================
  246.  
  247.         AUU is shareware. After a reasonable trial period,  such as
  248.         two weeks or a month,  you are requested  (and expected) to
  249.         register with the author. Many hours of hard work have gone
  250.         into developing AUU.
  251.  
  252.         For specific registration details,  please see the included
  253.         REGISTER.DOC.  RABIRTH users may wish to note  the discount
  254.         for registering both programs together. Registration prices
  255.         and addresses and forms may be found in REGISTER.DOC.
  256.  
  257.         Upon registration you will be  supplied with a registration
  258.         key. This key does not  enable any extra features,  but AUU
  259.         will display that it is  registered on the console and log,
  260.         and thank you.  Additionally, when  unregistered,  AUU will
  261.         insert a tearline at the bottom of its messages, such as
  262.  
  263.         --- AUU 1.00 (unregistered)
  264.  
  265.         When AUU is registered,  this tearline will disappear.  AUU
  266.         will instead use a PID kludge, which is not visible to your
  267.         users: your users will not know it is a robot.
  268.  
  269.         AUU is copyright software.  AUU still may be  shared around
  270.         amongst your friends, but it remains the property of Hamish
  271.         Moffatt, the author.  Disassembly,  reverse engineering and
  272.         modification  of  the  AUU  executables,  documentation  or
  273.         archives  (excluding   rearchiving  in  other  formats)  is
  274.         prohibited.
  275.  
  276.  
  277.         Contacting the author
  278.         ===========================================================
  279.  
  280.         By postal mail:
  281.  
  282.         Hamish Moffatt
  283.         10 Ryrie Place
  284.         Vermont South,
  285.         Melbourne,
  286.         Australia. 3133
  287.  
  288.         By electronic mail:
  289.  
  290.         3:635/552@fidonet; 58:4100/43@intlnet; 61:9420/130@worldnet,
  291.         15:4100/113@sbcnet; 199:4242/10@rainbownet.
  292.  
  293.         hamish@cloud.apana.org.au by Internet mail.
  294.         >INTERNET:hamish@cloud.apana.org.au from CompuServe.
  295.  
  296.         Feedback, bug reports, suggestions, etc, are always welcome
  297.         at any of the above addresses.
  298.  
  299.  
  300.  
  301.  
  302.  
  303.         Thank yous
  304.         ===========================================================
  305.  
  306.         Thank yous are extended to, in no particular order,
  307.  
  308.         Simon Gronow, Roy Austen, Greg Holloway, Harry Konstantinou,
  309.         Paul Purvis, Tony Laughton, Richard Kempe, Ron Page,
  310.         Aaron Smith.
  311.  
  312.         Any others (including other OBTT members) who I may have
  313.         left out, please contact me and my sincerest apologies.
  314.  
  315.         Thanks also to Andrew Milner for RemoteAccess 2.00,
  316.         Borland International for Turbo Pascal 6.0, and Bo Bendtsen
  317.         for not upgrading RAQUSER so I'd write this. :-)
  318.  
  319.  
  320.         That's all, folks.
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.