home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / AUU110.RAR / AUU.DOC < prev    next >
Encoding:
Text File  |  1994-05-28  |  11.9 KB  |  387 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.         3:632/552@fidonet
  30.  
  31.  
  32.  
  33.         Documentation
  34.  
  35.  
  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.10 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.         If you receive subscriptions regularly,  AUU can upgrade the
  85.         new subscribers to a new access level automatically,  rather
  86.         than you having to upgrade them manually.
  87.  
  88.  
  89.         Features
  90.         ============================================================
  91.  
  92.         AUU can
  93.  
  94.           - Send messages to your new users, welcoming them to your
  95.             system;
  96.  
  97.           - Upgrade your users based on
  98.  
  99.               . the number of calls they have made,
  100.  
  101.               . the number of messages they have written,
  102.  
  103.               . the number of kilobytes they have uploaded;
  104.  
  105.           - Control user security  based on their upload / download
  106.             ratios;
  107.  
  108.           - Send messages to users when their  security level is up
  109.             or downgraded.
  110.  
  111.           - Upgrade your new subscribers automatically.
  112.  
  113.           - AUU is totally configurable.  All security levels,  up-
  114.             grade controls, ratios, message texts and subjects etc.
  115.             can be configured to your tastes.
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.           - AUU's  message texts  may contain  $metastrings,  which
  123.             AUU will substitute for values such as the user's ratio
  124.             (required / current), the security they are being moved
  125.             to or from, their names, and other information.
  126.  
  127.           - AUU can write a statistics screen with various informat
  128.             -ion about the users in your user file.
  129.  
  130.           - AUU supports the new JAM message base.
  131.  
  132.  
  133.         AUU has  been tested with  RemoteAccess 2.01.  AUU will not
  134.         work with RemoteAccess 1.xx.  If you need a similar program
  135.         for RA 1.x, try Bo Bendtsen's RAQUSER.
  136.  
  137.  
  138.         Configuration
  139.         ===========================================================
  140.  
  141.         AUU is configured through the text file AUU.CFG.  To set up
  142.         AUU,  edit AUU.CFG with your  favourite text editor,  which
  143.         must save in straight text format  -  do not use fancy word
  144.         processors which  may have their own file format.  QEdit or
  145.         Microsoft DOS' 5 or later's EDIT will work fine.
  146.  
  147.         Specific details of AUU.CFG can be found in AUU.CFG itself.
  148.         Exact configuration details will not be discussed here.
  149.  
  150.         AUU's message text files (whose filenames are configured in
  151.         AUU.CFG), generally .AUU files, contain the text to be used
  152.         in messages to  your users.  These too may be edited with a
  153.         text editor. Some samples can be found inside SAMPLES.ARJ.
  154.  
  155.         AUU  supports the a number of macros (metrastrings)  in the
  156.         message  text files.  When a message is sent AUU to  a user,
  157.         AUU will  replace these macros  with the value for the that
  158.         user.
  159.  
  160.  
  161.         Macro                   Meaning
  162.         ===========================================================
  163.         $name                   The user's name, eg Hamish Moffatt
  164.         $firstname              The user's firstname, eg Hamish
  165.  
  166.         $fromlevel              The security level the user is
  167.                                 being moved from, eg 50
  168.         $tolevel                The security level the user is
  169.                                 being moved to, eg 75.
  170.  
  171.         $calls                  Number of calls the user has made
  172.                                 to the BBS, eg 20.
  173.         $uploadk                The number of kilobytes the user has
  174.                                 uploaded, eg 2048.
  175.         $uploadf                The number of files the user has
  176.                                 uploaded, eg 30.
  177.         $downloadk              The number of kilobytes the user has
  178.                                 downloaded, eg 4335.
  179.  
  180.  
  181.  
  182.         $downloadf              The number of files the user has
  183.                                 downloaded, eg 19.
  184.         $messages               The number of messages the user has
  185.                                 written, eg 45.
  186.  
  187.         $ratio                  The ratio required by the user's
  188.                                 security level ("1:x"), eg 1:7.
  189.         $currentratio           The user's current upload/download
  190.                                 ratio ("1:x"), eg 1:20.
  191.         $needupload             The number of kilobytes the user needs
  192.                                 to upload to restore his ratio.
  193.         $untilratio             The number of kilobytes the user can
  194.                                 download before his ratio will be
  195.                                 exceeded.
  196.  
  197.  
  198.  
  199.         For example,
  200.  
  201.         ===========================================================
  202.         
  203.         Hello $firstname,
  204.  
  205.         Since you've written $messages messages, you've been
  206.         upgraded from security $fromlevel to $tolevel.
  207.         Congratulations!
  208.  
  209.         Hamish Moffatt
  210.  
  211.         translates to
  212.  
  213.         ===========================================================
  214.  
  215.         Hello Hamish,
  216.  
  217.         Since you've written 20 messages, you've been
  218.         upgraded from security 50 to 75.
  219.         Congratulations!
  220.  
  221.         Hamish Moffatt
  222.  
  223.  
  224.         Running AUU
  225.         ===========================================================
  226.  
  227.         AUU is run by simply typing
  228.  
  229.                 AUU
  230.  
  231.         or the same  from a batch file.  AUU requires  and takes no
  232.         command line options. AUU will display, on the screen, what
  233.         it is doing.
  234.  
  235.         AUU will only write messages to new users on the first time
  236.         it is run each day. This is to prevent users from receiving
  237.         more than one message. Additionally,  AUU will only process
  238.         new users  since it was last run,  and AUU will not process
  239.  
  240.  
  241.  
  242.         today's new users - only those who are new between when AUU
  243.         was last run and yesterday.  If this were not the case, AUU
  244.         would not know who had already been sent messages.
  245.  
  246.         AUU will upgrade users and check ratios at  any time of the
  247.         day, though; you may run AUU however many times you like in
  248.         a day and AUU  will do everything on its first run,  and on
  249.         subsequent runs ignore the new user processing.
  250.  
  251.         AUU maintains a  small file called AUU.DAT,  which contains
  252.         the  date on which  AUU was last run.  AUU will create this
  253.         file if it is missing. When AUU is first installed, it will
  254.         not start  processing new users until  the next day,  as it
  255.         has not been run before.
  256.  
  257.  
  258.         Subscription upgrading
  259.         ===========================================================
  260.  
  261.         AUU can automatically upgrade your new subscribers to subsc
  262.         -riber access.  Simply create a text file  (the filename is
  263.         configured in AUU.CFG)  and list the users  that need to be
  264.         upgraded. AUU will remove the names of users it has sucess-
  265.         fully upgraded. You can list users who do not appear in the
  266.         user file here - they will be upgraded when they do logon.
  267.  
  268.         The format of each line in the text file is:
  269.         <Name> [/S<security>] [/M<months>]
  270.  
  271.         <Name> is  the name of the  user to upgrade.  The /S and /M
  272.         switches are optional, and override the defaults configured
  273.         in AUU.CFG. For example,
  274.  
  275.         Joe Blow
  276.  
  277.         would upgrade Joe Blow  to the default  subscription  level
  278.         with the default subscription length, while
  279.  
  280.         Joe Blow /S100
  281.  
  282.         would give him security 100 instead.
  283.  
  284.         Joe Blow /M9
  285.  
  286.         would give him a 9 month subscription, and
  287.  
  288.         Joe Blow /S200 /M5
  289.  
  290.         would give him five months at security 500.
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.         Registration / Legal information
  303.         ===========================================================
  304.  
  305.         AUU is shareware. After a reasonable trial period,  such as
  306.         two weeks or a month,  you are requested  (and expected) to
  307.         register with the author. Many hours of hard work have gone
  308.         into developing AUU.
  309.  
  310.         For specific registration details,  please see the included
  311.         REGISTER.DOC.  RABIRTH users may wish to note  the discount
  312.         for registering both programs together. Registration prices
  313.         and addresses and forms may be found in REGISTER.DOC.
  314.  
  315.         Registration does not enable any extra features. The regist
  316.         -ered and unregistered versions are identical; in fact, you
  317.         will  not receive  anything for registering,  except a warm
  318.         inner glow  and the  knowledge that  you are supporting the
  319.         invaluable shareware concept.
  320.  
  321.         AUU is copyright software.  AUU still may be  shared around
  322.         amongst your friends, but it remains the property of Hamish
  323.         Moffatt, the author.  Disassembly,  reverse engineering and
  324.         modification  of  the  AUU  executables,  documentation  or
  325.         archives  (excluding   rearchiving  in  other  formats)  is
  326.         prohibited.
  327.  
  328.  
  329.         Contacting the author
  330.         ===========================================================
  331.  
  332.         By postal mail:
  333.  
  334.         Hamish Moffatt
  335.         10 Ryrie Place
  336.         Vermont South,
  337.         Melbourne,
  338.         Australia. 3133
  339.  
  340.         By electronic mail:
  341.  
  342.         3:632/552@fidonet; 15:4100/113@sbcnet.
  343.  
  344.         hamish@cloud.apana.org.au by Internet mail.
  345.         >INTERNET:hamish@cloud.apana.org.au from CompuServe.
  346.  
  347.         Feedback, bug reports, suggestions, etc, are always welcome
  348.         at any of the above addresses.
  349.  
  350.         You can receive the latest version of AUU by mailing
  351.         auu@cloud.apana.org.au.
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.         Thank yous
  364.         ===========================================================
  365.  
  366.         Thank yous are extended to, in no particular order,
  367.  
  368.         Simon Gronow, Roy Austen, Greg Holloway, Harry Konstantinou,
  369.         Paul Purvis, Tony Laughton, Richard Kempe, Ron Page,
  370.         Aaron Smith.
  371.  
  372.         Any others (including other OBTT members) who I may have
  373.         left out, please contact me and my sincerest apologies.
  374.  
  375.         Thanks also to Andrew Milner for RemoteAccess 2.01,
  376.         Borland International for Turbo Pascal 7.0, and Bo Bendtsen
  377.         for not upgrading RAQUSER so I'd write this. :-)
  378.  
  379.         JAM(mbp) - Copyright 1993 Joaquim Homrighausen, Andrew Milner,
  380.         Mats Birch, Mats Wallin. All rights reserved.
  381.  
  382.         AUU uses Mark May's excellent MKMSG message base routines.
  383.  
  384.         That's all, folks.
  385.  
  386.  
  387.