home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / OLZ_13.ZIP / OLZ.DOC < prev    next >
Encoding:
Text File  |  1993-02-07  |  14.7 KB  |  332 lines
  1.  
  2.         ┌────────────────────────────────┐
  3.         │ AvernusWare Proudly Presents   │
  4.         │                                │
  5.         │       OneLinerZ! v1.3          │
  6.         │ Programmed by Dennis Alexander │
  7.         │       Copyright 1993           │
  8.         └────────────────────────────────┘
  9.  
  10.         Introduction
  11.         ────────────
  12.  
  13.                 Hello and welcome to OneLinerZ!  This program was
  14.         written, and should work for the following BBS programs:
  15.         Renegade, T.A.G., and Telegard.  The program works best on
  16.         Renegade and Telegard, but should work on T.A.G. as well.
  17.         What is this program?  OneLinerZ! is a program based on a
  18.         "rumors" program I have seen for other BBS softwares such
  19.         as Celerity.  The program allows users to enter one line
  20.         of ANSI, AVATAR or ASCII text, usually the oneliners are
  21.         something like this: "Press ALT-H for SysOp access!!", or
  22.         often they are used to advertise bulletin boards, "Call
  23.         AVERNUS at 313.427.0224!", etc.  If you have any problems
  24.         with the program, bugs to report, or suggestions, please
  25.         let me know at the above BBS if possible.
  26.  
  27.  
  28.         Disclaimer
  29.         ──────────
  30.  
  31.                 This program contains NO guarantees or warrantees.
  32.         Use it at your own risk.  I HIGHLY doubt, however, that it
  33.         can do ANY damage whatsoever to your computer or BBS, so
  34.         you shouldn't worry.  This program doesn't touch ANY of
  35.         your BBSs data files.
  36.  
  37.  
  38.         Registration
  39.         ────────────
  40.  
  41.                 HA!  This program is FreeWare.  By using this
  42.         program it is payment enough for me.  I also do not
  43.         believe in charging for little BBS utilities.  Support the
  44.         Hacker Ethic and FREE INFORMATION.  (I'm talking about
  45.         TRUE Hackers, get the book Hackers if you don't know what
  46.         I am talking about.)
  47.  
  48.  
  49.         Packing List
  50.         ────────────
  51.  
  52.         The archive OLZ-13.ZIP should contain the following:
  53.  
  54.         OLZ.EXE      ■ The main program.
  55.         OLZ.DOC      ■ This file; manual for use.
  56.         OLZ.MNU      ■ An example Renegade and Telegard menu file
  57.         OLZSETUP.EXE ■ To INSTALL and EDIT OneLinerZ!
  58.         OLZRAND.EXE  ■ Used to randomize OneLiners.
  59.         PACKER.EXE   ■ Used to weed out deleted records.
  60.         AUTODEL.EXE  ■ Used to weed out OneLiners x number of days old.
  61.         AVERNUS.EXE  ■ My shameless BBS ad.  If you like this loader then
  62.                        you can have your own done by Knight.  Contact me
  63.                        or Knight at Defcon 5 (313) 562.3506.  Leave Email
  64.                        to the SysOp when you log on regarding your request
  65.                        and he will get back to you ASAP.
  66.         CONVERT.EXE  ■ Used in converting older versions of OneLinerZ!
  67.         BATCH.ZIP    ■ Archived example batch files.
  68.         UPGRADE.DOC  ■ Upgrade information and history.
  69.         README.1ST   ■ A disclaimer to UNARCHIVE BATCH.ZIP to your BBS dir.
  70.  
  71.         Installation (For Renegade and Telegard systems)
  72.         ────────────────────────────────────────────────
  73.  
  74.         Note: This documentation assumes you know something about your
  75.               respective BBS software.  I cannot provide a key press by
  76.               key press tutorial on how to set this up, use your own
  77.               common sense!
  78.  
  79.         Preliminary Info
  80.         ────────────────
  81.         The example batch files assume the program is in C:\1LINERS.
  82.         The example batch files assume your BBS is in C:\BBS.
  83.         The example batch files assume text files are stored in C:\BBS\AFILES.
  84.         The example batch files assume you use "SHOW" and "SHOWTEN" as file
  85.             prefixes when running OLZRAND.
  86.  
  87.         1) Copy all files to their own directory, ie. C:\1LINERS.
  88.         2) Run OLZSETUP.EXE and configure the door file and the
  89.            configuration sections.  It is fairly well documented, so
  90.            I needn't go in to detail here.
  91.         3) Unarchive the file BATCH.ZIP to your BBS directory, then
  92.            edit the batch files to work on your system.  All batch
  93.            files begin with the three characters "ONE".  You should
  94.            have the following batch files (after you unarchive
  95.            BATCH.ZIP!) :
  96.  
  97.                 ONEADD.BAT   ■ This is run to add a OneLiner.
  98.                 ONEALL.BAT   ■ This is run to list ALL OneLiners.
  99.                 ONEASC.BAT   ■ Used to rotate ten (.ASC/.MSG) files.
  100.                 ONEAVT.BAT   ■ Used to rotate ten (.AVT) files.
  101.                 ONECHANG.BAT ■ This is used to change graphics modes.
  102.                 ONEDEL.BAT   ■ This is run to delete a OneLiner.
  103.                 ONEDELU.BAT  ■ This is used to delete a user from USERFILE.DAT
  104.                 ONEEDIT.BAT  ■ This is run to edit a OneLiner.
  105.                 ONELIST.BAT  ■ This is run to list one OneLiner.
  106.                 ONENEW.BAT   ■ This is used to do a newscan of OneLiners.
  107.                 ONEPACK.BAT  ■ This weeds out deleted OneLiners.  Put
  108.                                this in your night event.
  109.                 ONEPOINT.BAT ■ This is used to change pointer dates.
  110.                 ONERAND.BAT  ■ This is run to randomize to one file.
  111.                 ONESRCH.BAT  ■ This is used to do a "text" search.
  112.                 ONETEN.BAT   ■ This is run to randomize to ten files.
  113.                                You could run this everytime a user logs
  114.                                off, or in a night event.
  115.  
  116.         4) Copy the OLZ.MNU file to your menus directory and edit it
  117.            to work on your system.
  118.         5) Add the following commands to your main menu:
  119.  
  120.            1. Long Descript : (/O)neLinerZ! - Go to the OneLinerZ! menu
  121.            2. Short Descript: (/O)neLinerZ!
  122.            3. Menu Keys     : /O
  123.            4. ACS Required  : ""
  124.            5. CmdKeys       : -/
  125.            6. Options       : OLZ
  126.  
  127.         Renegade commands:
  128.         ──────────────────
  129.  
  130.            1. Long Descript : <this should be set to NULL>
  131.            2. Short Descript: <this should be set to NULL>
  132.            3. Menu Keys     : FIRSTCMD
  133.            4. ACS Required  : "!EV!EN"
  134.            5. CmdKeys       : -F
  135.            6. Options       : SHOWTEN
  136.  
  137.            1. Long Descript : <this should be set to NULL>
  138.            2. Short Descript: <this should be set to NULL>
  139.            3. Menu Keys     : FIRSTCMD
  140.            4. ACS Required  : "EV"
  141.            5. CmdKeys       : D-
  142.            6. Options       : oneavt.bat
  143.  
  144.            1. Long Descript : <this should be set to NULL>
  145.            2. Short Descript: <this should be set to NULL>
  146.            3. Menu Keys     : FIRSTCMD
  147.            4. ACS Required  : "EV"
  148.            5. CmdKeys       : -F
  149.            6. Options       : SHOWTEN.AVT
  150.  
  151.            1. Long Descript : <this should be set to NULL>
  152.            2. Short Descript: <this should be set to NULL>
  153.            3. Menu Keys     : FIRSTCMD
  154.            4. ACS Required  : "EN"
  155.            5. CmdKeys       : D-
  156.            6. Options       : oneasc.bat
  157.  
  158.            1. Long Descript : <this should be set to NULL>
  159.            2. Short Descript: <this should be set to NULL>
  160.            3. Menu Keys     : FIRSTCMD
  161.            4. ACS Required  : "EN"
  162.            5. CmdKeys       : -F
  163.            6. Options       : SHOWTEN.ASC
  164.  
  165.         Telegard commands:
  166.         ──────────────────
  167.  
  168.            1. Long Descript : <this should be set to NULL>
  169.            2. Short Descript: <this should be set to NULL>
  170.            3. Menu Keys     : FIRSTCMD
  171.            4. ACS Required  : "XA"
  172.            5. CmdKeys       : -F
  173.            6. Options       : SHOWTEN
  174.  
  175.            1. Long Descript : <this should be set to NULL>
  176.            2. Short Descript: <this should be set to NULL>
  177.            3. Menu Keys     : FIRSTCMD
  178.            4. ACS Required  : "XV"
  179.            5. CmdKeys       : D-
  180.            6. Options       : oneavt.bat
  181.  
  182.            1. Long Descript : <this should be set to NULL>
  183.            2. Short Descript: <this should be set to NULL>
  184.            3. Menu Keys     : FIRSTCMD
  185.            4. ACS Required  : "XV"
  186.            5. CmdKeys       : -F
  187.            6. Options       : SHOWTEN.AVT
  188.  
  189.            1. Long Descript : <this should be set to NULL>
  190.            2. Short Descript: <this should be set to NULL>
  191.            3. Menu Keys     : FIRSTCMD
  192.            4. ACS Required  : "!XV!XA"
  193.            5. CmdKeys       : D-
  194.            6. Options       : oneasc.bat
  195.  
  196.            1. Long Descript : <this should be set to NULL>
  197.            2. Short Descript: <this should be set to NULL>
  198.            3. Menu Keys     : FIRSTCMD
  199.            4. ACS Required  : "!XV!XA"
  200.            5. CmdKeys       : -F
  201.            6. Options       : SHOWTEN.ASC
  202.  
  203.  
  204.         Notice: You may add the above commands to any of the other menus
  205.                 where you want OneLinerZ! to randomly appear.
  206.  
  207.  
  208.         The above is a SUGGESTED setup for use with Renegade or Telegard.
  209.         The great thing about OneLinerZ! is that it is very flexible and
  210.         configurable due to it's "modular" nature (separate command line
  211.         parameters for separate functions, as opposed to a door with all
  212.         commands in a menu within in the door.)  If you want to
  213.         experiment with different setups, see the documentation below on
  214.         command line parameters.
  215.  
  216.  
  217.         Command Line Parameters for OLZ.EXE
  218.         ───────────────────────────────────
  219.  
  220.                 The format for using parameters with OLZ.EXE is as
  221.         follows: OLZ /R# -xx, where # is your node number, and "xx" is
  222.         one of the following parameters:
  223.  
  224.                -A  ■ Add a OneLiner.
  225.                -AL ■ List all OneLiners.
  226.                -C  ■ Change graphics mode.
  227.                -D  ■ Delete a OneLiner.  The SysOp can delete ANYONE's
  228.                      OneLiner.
  229.                -DU ■ Delete a user from USERFILE.DAT, the ACS for this
  230.                      command should be s255 or u1 for SysOp use only.
  231.                -E  ■ Edit a OneLiner.  The SysOp can edit ANYONE's
  232.                      OneLiner.
  233.                -L  ■ List one OneLiner.
  234.                -N  ■ Newscan the OneLiner data file.
  235.                -P  ■ Change pointer date.
  236.                -T  ■ Do a "text search" of the OneLiner data file.
  237.  
  238.                 Make sure that your DORINFO#.DEF file corresponds with
  239.         the node parameter that is passed to OLZ.EXE.
  240.  
  241.  
  242.         Command Line Parameters for OLZRAND.EXE
  243.         ───────────────────────────────────────
  244.  
  245.                 OLZRAND is used to randomize a OneLiner either to one
  246.         file, or to ten.  Let me first explain what randomizing to ten
  247.         means.  In the example setup, (Installation section), I suggest
  248.         adding a command to the main menu that will display the file
  249.         name "SHOWTEN".  This is why, OLZRAND will make ten files, such
  250.         as: SHOWTEN.ANS, SHOWTEN.AN1, SHOWTEN.AN2, etc, until "AN9".  If
  251.         you are a veteran SysOp with Renegade or Telegard, then you know
  252.         that if you tell the BBS to list a file with just the extension
  253.         it will randomly pick one of the ten.  "Why is this usefull?"
  254.         Well, there is a parameter that allows you to randomize ONE
  255.         OneLiner, but if you were to do this everytime at the main menu,
  256.         it would be SLOW.  Whereas, with the "randomize ten" option, and
  257.         with ANSI, you can have the BBS run the batch file ONETEN.BAT to
  258.         randomize ten everytime the user logs off, so they don't have to
  259.         deal with waiting at the main menu.  Other batch files are pro-
  260.         vided for AVATAR and ASCII users, that will rotate between ten
  261.         (.ASC/.MSG) or (.AVT) files.  You are most likely confused, I
  262.         am sorry.  The best thing to do is to just use the examples.
  263.  
  264.  
  265.                 Finally, the format for using parameters with
  266.         OLZRAND.EXE is as follows: OLZRAND +C/-C +O/-O [type] [filename]
  267.  
  268.         +C will add a carriage return after the OneLiner, -C won't.
  269.         +O will add the "OneLiner By" string, -O won't.
  270.  
  271.         [type] is one of the following commands:
  272.  
  273.                 -S ■ Randomize one OneLiner to one file.  (Actually, it
  274.                     will create three files, ie: SHOW.ANS, SHOW.MSG and
  275.                     SHOW.AVT)
  276.                 -R ■ Randomize ten OneLiners to ten separate files. See
  277.                     explanation above.
  278.  
  279.         [filename] is the **PREFIX** of the file you want to create.
  280.  
  281.         Note: Randomizing is slow because it creates ANSI, AVATAR and
  282.               ASCII files every time it is run, that is why it is best
  283.               to follow my example in the Install section of this DOC.
  284.  
  285.         Information on PACKER.EXE
  286.         ─────────────────────────
  287.  
  288.                 This should be run in a night event.  What this program
  289.         does is "weed out" deleted OneLiners.  "If they are deleted, why
  290.         do they need to be "re-deleted"?  Well, when you delete a
  291.         OneLiner, it is not physically removed from the file.  But, if
  292.         you were to add another OneLiner, it would over-write the
  293.         deleted one.  PACKER removes records PHYSICALLY ... so if you get
  294.         too many deleted records, and they are getting annoying, you can
  295.         just run this to get rid of them.
  296.  
  297.         Information on AUTODEL.EXE
  298.         ──────────────────────────
  299.  
  300.                 This program accepts ONE parameter, and that is the number
  301.         of days to check for.  Example: "AUTODEL 30" would delete all
  302.         OneLiners that are 30 or more days old.
  303.  
  304.         T.A.G. Users
  305.         ────────────
  306.  
  307.                 I *KNOW* that OneLinerZ! can be set up on TAG, but I am
  308.         simply not very familiar with the software.  I'm sure it's only a
  309.         matter of studying the RG/TG example menu, or reading about the
  310.         parameters.  I know of two BBSs local to me that have set it up on
  311.         TAG, but they don't have the time for DOC writing, sooooo... I'm
  312.         sorry!  It can be done, if you are an experienced SysOp.
  313.  
  314.  
  315.         In Conclusion
  316.         ─────────────
  317.  
  318.                 Thank you for using this program, I appreciate it greatly.
  319.         If you are having any problems setting up your copy of OneLinerZ!
  320.         then please feel free to call my BBS, AVERNUS, at 313.427.0224.
  321.         I will be happy to help you set it up, and to take suggestions for
  322.         improvements.  I can also be reached on ITCNet, in the Renegade
  323.         echo, or the utility echo.  Call my board for future versions and
  324.         future AvernusWare programs.
  325.  
  326.                 I would also like to thank Wish Giver, of The Three Wishes
  327.         BBS (313.522.2865), for helping me beta test this program.
  328.         I would also like to thank The Archon and Vangard.
  329.  
  330.         Dennis Alexander - aka LANKHMAR
  331.  
  332.