New Horizons Shareware Collection/HORIZONS1.BIN/TOP.DOC

Text File | 1995-02-19 | 6KB | 124 lines

        ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
         ──────────═════════φ  PWA Week/Month Top PPE  φ══════════─────────
        ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄

                                 (C) BlackCat
                         Version 1.0

        ────────────────────────────────────────────────────────────────────

    This PPE generates bulletins of your top weekly/monthly downloaders
    (file and bytes) and uploaders (files and bytes). The bulletins are
    extremely configurable through replacement codes

    The default setup only creates the top (ul/dl) bytes bulletins,
    you can also create the top (ul/dl) files bulletins if desired, see
    TOP.CFG for further information.

        ────────────────────────────────────────────────────────────────────
             ──────────═════════φ  Installation φ══════════────────────
        ────────────────────────────────────────────────────────────────────

        ■ Put '!<PPEPATH>LOGON.PPE' in your logon script or somewhere else
      in the user logon process.
        ■ Replace PCBTEXT prompt 192 with '!<PPEPATH>TOP.PPE',
      To replace the prompt do the following:

           1 - Run 'MKPCBTXT <TEXTFILE>', where <TEXTFILE> is your pcboard
               textfile.
           2 - Press F3 and enter 192.
           3 - Replace the prompt by '!<PPEPATH>\TOP.PPE' where <PPEPATH>
               is the directory where the TOP ppe resides.

           NOTE: If you already have something else running at prompt 192
           (eg. my lastcallers ppe) put a display file in here and put
           the calls to the PPEs in there. Eg. if you're using display
           file e:\pcb\gen\192text replace the prompt with
           '%e:\pcb\gen\192text' and put the call to the ppe in 192text.
           The display file 192text might look something like this:

                --------------------------------------
                !f:\ppl\logon\lco.ppe
                !f:\ppl\top\192off.ppe
                !f:\ppl\top\top.ppe
                --------------------------------------

                The 192off.ppe is included in the distribution. It simply
        disconnects the user so that he won't see TOP.PPE doing it's
        thing. Don't put it in front of LCO.PPE (or any other
        lastcallers for that matter) in case they detect carrier lost.

        ────────────────────────────────────────────────────────────────────
             ──────────═════════φ  Configuration φ══════════────────────
        ────────────────────────────────────────────────────────────────────

    The PPE uses the header/footer files in the GRAPH subdirectory
    together with the lines defined in TOP.CFG to create the bulletins.

    The bulletins are created in the same directory as TOP.PPE. They
    are:
           W*BLT  - The weekly bulletins.
           M*BLT  - The monthly bulletins

    You can put these bulletins in just about any display  file you want.
    Just display them by using the '%' prefix (eg. %c:\ppl\top\fupblt).
    You can also add them as normal pcboard bulletins of course.

    TOP.CFG is used to configure the bulletins. Each bulletin has a line
    in TOP.CFG associated with it which can contain replacement codes.
    These codes are replaced with the correct information by TOP.PPE and
    written out to the bulletin.

    The replacement codes allowed are:

        %NR%    - The users top number (1-number of users defined in line
                  one of TOP.CFG)
        %NAME%  - The users name.
        %LOC%   - The users location.
        %FIRST% - The sorted on field (bytes or files).
                  With a bytes bulletin this will be replaced by the nr.
                  of (dl/ul) bytes in this session.
              With a files bulletin thie will be replaced by the nr.
              of (dl/ul) files in this session.
        %SECOND%- With a bytes bulletin this will be replaced by the nr.
                  of (dl/ul) files in this session.
              With a files bulletin thie will be replaced by the nr.
              of (dl/ul) bytes in this session.


           The following totals macros can be used in the *ftr files (subdir
           GRAPH):

               %TFIRST% - Totals for the sorted on field (bytes or files).
                      With a bytes bulletin this will be replaced by the
              total nr. of (dl/ul) bytes in this week/month.
                  With a files bulletin thie will be replaced by the
              total nr. of (dl/ul) files in this week/month.
           %TSECOND%- Totals for the second field (bytes or files).
                      With a bytes bulletin this will be replaced by the
              total nr. of (dl/ul) files in this week/month.
                  With a files bulletin thie will be replaced by the
              total nr. of (dl/ul) bytes in this week/month.

        The exclusion file TOP.EXC can be used to exclude certain users from
    being added to the top bulletins. For speed reasons this file is not
    read line by line and you should therefore enclose each name added
    with quotes (ie. when adding user BLACKCAT add a line as "BLACKCAT")
    to prevent names from being detected as substrings of other names (this
    is assuming users don't use quotes in their names).

        Currently the maximum size for the exclusion file is about
    2048 (BigStr) bytes. This should be enough for about 100 users.
    If you really need to be able to add more users to the exclusion list
    get in contact with me and I will adjust the code.

        ────────────────────────────────────────────────────────────────────
                ──────────═════════φ  Author φ══════════────────────
        ────────────────────────────────────────────────────────────────────

    If you find bugs, have any suggestions or additions you want email
    me on internet at: [e-mail].

        You can also call me at: [phone].