home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbsdoor / ansi330.zip / ANSIART.DOC < prev    next >
Text File  |  1994-12-03  |  10KB  |  279 lines
  1.                          ANSi Art Gallery version 3.30
  2.                                 Documentation
  3.                             Programmed by Roger Hu
  4.  
  5.  
  6. NOTE:   ANSi Art Gallery requires the ANSI.SYS device driver to be
  7.         installed. The program is not dependent on a FOSSIL driver.
  8.  
  9. If updating from a prior version of AAG, read AAGSETUP.DOC before running
  10. AAGSETUP.
  11.  
  12. If installling from scratch, follow the instructions listed in ANSIART.DOC.
  13.  
  14. ────────────────
  15.   Installation
  16. ────────────────
  17.  
  18. 1.   Make a new directory called ANSIART under your main BBS directory.
  19.  
  20. 2.   Unpackage ALL files into the ANSIART directory.  All files must be
  21.      present.  Consult FILES.AAG for complete file listing.
  22.  
  23. 3.   Run AAGSETUP.EXE.  Enter in all data before running conversion program.
  24.  
  25. 4.   Using your favorite text editor, load/create SYSOP.LST.  Enter all the
  26.      user names that will be able to access the Sysop Functions ('%' from
  27.      main menu).  If the user is not in the SYSOP.LST file, the [%][Sysop
  28.      Functions] will not be displayed and cannot be accessed.
  29.  
  30.         Sample SYSOP.LST: (Not case-sensitive)
  31.  
  32.         Roger Hu
  33.         Sysop
  34.  
  35.      Please note that many functions are disabled without registration.
  36.      Commands A-E which allow you to edit, delete, insert, and modify the
  37.      records are unavailable without registering.
  38.  
  39. 5.   This section is for REGISTERED USERS:
  40.  
  41.      Create a file called REGISTER.CFG.  Enter the registration name on the
  42.      first line, and the registration number on the next line.  Make sure
  43.      you type in the BBS name EXACTLY as it appears on the registration
  44.      form.  Ensure all spelling and capitalization is correct.
  45.  
  46.         Sample REGISTER.CFG:
  47.  
  48.         ANSi Art Gallery Registered
  49.         11111
  50.  
  51. 6.   ANSIART  <DoorInfoFile> [PORT:<ADDRESS>:<COM port>]
  52.  
  53.         Sample command line for use with a Door Info file
  54.            and standard COM port:
  55.  
  56.         ANSIART C:\BBS\PCBOARD.SYS
  57.  
  58.  
  59.         Sample command line for a non-standard COM port 3
  60.            at Hex address "03e8":
  61.  
  62.         ANSIART C:\BBS\PCBOARD.SYS PORT:03E8:3
  63.  
  64.  
  65.      ANSi Art Gallery, supports many BBS systems.  If the BBS system you
  66.      are using can support at least one of the following files, then ANSi
  67.      Art Gallery should work with:
  68.  
  69.         Door Information File                 BBS Software
  70.         ─────────────────────             ─────────────────────
  71.            DORINFOx.DEF                    RBBS, QBBS & others
  72.            DOOR.SYS                        Telegard, GAP, TAG
  73.            CALLINFO.BBS                    WildCat!
  74.            CHAIN.TXT                       WWIV
  75.            PCBOARD.SYS                     PCBoard
  76.  
  77.  
  78.                                   That's it!
  79.  
  80. ──────────────────
  81. New Storage Method
  82. ──────────────────
  83.  
  84. ANSi Art Gallery no longer renames the filenames of ANSi's to correspond
  85. with the number stored in the record.  Instead, from version 3.30 and above,
  86. all ANSi's will be stored in a separate directory, preserving the
  87. original filename.
  88.  
  89. When checking ANSI records for no description, AAG will check inside the art
  90. directory and compare it with ANSI.DAT to find which are missing.  This is why
  91. it especially important not to specify in AAGSETUP a directory that contains
  92. other files besides ANSi's.
  93.  
  94.  
  95. ─────────────────
  96.   FOSSIL Driver
  97. ─────────────────
  98.  
  99. If you would like to use a FOSSIL driver to speed up the program, or have a
  100. non-standard port with ANSi Art Gallery, the parameters are as follows:
  101.  
  102.      ANSIART <DoorInfoFile> [PORT:F:<COM port>]
  103.  
  104.         Sample command line to use a FOSSIL driver on COM1:
  105.  
  106.         ANSIART C:\BBS\PCBOARD.SYS PORT:F:1
  107.  
  108.  
  109. ─────────────
  110.   UART Chip
  111. ─────────────
  112.  
  113. Thanks to Rickie Belitz, ANSi Art Gallery will enable the 16550 or 16550A
  114. UART Chip if present.
  115.  
  116.  
  117. ────────
  118.   OS/2
  119. ────────
  120.  
  121. Although ANSi Art Gallery does not use 32-bit operations, ANSi Art Gallery
  122. should still work under OS/2.  This program has been tested and compiled
  123. under OS/2. Should problems arise, please contact the listed support
  124. sites.
  125.  
  126.  
  127. ──────────────
  128.   Sysop Keys
  129. ──────────────
  130.  
  131.            Function key         Action Performed
  132.            ────────────         ──────────────────────────────────────────
  133.              * F3               Toggle printer on/off
  134.              * F4               Toggle pagebell on/off
  135.                F5               Shell to DOS
  136.              * F7               Toggle caller alarm on/off
  137.                F8               Return user to system
  138.                F9               Toggle display on/off
  139.                F10              Chat mode  (use the ESCAPE key to exit)
  140.  
  141.            Alternate key        Action Performed
  142.            ────────────-        ──────────────────────────────────────────
  143.                ALT-H            Toggle between different status lines
  144.              * ALT-N            Toggle sysop on next
  145.              * ALT-X            Toggle exit to dos after call
  146.                                    and help lines
  147.  
  148.         Alternately pressing the ALT-H key will bring up the next status
  149.         line screen.  The 1st screen is a help screen, the second second
  150.         screen shows your COM port status.
  151.  
  152.     *  The function keys marked with an "*"  will only be of use to systems
  153.        using PCBOARD.SYS.  The rest are functional with any system.
  154.  
  155.  
  156. ──────────────
  157.   Protection
  158. ──────────────
  159.  
  160. I have attempted to add as much protection to your system as possible.
  161. Users may attempt to send files to a different directory while batch
  162. uploading. Using the "restrict" command in DSZ, I have minimized, if not
  163. eliminated, the possibility of users tampering with the BBS.  However, I
  164. offer no responsibility if a user somehow is able to harm the system.
  165.  
  166. When a user selects a "single file upload" protocol, the user is prompted
  167. to enter a filename.  This filename, to help prevent any hackers, is first
  168. split apart into directory, drive, filename, and extension.  The filename
  169. and extension are then put together, and the directory and drive are
  170. excluded. This is an extra security measure for sysops.  This also applies
  171. when a user attempts to view an ANSI file.
  172.  
  173.  
  174. ───────────────
  175.   Error Codes
  176. ───────────────
  177.  
  178. ANSi Art Gallery will return an Errorlevel and display an error message if
  179. something went wrong during execution.  Here are what they correspond to:
  180.  
  181.         Errorlevel     Meaning
  182.         ──────────     ──────────────────────────────────────────────
  183.             0          Successful execution
  184.             1          Unable to open BBS system file
  185.                           (PCBOARD.SYS, DOOR.SYS, etc.)
  186.             2          Problem reading BBS system file
  187.             3          Unrecognized BBS file type
  188.             4          Unable to open PCBOARD USERS file
  189.             5          Invalid User record or
  190.                           problem seeking to user record
  191.             6          Problem reading USER record
  192.             7          PORT command syntax error
  193.             8          FOSSIL driver specified but no FOSSIL driver
  194.                           installed
  195.             9          Memory allocation problem
  196.  
  197. If you still continue to have problems, contact one of the boards listed
  198. below for help.  Make sure you have the Errorlevel on-hand when you log in.
  199.  
  200.  
  201. Questions, Comments, or Suggestions can be answered by contacting the
  202. following boards listed below:
  203.  
  204. The Dark Side      (408)251-0357 14.4k Dual Std    Alpha Center I    TeleGard
  205.                                                          (FidoNet: 1:161/704)
  206. The Fast Tracks    (408)739-5781 14.4k Dual Std    Alpha Center II   Renegade
  207. Omega-One BBS      (601)287-1336 14.4k Courier HST Beta Center I     WildCat!
  208.  
  209. Please try to send mail through internet, FidoNet, or contacting the alpha
  210. centers before attempting to leave a message on Omega-One, since letters
  211. written to me on Omega-One may take some time to obtain a response from.
  212.  
  213. Letters can be directed to Roger Hu at:
  214. FidoNet: 1:161/704
  215. Internet: roger_hu@ftracks.jn.tsoft.net
  216.  
  217. The latest versions of ANSi Art Gallery may be downloaded from any of these
  218. support sites.
  219.  
  220.  
  221. ───────────
  222.   Credits
  223. ───────────
  224.  
  225. Original Programming by Stanley Hu
  226. Thanks go out to Marvin Lam for revising the documentation files.
  227. Programmed in Turbo C with modem routines by Rickie Belitz.
  228. This product uses the SPAWNO routines by Ralf Brown to minimize memory use
  229. while shelling to DOS and running other programs.
  230.  
  231. Turbo C is a registered trademark of Borland International, Inc.
  232. PCBoard is a registered trademark of Clark Development Company.
  233. WildCat! is a registered trademark of Mustang Software.
  234. SpitFire is a registered trademark of Buffallo Creek Software
  235. RBBS-PC is copyright(c) Tom Mack, Capital PC Software Exchange.
  236. QuickBBS is copyright(c) Adam Hudson.
  237. DSZ is a registered trademark of Omen Technology.
  238. OS/2 is a registered trademark of IBM Corporation.
  239.  
  240. You are running ANSi Art Gallery at your OWN RISK.  The authors of ANSi Art
  241. Gallery are not liable for any damages caused by this program.
  242.  
  243. No portion of this distribution package should be sold for any sort of
  244. profit nor may any portion be distributed with modification without the
  245. prior written consent of Roger Hu.
  246.  
  247. I strongly suggest using PKSFANSI(tm) by Phil Katz.  This program prevents
  248. keyboard reassignments (also known as ANSI bombs) from uploads by malicious
  249. users attempting to do harm to your system.
  250.  
  251.  
  252. ──────────────────
  253.   Modifications
  254. ──────────────────
  255.  
  256. Here are several modifications that may be in future releases:
  257.  
  258.         ■ Multi-node support
  259.  
  260.         ■ Chat mode will hopefully support word wrap and perhaps a two
  261.           way/color chat will be implemented.
  262.  
  263.         ■ Any commonly used BBS System not supported by ANSi Art Gallery.
  264.  
  265.         ■ Inter-BBS sharing of ANSi's.
  266.  
  267.         ■ Binary/text file checking.  At this point, no effort is taken to
  268.           insure an upload is text or a binary file.
  269.  
  270.  
  271. ───────────────
  272.   Definitions
  273. ───────────────
  274.  
  275. ANSi - A computer text file using the driver ANSI.SYS to display color
  276.        graphics and text.
  277.  
  278. AAG  - ANSi Art Gallery
  279.