home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / WSYS099.ZIP / WWIVSYS.DOC < prev    next >
Text File  |  1994-12-03  |  22KB  |  576 lines

  1. This documentation is partial. Full version will be released with v1.00
  2.  
  3. Table of Contents
  4. ═════════════════
  5.  
  6. 1. Introduction
  7. 2. Credits
  8. 3. Registration
  9. 4. Installation & Set Up
  10. 5. Functions
  11.    1.  Activity Log
  12.    2.  Auto Validation Keys
  13.    3.  BBS Informations
  14.    4.  Compress Subboards
  15.    5.  Dir Conference Editor
  16.    6.  Dir Editor
  17.    7.  Door Editor
  18.    8.  External Editors
  19.    9.  External Programs
  20.    10. File Editor
  21.    11. Gfiles Editor
  22.    12. Gfiles Section Editor
  23.    13. Instance Editor
  24.    14. Language Support
  25.    15. Modem Init
  26.    16. Network Information
  27.    17. Paths Editor
  28.    18. Protocols Editor
  29.    19. Security Level
  30.    20. SSM Manager
  31.    21. Statistics
  32.    22. String Editor
  33.    23. Sub Conference Editor
  34.    24. Sub Editor
  35.    25. Subs List Selector
  36.    26. Tetris
  37.    27. User Editor
  38.    28. Vote Editor
  39.    29. WWIV.INI Flags Editor
  40.    30. WWIV.INI Editor
  41.    31. WWIVsys Config
  42.    32. WWIVsys About
  43. 6. Troubleshooting
  44.  
  45.  
  46.  
  47. 1. Introduction
  48. ═══════════════
  49.  
  50. WWIVsys is a shareware utility designed to aid sysops running WWIV 4.23 and
  51. later versions.  Created in the fall of 1994, the idea was to make a utility
  52. for configuring WWIV that was easy to use and combined all the major sysop
  53. functions into one program.
  54.  
  55. These docs were written with the experienced WWIV sysop in mind.  It has been
  56. divided by each topic on the Setup Menu and gives a general description
  57. of each function.  Some of the items in the various functions are self-
  58. explanatory and may not have detailed descriptions.
  59.  
  60. With that, we in the WWIVsys development group wish you the best of luck, but
  61. remind you that even with all our hard work and testing, there MAY still be
  62. bugs in this program.  You should also know that we are not responsible for
  63. any damage this program causes, directly or indirectly.
  64.  
  65.  
  66. 2. Credits
  67. ══════════
  68.  
  69. WWIVsys was created by Dark Shadow and Spotnick, both Sysops at Alternative
  70. Worlds and French Mod Division HQ in Montreal, Canada. Tarkan, Sysop of the
  71. Fire Station, in Keizer, Oregon, USA, is the author of the documentation.
  72.  
  73.  
  74.                    Thanks To...
  75.   
  76.             Thanks  are  in order to the following individuals for their
  77.             unique contributions to this project:
  78.   
  79.             - Wayne Bell for doing the wonderful WWIV Software.
  80.             - Wig De Moville for help and taking care of WSS.
  81.             - Micheal Deweese for his INI handleing routines and ideas.
  82.             - Eric Lapperière, Micheal Deweese, Craig Dooley, Chris Gauthier,
  83.               Alex Buchanan, Lewis Wolk, and Andy Stewart for their
  84.               devotion and great help as the official WWIVsys
  85.               Beta Testers.
  86.   
  87.  
  88.                   Trademarks
  89.   
  90.           WWIVsys is a trademark of FMD Softwares.
  91.   
  92.           IBM is  a  registered  trademark  of  International Business
  93.           Machines Corporation.
  94.   
  95.           MS-DOS is a registered trademark of Microsoft Corporation.
  96.   
  97.           Borland C++ is a registered trademark of Borland International.
  98.   
  99.           Other brand and product names are trademarks  or  registered
  100.           trademarks of their respective holders.
  101.   
  102.                 Technical Informations.
  103.   
  104.                 - WWIVsys is compiled with Borland C++ v3.1
  105.                 - WWIVsys has been tested with WWIV v4.23 and v4.24
  106.                 - You must run ONE instance only to use WWIVsys.
  107.                 - WWIVsys works well with multi-tasker.
  108.   
  109.   
  110.                 Hardware Requirements
  111.   
  112.                 - An IBM PC, AT, ix86, PS/2 or 100% IBM BIOS compatible PC
  113.                 - A hard disk with at least 300k of disk space available
  114.                 - A color monitor (RGB or VGA) would be better. Works with all
  115.   
  116.                 Software requirements
  117.  
  118.                 - Microsoft or IBM PC DOS v3.0 or above
  119.                 - WWIV BBS v4.23 or above
  120.  
  121.  
  122.  
  123. 3. Registration / License
  124. ═════════════════════════
  125.  
  126.        This  document  is  Copyright  (C)  1994-1995  by FMD Softwares.
  127.        All rights are reserved.
  128.  
  129.        The computer software program  WWIVsys (TM) is Copyright (C)  1994-1995
  130.        by FMD Softwares.  All rights are reserved.   WWIVsys is a registered
  131.        trademark of FMD Softwares. Other  brand  and product names are
  132.        trademarks or registered trademarks of their respective holders.
  133.  
  134.  
  135.                              LICENSE
  136.  
  137.  
  138.    WWIVsys is  not a  Public Domain  program and is not free.  WWIVsys is
  139.    copyright (C) 1994-1995 by FMD Softwares.
  140.   
  141.    Non-registered users of this  program are  granted a  limited  one-month
  142.    license  to  WWIVsys  to  evaluate  the programs suitability for their
  143.    requirements.  Any usage of WWIVsys beyond the  evaluation time period
  144.    requires registration  of each copy of the program used.   Use of non-
  145.    registered copies of WWIVsys beyond the original evaluation  period  is
  146.    prohibited.
  147.  
  148.    WWIVsys may  NOT be modified in any respect, for any reason,  including
  149.    but  not  limited   to,   de-compiling,   disassembling,   or   reverse
  150.    engineering of  the program.   The opening title screen, help  screens,
  151.    and all  other  proprietary  program  output  must  never  be altered,
  152.    removed, bypassed or modified by any means.
  153.   
  154.    You are free to distribute the PUBLICLY AVAILABLE shareware version of
  155.    WWIVsys to others subject  to  the  above  restrictions  and  also  the
  156.    following:
  157.   
  158.     A.   No fee is charged for its use.
  159.  
  160.     B.   No renumeration  may be  accepted for  WWIVsys.  This does   not
  161.          apply to computer access charges the system operators (Sysops)
  162.          of  or  organizations  owning  bulletin  board systems, online
  163.          services, etc... may charge subscribers.
  164.   
  165.     C.   WWIVsys must be copied in unaltered form, complete  with files
  166.          containing  license  information,  the  FULL documentation and
  167.          all  accompanying   files.      The   self-extracting   archive
  168.          distributed by FMD Softwares must not be altered in ANY respect.
  169.   
  170.     D.   All shareware  houses/distribution firms  must make  explicitly
  171.          clear that  the  diskette  purchase  containing  any shareware
  172.          program has NOT registered the shareware with FMD Softwares.
  173.   
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.      System Operators  may make  WWIVsys available for download only if the
  183.      above conditions are met.  The  archive (WSYS099.ZIP) distributed by
  184.      FMD Softwares or an equivalent archive  may  be  made  available only in
  185.      complete form.   Refer to section  FILE  LISTING  to  verify  complete
  186.      package contents. If the contents appear altered or not complete, you
  187.      may obtain the latest release  of  WWIVsys  directly  from
  188.      FMD Softwares by sending a  formatted diskette labeled with the word
  189.      "WWIVSYS".  Please include $5 for handling.
  190.   
  191.      An alternate means of obtains the latest shareware  archive is calling
  192.      the Bulletin Board System listed in the section Support Sites lower in
  193.      the documentation. All those systems should have the latest copy on-line.
  194.   
  195.      Commercial distributors of "Public  Domain", "Shareware",  and/or User
  196.      Supported  software  may  distribute  WWIVsys  subject  to  the above
  197.      conditions  only  after  obtaining  WRITTEN  permission  from
  198.      FMD Softwares. This  condition  statement supersedes all previous agreements.
  199.   
  200.      Please refer to the section entitled registration/ordering section for
  201.      additional information  on registration,  corporate site-licensing and
  202.      related topics.
  203.   
  204.      The above license statement does not  apply to  the REGISTERED version
  205.      of WWIVsys.   The  registered software of FMD Softwares is protected  under
  206.      Canada and International Copyright and Trademark  Laws. It must be
  207.      treated just like a book with certain exceptions as follows:
  208.   
  209.      A. FMD Softwares authorizes  the
  210.         making of archival copies  of  the  registered  software  for  the
  211.         sole   purpose of backing-up  your  software  and  protecting  your
  212.         investment from possible loss.
  213.   
  214.      B. The  medium  on  which  the  registered  software  is  recorded is
  215.         transferred to the customer, but not the title to the software.
  216.   
  217.      C. The  customer  may  resell  or  distribute unmodified copies of the
  218.         registered  software  provided  the  customer  has  purchased from
  219.         FMD Softwares one copy  of the registered software for each one sold or
  220.         distributed.  The  provisions of  this software license shall also
  221.         be applicable to third parties receiving copies of the registered
  222.         software from the customer.
  223.   
  224.     D. By saying, "just like a book", FMD Softwares means that the registered
  225.        software  may be used by any number of people and may be freely moved
  226.        from one computer location to another so long as there is ABSOLUTELY
  227.        NO POSSIBILITY of it being used at one location while being used at
  228.        another.  Just like a book that cannot be read by two different people
  229.        in two different locations at the same time.
  230.  
  231.  
  232.                              SITE LICENSE
  233.  
  234.  
  235.    If you  plan on using WWIVsys in a corporate, government office, or in
  236.    any business environment  whatsoever,  registration  is  mandatory and
  237.    the two  week limited  license is  strictly enforced.  For such users,
  238.    quantity discounts are available under a Site License agreement.
  239.  
  240.    The site license  (corporate  and  governmental)  is  for  use  of the
  241.    software  within  your  company  or  government  agency,  and  is  not
  242.    transferable.  This allows  internal use  and copying  of the software
  243.    for as  many sites  / computers  as contracted for.  An unlimited Site
  244.    License allows unlimited copying of the  software for  internal use by
  245.    your  company  or  government  agency.   Distributing, repackaging, or
  246.    reselling of the software  to  third  parties  is  not  allowed.   All
  247.    licenses are prepaid.
  248.  
  249.    One MASTER  copy of  WWIVsys (with  documentation) will be provided on
  250.    diskette.   The site is responsible for printing the documentation and
  251.    copying the  diskettes for distribution.  Additional master copies may
  252.    be purchased from FMD Softwares for $5.00 per diskette.
  253.  
  254.    With all site licenses, the site will supply  one contact  person with
  255.    which all correspondence will be made.  If a problem should occur, the
  256.    contact person will call and make  arrangements to  get a  fix for the
  257.    glitch.   Updates to  WWIVsys will be forwarded to the contact person.
  258.    When filling out the order form, use the contact persons name to avoid
  259.    confusion at a later date.
  260.  
  261.    Following is the current site license discount rates:
  262.  
  263.                   TOTAL COPIES    DISCOUNT     UNIT COST
  264.                       1 - 4         none        $30.00
  265.                       5 - 10         10%        $27.00
  266.                      11 - 20         20%        $24.00
  267.                      21 - 30         30%        $21.00
  268.                      31 - 50         40%        $18.00
  269.                      51 - 100        50%        $15.00
  270.                      101+            60%        $12.00
  271.  
  272.    An unlimited site license may be purchased for $2500.00
  273.  
  274.    NOTE:   All discounts and prices are subject to change without notice.
  275.    Also note that discounts are  not  cumulative  and  apply  to separate
  276.    orders only.
  277.  
  278.    Please write  if you wish to obtain a site license.  A printed copy of
  279.    the license  will be  mailed for  you to  fill out,  sign, and return.
  280.    Once the  order has  been approved, a copy if the license signed by an
  281.    authorized FMD Softwares representative will be shipped along with the
  282.    master diskette.
  283.  
  284.                              WARRANTY
  285.   
  286.   
  287.    WWIVsys and accompanying files are provided AS IS without any
  288.    warranty, expressed or implied.  This includes without limitation the
  289.    fitfulness for a particular purpose or application and any warranties
  290.    of merchantability.
  291.   
  292.    While we tried to  be as  thorough as  possible in  preparing WWIVsys,
  293.    FMD Softwares shall not be liable for any damages, whether direct, indirect,
  294.    special, incidental or consequential arising from a failure of this
  295.    program or accompanying files to operate in a manner desired by the user.
  296.    FMD Softwares shall not be liable for any damage to data or property which
  297.    may by caused directly or indirectly by use of this program.
  298.   
  299.    In no event will FMD Softwares be liable to you for any damages, including
  300.    any lost profits, lost savings or other incidental or consequential damages
  301.    arising out of your use or inability to use the program, or for any claim
  302.    by any other party. Individuals using the software bear all risk as to its
  303.    quality and performance.
  304.  
  305.  
  306. Since this is shareware, duplication is permitted so long as all files are in
  307. the original .ZIP form, and the files are -AV (Authentic Verified) to FMD
  308. Softwares.
  309.  
  310. The -AV number is:
  311.  
  312.                 Authentic files Verified!   # NWC217
  313.                 French Mod Division Softwares
  314.  
  315. Registration for WWIVsys is $30 Canadian and $30 US.  Print out the
  316. REGISTER.FRM and fill it out. Then mail it to:
  317.  
  318.                         Martin Bourdages
  319.                         1545 de Val-Jalbert
  320.                         Laval, QC, Canada
  321.                         H7E 3S7
  322.  
  323.                 Checks should be sent to the name of Martin Bourdages.
  324.  
  325.  
  326. 4. Installation and Setup
  327. ═════════════════════════
  328.  
  329. Installing WWIVsys is a snap.  All that is required is to unzip or copy
  330. WWIVsys into the main BBS directory (ie. C:\WWIV).
  331.  
  332. NOTE: If you are setting a WWIV bbs for the first time and have not run the
  333. INIT.EXE that comes with WWIV, then you need to do so before running WWIVsys.
  334. It creates the necessary files for WWIVsys to run as well as the rest of the
  335. BBS.
  336.  
  337. After unzipping the WWIVsys files or copying them to the main BBS
  338. directory, run SYS.EXE and have at it!
  339.  
  340.  
  341. 5. Functions
  342. ════════════
  343.  
  344. All functions use the same basic command set:
  345.     <Return> edits the currently selected item.
  346.     <Space Bar> moves the currently selected item to a new location.
  347.     <Insert> inserts a new item at the current position.
  348.     <Delete> will delete the item at the current position.
  349.     Arrow Keys move up/down the menus and the editing fields.
  350.     Tab moves forward only among the editor fields.
  351.  
  352.  
  353. 5.1   Activity Log
  354. ──────────────────
  355.         The Activity Log graphically shows usage of your system. Use the
  356.         arrow keys to move up/down among the days.
  357.  
  358.  
  359. 5.2   Auto Validation Keys
  360. ──────────────────────────
  361.         Set these for desired user-configurations and press that
  362.         Alt-Fn combination to select it.  Arrow keys also work to move
  363.         between the configurations.
  364.  
  365.  
  366. 5.3   BBS Informations
  367. ──────────────────────
  368.         This is the same information as found in the WWIV INIT.EXE
  369.         program, menu choice #1.  Here is the System name, Sysop name,
  370.         System password, Newuser setup, and a few other toggles.
  371.  
  372.  
  373. 5.4   Dir Conference Editor
  374. ───────────────────────────
  375.         This is the Conference Editor for the Download/Transfer area.
  376.         Select the conference you want to edit and press <Return> (aka
  377.         <Enter>).  Pressing <Return> will allow you to edit the current
  378.         conference's attributes.  Pressing the <Space Bar> will highlight
  379.         the current conference so it can be moved. Press the <Space Bar>
  380.         again to move the conference to the current location.  <Insert>
  381.         will insert a new conference at the current location of the
  382.         selection bar.  The arrow keys move the selectin bar up/down.
  383.         <Delete> will delete the conference, but *NOT* any of the Files
  384.         or Directories that were in it. If there are directories in the
  385.         conference that were not in any other than the one just deleted,
  386.         you must include them in a conference.
  387.  
  388.  
  389. 5.5   Dir Editor
  390. ────────────────
  391.  
  392.         This is the editor for the Download Directories.
  393.         Use the arrow keys to move to the desired dir.  Press the <Space
  394.         Bar> to tag it for moving and then press the <Space Bar> again
  395.         to move the dir to the current location.  Pressing <Return> will
  396.         allow you to edit the current directory's attributes.  <Insert>
  397.         will insert a new directory at the currect location of the
  398.         selection bar.  <Delete> will delete the current directory from
  399.         WWIV, but *NOT* the files in that directory.
  400.  
  401.  
  402. 5.6   Door Editor
  403. ─────────────────
  404.         This is also known as the Chain Editor, and allows you to edit
  405.         your online programs in the chains ares.
  406.         <Space Bar> tags doors for moving, and the arrow keys move
  407.         between the doors.  Editing the door's attributes is
  408.         accomplished by pressing the <Return> key.  <Insert> will insert
  409.         a new Door at the current location.  <Delete> will delete the
  410.         door under the selection bar.
  411.  
  412.  
  413. 5.7   External Editors
  414. ──────────────────────
  415.         This is where you can modify your Full-Screen Editor configuration.
  416.         <Return> edits the current Full-Screen Editor's attributes,
  417.         while <Insert> and <Delete> will insert or delete a Full-Screen
  418.         Editor. <Space Bar> will move the Editor.
  419.  
  420.  
  421. 5.8   External Programs
  422. ───────────────────────
  423.         This section is the same as WWIV INIT.EXE's menu choice #6, and
  424.         has the external programs/events to be run.  This command uses
  425.         the same basic commands as desribed in the beginning of this
  426.         Chapter, except that the <Space Bar> toggles between the various
  427.         archive formats at the bottom.
  428.  
  429.  
  430. 5.9   File Editor
  431. ─────────────────
  432.  
  433.         Here is where you can edit attributes to the files on your bbs,
  434.         like who uploaded, when, who "owns" the file, and where it is
  435.         located (what directory).  First, you must select the Directory
  436.         the file is in, and then you need to select the file.  <Return> at
  437.         both places accomplishes this.  The other standard commands also
  438.         apply.
  439.  
  440.  
  441. 5.10  Gfiles Editor
  442. ───────────────────
  443.         Lets you add/remove gfiles to the Gfiles area you select.  This
  444.         is NOT the same as the //GE command as in WWIV.  That is the
  445.         next function down.  Moving gfiles is not supported at this
  446.         time.
  447.  
  448.  
  449. 5.11  Gfiles Section Editor
  450. ───────────────────────────
  451.         Lets you add or remove Gfiles sections, like in the WWIV //GE
  452.         function.  Moving the gfiles sections is allowed.
  453.  
  454.  
  455. 5.12  Instance Editor
  456. ─────────────────────
  457.         Edit the com port setup for each instance here.  Use the left
  458.         and right arrow keys to move up/down among the instances.
  459.  
  460.  
  461. 5.13  Language Support
  462. ──────────────────────
  463.         
  464.  
  465. 5.14  Modem Init
  466. ────────────────
  467.         This allows you to edit the MODEMS.DAT file or the MODEMS.002
  468.         (the MODEMS.DAT file for instance 2) for your configuration.
  469.         Note:  { will send a <CR> after the string and is required.
  470.                ~ will insert a ½-second pause between commands.
  471.  
  472.  
  473. 5.15  Network Information
  474. ────────────────────────
  475.         This command is the same as the INIT.EXE's 'N'etworks command.
  476.         Here you are allowed to edit the node #, the network name, and
  477.         its directory.
  478.  
  479.  
  480. 5.16  Paths Editor
  481. ─────────────────
  482.         Edit the paths for the BBS here.  Be aware that the TEMP and the
  483.         BATCH directories are only edited for instance 1!  To edit those
  484.         for each instance, use the Instance Editor function.
  485.  
  486.  
  487. 5.17  Protocols Editor
  488. ─────────────────────
  489.         Add/Delete any external transfer protocols here.  WWIVsys has a
  490.         special function that will allow you to select the particular
  491.         protocol you want and it will automatically install it for you.
  492.         To use this feature, press F9.
  493.  
  494.  
  495. 5.18  Security Level
  496. ───────────────────
  497.         Set up your configurations for each security level here.  Each
  498.         level is independent of the other.  Many sysops use a simple
  499.         2-tier system they only have validated and unvalidated users.
  500.         Note that your new users will have be assigned the SL that is
  501.         set in the BBS Informations, and that you should make sure that
  502.         SL is configured to your needs or desires.
  503.  
  504.  
  505. 5.19  SSM Manager
  506. ────────────────
  507.         From this screen, you can editor delete current SSM's in the
  508.         file, or you can add an SSM to be sent. <Insert> sends an SSM,
  509.         while <Delete> deletes it.  <Return> edits the SSM.
  510.         
  511.  
  512. 5.20  Statistics
  513. ───────────────
  514.  
  515.  
  516. 5.21  String Editor
  517. ──────────────────
  518.  
  519.  
  520. 5.22  Sub Conference Editor
  521. ──────────────────────────
  522.  
  523.  
  524. 5.23  Sub Editor
  525. ───────────────
  526.  
  527.  
  528. 5.24  Sub List Selector
  529. ──────────────────────
  530.  
  531.  
  532. 5.25  Tetris
  533. ───────────
  534.  
  535.  
  536. 5.26  User Editor
  537. ────────────────
  538.  
  539.  
  540. 5.27  Vote Editor
  541. ────────────────
  542.         Add, remove, or edit voting questions from this function.  Take
  543.         note that questions must be inserted at the end of the
  544.         questions.
  545.  
  546.  
  547. 5.28  WWIV.INI Flags Editor
  548. ──────────────────────────
  549.  
  550.  
  551. 5.29  WWIV.INI Editor
  552. ────────────────────
  553.  
  554.  
  555. 5.30  WWIVsys Config
  556. ───────────────────
  557.  
  558.  
  559. 5.31  WWIVsys About
  560. ──────────────────
  561.         This screen tells who we are, and what this program is!
  562.  
  563.  
  564.  
  565. 6. TroubleShooting
  566. ══════════════════
  567.  
  568.    If you have a problem with  WWIVsys please feel free to write and
  569.    describe the situation. Registered users, please include the serial
  570.    number found on your diskette.
  571.   
  572.    To those people who have registered (with  diskette), the physical
  573.    diskette is warranted against defects in materials and workmanship for
  574.    a period of 60 days from date of shipment by FMD Softwares. Any returned
  575.    disks found damaged or bad will be replaced at no charge.
  576.