home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FRAME11.ZIP / FRAME.DOC < prev    next >
Encoding:
Text File  |  1993-09-15  |  12.3 KB  |  315 lines
  1.                                  FRAME v1.1
  2.  
  3.             A Statistic and File Header Utility for RemoteAccess
  4.  
  5.                                  USER MANUAL
  6.  
  7.             Software and documentation written by Yat Tung Cheung
  8.                       Copyright (C) 1993 Yat Tung Cheung
  9.                             All rights reserved
  10.                                                         
  11.          Made with Pride in Hong Kong, Enjoy BBS (6:700/648@FidoNet)
  12.  
  13.    Introduction
  14.    ------------
  15.    FRAME is a statistic and file header utility for Remote Access V2.0.
  16.    It will generate the top user bulletins, top download file list and
  17.    create a header for file areas. All output can be customizable and 
  18.    drawn with your favourite ANSI or ASCII editor.
  19.  
  20.    
  21.    Legal section 
  22.    -------------
  23.  
  24.    FRAME is neither freeware nor public domain;  FRAME is shareware.  
  25.    After a reasonable trial period (14 days suggested), you are expected 
  26.    to register your copy of FRAME with the author if you would like to 
  27.    continue to use FRAME.  See the file register.doc for details. Remember 
  28.    that this would gives great encouragement to the author and makes him 
  29.    further development this program and other programs.
  30.  
  31.    FRAME is (C)opyright 1993 Yat Tung Cheung. Disassembly of and 
  32.    modifications to the executables and documentation is NOT allowed.
  33.  
  34.    Use in a commercial environment without registration is prohibited after
  35.    the trial period!
  36.    
  37.     ** If you registered FRAME, you will receive the most updated and   **
  38.     ** registered version of FRAME, together with some more utilities   **
  39.     ** by the author if available, by physical mail. In the registered  **
  40.     ** version, the line 'This screen is created by FRAME, unregistered **
  41.     ** version' will be removed from the User Statistic Bulletin and    **
  42.     ** the 5 seconds delay will be removed also.                        **
  43.    
  44.    
  45.    Features
  46.    --------
  47.    *   Top user statistics generator. Including:
  48.        
  49.        Top Callers, Top Message Writers, Top Downloaders(in kilobytes
  50.        and files), Top Uploaders (in kilobytes and files), as well as
  51.        totals and averages.
  52.    
  53.    *   Can be configured to exclude certain users from the statistics.
  54.  
  55.    *   Directly read/write the new Remote Acess 2.0's file database. Fast!
  56.  
  57.    *   All outputs can be customizable and drawn with an ANSI or ASCII editor.
  58.  
  59.    *   The file header can be an ANSI or ASCII file.
  60.  
  61.    *   Smart mode, Frame will only update those file headers which the file
  62.        base has been modified since FRAME was run last time. This would
  63.        save a considerable amount of time, especially with many file areas.
  64.  
  65.    
  66.    File Descriptions
  67.    -----------------
  68.  
  69.    FRAME.EXE.............The EXE file of FRAME
  70.    FRAME.DOC.............User manual of this program
  71.    REGISTER.DOC..........Registration form 
  72.    SAMPLE.ZIP............Archive which contains sample files ready to run.
  73.    ----FRAME.CTL.........Sample configuration file
  74.    ----HEADER.ANS/ASC....Sample file header template file
  75.    ----F_CALL.ANS/ASC....Sample User Statistic template, Top Caller
  76.    ----F_POST.ANS/ASC....Top Message Writer template file
  77.    ----F_UPLK.ANS/ASC....Top Uploader in Kilobytes template file
  78.    ----F_UPLF.ANS/ASC....Top Uploader in no. of files template file
  79.    ----F_DWLK.ANS/ASC....Top Downloader in Kilobytes template file
  80.    ----F_DWLF.ANS/ASC....Top Downloader in no. of files template file
  81.    ----F_STAT.ANS/ASC....BBS Statistics template file
  82.    ----USER.CTL..........User exclusion list
  83.    FILE_ID.DIZ...........Description file for BBS SysOp
  84.  
  85.    
  86.    Credits
  87.    -------
  88.    The author would like to thanks the following persons:
  89.  
  90.    Mok Joey (6:700/685) ----------- for supporting FRAME, giving new ideas,
  91.                                      and beta testing.
  92.  
  93.    Simon Fong (6:700/622) --------- for supporting FRAME and beta testing
  94.  
  95.    Wong Tang Fung (6:700/416.1) --- for reporting the bugs in v1.0 and beta
  96.                                     testing.
  97.  
  98.    AND of course all registered users!
  99.    
  100.    
  101.    Installation
  102.    ------------
  103.    1. Make a directory, eg: c:\frame, and copy all files into it.
  104.    
  105.    2. The RA environmental variable must be set to point to the RA system
  106.       directory, eg set ra=c:\ra .
  107.  
  108.    3. You will need to draw your own templates for the top user statistics,
  109.       top download list and file header. The templates can be an ASCII or 
  110.       ANSI file. If you want to create a AVT file, please use a conversion
  111.       utility to convert the ANSI bulletins to AVT bulletins. For details, 
  112.       please refer to the Template Creation section.
  113.       
  114.       The templates file should be put in the current directory and the
  115.       bulletins will be created in the RA text file directory.
  116.  
  117.       NOTE: Some samples come from this archive, you may want to unpack
  118.             sample.zip, then you may skip the steps to create your
  119.             own template files. You may modify them to suit your needs 
  120.             instead. Enter FRAME /F /U at the dos prompt and see what it 
  121.             can do!
  122.  
  123.    4. You will need to run an ASCII editor to edit the configuration file, 
  124.       FRAME.CTL.
  125.  
  126.       In the 1-10 line, please enter the top download list template filename,
  127.       you may have up to 10 top download list template files, if you have less
  128.       then 10, you will need to supply the extra space line.
  129.  
  130.       In the 11th line, please enter the file header template filename.
  131.     
  132.       In the 12th line, enter the file areas you want to ignore from the top
  133.       download list. eg 10 11
  134.  
  135.       In the 13th line, enter the file areas you want to ignore from the file
  136.       header generation.
  137.  
  138.       The rest are for the user statistics template filename, you may have
  139.       up to 50 user statistics templates.
  140.  
  141.    5. Run FRAME /F /U at the dos prompt and setup events at your mailer or 
  142.       Remote Access to run it at regular intervals to update the bulletins.
  143.  
  144.  
  145.    Command-line parameters
  146.    -----------------------
  147.    Usage: FRAME <switches>
  148.    
  149.    Switches:
  150.    
  151.    /F Generate the File Headers and the Top Download List only
  152.       This uses the file header template and the top download list
  153.       template files.
  154.    
  155.    /U Generate the User and System bulletins only
  156.       This uses the user statistic template files.
  157.    
  158.    /S Smart Mode in generating the File Headers
  159.       You will need to disable this if you would like to use a different
  160.       file header template file.
  161.    
  162.    /? Display a help screen
  163.  
  164.    
  165.    Template Creation        
  166.    -----------------
  167.    
  168.    Top Download Template File
  169.    --------------------------
  170.    The top download template file can be an ANSI or ASCII file and include 
  171.    any one of the following macros which will be translated.               
  172.         
  173.         F#     Filename
  174.         S#     Filesize
  175.         C#     No. of downloads
  176.         U#     Name of uploader
  177.         D#     Description of the file
  178.         I#     Upload date
  179.         J#     File date
  180.         K#     Last download date
  181.  
  182.         where # is the rank of the top download file. From 1 up to 50.
  183.                is input by pressing CTRL-R in the ANSI editor.
  184.  
  185.    Using the codes as they look above will place only the amount of 
  186.    characters needed to display. You can use one of three format modifiers 
  187.    to help when drawing boxes and such. The three characters are \/| and 
  188.    allow for left justify, right justify and centering of the string. In a 
  189.    example if the filename is ABCD.BAK and it is the 10th most download
  190.    file.
  191.  
  192.    Before: │ %F10\\\\\\\\ │ %F10//////// │ %F10|||||||| │
  193.    After : │ ABCD.BAK     │     ABCD.BAK │   ABCD.BAK   │
  194.  
  195.    Don't forget to allow enough space for the variable otherwise it will
  196.    be truncated to fit.
  197.  
  198.  
  199.    File Header Template File
  200.    -------------------------
  201.    The File Header template file can be an ANSI or ASCII file and include 
  202.    any one of the following macros which will be translated.
  203.         
  204.         B      Total no. of bytes    
  205.         K      Total no. of kilobytes
  206.         D      Total no. of downloads
  207.         V      Average no. of downloads per file 
  208.         F      Total no. of files       
  209.         O      Total no. of files offlined
  210.         A      Area Name
  211.         N      Area No
  212.         S      Minimum security level for downloads
  213.         P      Filename of the most popular file (downloaded by most users)
  214.         Q      No. of downloads of the most popular file
  215.         L      Filename of the largest file
  216.         M      Size of the largest file
  217.         
  218.                is input by pressing CTRL-U in the ANSI editor.
  219.  
  220.         The left three format modifiers are valid in file header template.
  221.  
  222.    Limitations on ANSI header:
  223.    (1) The output of each line should be less than 255 characters, or it 
  224.        will be truncated by RA. If this happens use less colors on a single
  225.        line.
  226.    (2) The each line of the ANSI template file should begin with a color
  227.        code as RA automatically inserts a bright white color at the
  228.        beginning of each line while displaying the file header.
  229.  
  230.  
  231.    User Statistics Template File
  232.    -----------------------------
  233.    The User Statistics template file can be an ANSI or ASCII file and 
  234.    include any one of the following macros which will be translated.
  235.  
  236.         A#     Top Caller
  237.         B#     Top Caller
  238.         C#     Top Message Writer
  239.         D#     Top Message Writer
  240.         E#     Top Uploader by kilobytes
  241.         F#     Top Uploader by kilobytes
  242.         G#     Top Uploader by no. of files
  243.         H#     Top Uploader by no. of files
  244.         I#     Top Downloader by kilobytes
  245.         J#     Top Downloader by kilobytes
  246.         K#     Top Downloader by no. of files
  247.         L#     Top Downloader by no. of files
  248.         M      Total no. of Calls
  249.         N      No. of calls per user
  250.         O      Total no. of messages posted
  251.         P      No. of messages posted per user
  252.         Q      Total no. of kilobytes uploaded
  253.         R      No. of kilobytes uploaded per user
  254.         S      Total no. of files uploaded
  255.         T      No. of files uploaded per user    
  256.         U      Total no. of kilobytes downloaded
  257.         V      No. of kilobytes downloaded per user
  258.         W      Total no. of files uploaded
  259.         X      No. of files uploaded per user
  260.         Z      Total no. of users
  261.               
  262.               where # is the rank of the top user, from 1 up to 50.
  263.                is input by pressing CTRL-U in the ANSI editor.
  264.  
  265.         The left three format modifiers are valid in user statistics 
  266.         template.
  267.  
  268.  
  269.    Exclusion List
  270.    --------------
  271.    FRAME supports an exclusion list which allows you to specify up to 200 
  272.    users which you do not want to be include in the bulletins. This is 
  273.    useful if have users (or co-sysops, or SysOp yourself) which you want to 
  274.    "hide" from the bulletins.
  275.  
  276.    In order to use this feature you must create a plain ASCII text file 
  277.    called USER.CTL and simply list the names of the user which you want 
  278.    to be excluded (one entry per line). 
  279.    
  280.  
  281.    History
  282.    -------
  283.    V1.0 (Aug 1993)  --- First public release
  284.    V1.1 (Sept 1993) --- Several bugs are corrected:
  285.                         1. Frame will not work properly if the total number
  286.                         of users or files is less than fifty. FIXED!
  287.                         2. Frame count a comment line as a file entry. FIXED!
  288.                         The two bugs are reported by Wong Tang Fung.
  289.                         Thanks him.
  290.                         
  291.                         New features:
  292.                         1. Command-line switches for carring out different
  293.                         functions.
  294.                         2. Smart mode, faster operation.
  295.  
  296.  
  297.    Support Site
  298.    ------------
  299.    BBS Name: Enjoy BBS
  300.    Address : 6:700/648@FidoNet
  301.    Tel no. : (852)398-2059
  302.    SysOp   : Yat Tung Cheung
  303.    Location: Hong Kong, Asia
  304.  
  305.    BBS Name: Tokyo Love Story
  306.    Address : 6:700/685@FidoNet
  307.    Tel no. : (852)409-0029
  308.    SysOp   : Mok Joey
  309.    Location: Hong Kong, Asia
  310.  
  311.    The newest version of FRAME are always available from the above BBSes.
  312.    File Request is available at 6:700/648 with the magic word 'FRAME'.
  313.  
  314.    -------------<End of Docuement, Thanks for trying FRAME>--------------
  315.