home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / afanv182.zip / AfanInfo.Doc < prev    next >
Text File  |  1996-05-01  |  19KB  |  451 lines
  1.  
  2.   ────────────────────────────────────────────────────────────────────────────
  3.   ▒▒▒ AFAN v1.82 - Advanced File Area Navigator - (c) 1996  by CliP-Soft  ▒▒▒▒
  4.   ────────────────────────────────────────────────────────────────────────────
  5.  
  6.     1 ■ What is AFAN?
  7.     2 ■ When do you need AFAN?
  8.     3 ■ What options does AFAN offers?
  9.     4 ■ How do to register AFAN?
  10.     5 ■ How to contact CliP-Soft?
  11.     6 ■ Where to download the latest AFAN?
  12.     7 ■ Disclaimer
  13.     8 ■ How to install AFAN?
  14.     9 ■ Example AFAN.CFG and description
  15.    10 ■ Which files and directory's are used by AFAN?
  16.  
  17.  
  18.  
  19.   ────────────────────────────────────────────────────────────────────────────
  20.   ▒▒▒  1.  - What is AFAN?                                                ▒▒▒▒
  21.   ────────────────────────────────────────────────────────────────────────────
  22.  
  23.    AFAN stands for A)dvanced F)ile A)rea N)avigator.
  24.  
  25.    With AFAN you can create File Groups in AdeptXBBS. The File Group option
  26.    is not standard available in AdeptXBBS so thats why AFAN is made.
  27.  
  28.    Afan v1.80 is a total rewrite, so please read the Whats.New also if you
  29.    want to upgrade your previous release to v1.82.
  30.  
  31.  
  32.  
  33.   ────────────────────────────────────────────────────────────────────────────
  34.   ▒▒▒  2.  - When do you need AFAN?                                       ▒▒▒▒
  35.   ────────────────────────────────────────────────────────────────────────────
  36.  
  37.    Well that's easy to answer:  You don't need Afan when you have only a few
  38.    file areas, but if you have a lot of file areas and want to create File
  39.    Groups (with a mimimum of time to configure) then Afan is the *ULTIMATE*
  40.    sollution, it offers extended configuration options, is very flexible and
  41.    works at High Speed,  besides that it's very Sysop and BBS User Friendly!
  42.  
  43.  
  44.  
  45.   ────────────────────────────────────────────────────────────────────────────
  46.   ▒▒▒  3.  - What options does AFAN offers?                               ▒▒▒▒
  47.   ────────────────────────────────────────────────────────────────────────────
  48.  
  49.    AFAN uses several security methods to controls the access to File Groups:
  50.  
  51.    - 1) File Group access by minimum age.
  52.    - 2) File Group access by security level 1.
  53.    - 3) File Group access by security level 2.
  54.    - 4) File Group access by a combination of the above 3 options.
  55.  
  56.    - Detection and support for ASCII, ANSI, and AVATAR Terminal Emulation.
  57.  
  58.    - Automatic detection of the users screen lenght, every screen lenght is
  59.      supported.
  60.  
  61.    - On the fly extraction of the the file areaname and areadescription from
  62.      the AdeptXBBS Configuration while displaying the filearea list.
  63.  
  64.    - AFAN is usable for single and multi-line AdeptSBBS systems.
  65.  
  66.    - Almost everything like prompts, color and external screens are sysop
  67.      configurable.
  68.  
  69.    - Saves the last accessed file area in the userrecord.
  70.  
  71.    - Saves the last accessed file group in an external control file.
  72.  
  73.    - Extended logging options: 1) recent event window
  74.                                2) logfile
  75.                                3) recent event window and logfile
  76.  
  77.    - Option to turn logging Off or On.
  78.  
  79.    - Option to go directly into the filelist after user selected an file area.
  80.  
  81.    - Option to turn on default group for first time users.
  82.  
  83.    - Shows a screen when the security don't allows the user to select a file
  84.      group.
  85.      
  86.    - Support for up to 26 file groups (A-Z).
  87.  
  88.    - When user selected a File Group that doesn't exist or isn't activated
  89.      AFAN shows a screen and returns to the 'Select Group menu'.
  90.  
  91.    - AFAN doesn't show the File Area in the File Arealist when a user
  92.      doesn't have access to the file area.
  93.  
  94.    - Supports up to 99.999 file areas (could be extended if needed).
  95.  
  96.  
  97.  
  98.   ────────────────────────────────────────────────────────────────────────────
  99.   ▒▒▒  4.  - How to register AFAN?                                        ▒▒▒▒
  100.   ────────────────────────────────────────────────────────────────────────────
  101.  
  102.    This version of Afan is currently still *FreeWare*! There is no need to
  103.    register, however you could do me a big favour to send me your comments on
  104.    this program, what you (dis)like about the program, suggestions for future
  105.    options etc.
  106.    
  107.  
  108.  
  109.   ────────────────────────────────────────────────────────────────────────────
  110.   ▒▒▒  5.  - How to contact CliP-Soft?                                    ▒▒▒▒
  111.   ────────────────────────────────────────────────────────────────────────────
  112.  
  113.    Via netmail to : Koen Koster
  114.                     2:281/602.0@FidoNet
  115.                     55:66/0.0@AdeptNet
  116.  
  117.    Via ClipArT BBS: 31-172-439373 or 31-172-410373
  118.  
  119.    Internet       : E-mail to kkoster@cistron.nl
  120.                   : IRC channel #adept (Look for CliP)
  121.    
  122.    Fidonet Areas  : Adeptsoft
  123.                     Adept_Sysop
  124.                     OS2BBS
  125.  
  126.    and the AdeptNet Echomail areas (however Fidonet areas are preferred).
  127.  
  128.  
  129.  
  130.   ────────────────────────────────────────────────────────────────────────────
  131.   ▒▒▒  6.  - Where to download the latest AFAN version?                   ▒▒▒▒
  132.   ────────────────────────────────────────────────────────────────────────────
  133.    
  134.    The latest version of AFAN is downloadable at the Clip-Soft's SupportBBS:
  135.  
  136.    ClipArT BBS: - node#1 31-172-439373
  137.                   node#2 31-172-410373
  138.  
  139.    FileRequest  AFAN   for the latest public version
  140.    FileRequest  AFANB  for the latest beta version
  141.    FileRequest  MAGIC  for a list with magic filenames
  142.  
  143.    Internet FTP:  ftp.adeptsoft.com
  144.                   hobbes.nmsu.edu
  145.                   ftp.leo.org
  146.                   juge.com
  147.  
  148.  
  149.  
  150.   ────────────────────────────────────────────────────────────────────────────
  151.   ▒▒▒  7.  - Disclaimer                                                   ▒▒▒▒
  152.   ────────────────────────────────────────────────────────────────────────────
  153.  
  154.    Although every care and attention has been taken to write and test the
  155.    program to make sure that it does what this documentation states, the
  156.    program is provided as it is, without warranty or guarantee of any kind,
  157.    either expressed or implied, as to the quality or performance of this
  158.    program, except that it will occupy disk space.
  159.  
  160.    The author shall not be held liable to you or anyone else for any direct,
  161.    indirect, incidental or consequential damages, including any lost profits,
  162.    lost savings, lost business, which may result from the use or inability
  163.    to use this program. Your use of this program constitutes your agreement
  164.    to this disclaimer and your release of the author from any form of
  165.    liability or litigation.
  166.  
  167.  
  168.  
  169.   ────────────────────────────────────────────────────────────────────────────
  170.   ▒▒▒  8.  - How to install AFAN?                                         ▒▒▒▒
  171.   ────────────────────────────────────────────────────────────────────────────
  172.  
  173.    Make the directory's:  \Adept\Afan
  174.                           \Adept\Afan\Text
  175.                           \Adept\Afan\Groups
  176.                           \Adept\Afan\UserInfo
  177.  
  178.    Then unzip Afanv180.zip in the directory '\Adept\Afan'
  179.    Then unzip the 'example' Text.Zip in the directory '\Adept\Afan\Text'
  180.    and read this whole textfile to understand how Afan works and how to
  181.    setup this program (especially the TIP section).
  182.  
  183.    Edit your Files.Menu and add the next entry's:
  184.  
  185.    G ,10  ,Change Group            ,D:\adept\Afan\AfanG.Erx,0
  186.    A ,10  ,Change Area in Group    ,D:\adept\Afan\AfanA.Erx,0
  187.  
  188.    Description of this menu entry (for more MenuEntry info read ADPTXBBS.DOC)
  189.    --------------------------------------------------------------------------
  190.    A ,10  ,Change Area             ,D:\adept\Afan\AfanA.Erx,0
  191.    |  |    |                        |
  192.    |  |    Comment                  Change this to the correct drive
  193.    |  Menutype
  194.    |
  195.    [A] is the Key to start AfanA.Erx
  196.  
  197.    For every single File Group there's a control file needed with in that
  198.    file the areas you want to list in.
  199.  
  200.    The control files are named FgroupA.Asc - FgroupZ.Asc and located in the
  201.    directory \Adept\Afan\Groups
  202.  
  203.    So here's a example, when you want to make a File Group named Sound, OS/2
  204.    and a group AdeptXBBS you have to make 3 control files:
  205.  
  206.    FgroupS.Asc for the Sound Group
  207.    FgroupO.Asc for the OS/2 Group
  208.    FgroupX.Asc for the AdeptXBBS Group
  209.  
  210.    Edit your Fgroup.Ans in \Adept\Afan\Text so that,
  211.  
  212.    The Sound File Group is listed with the startup key 'S'
  213.    The OS/2 File Group is listed with the startup key 'O'
  214.    The AdeptXBBS File Group is listed with the startup key 'X'
  215.  
  216.    In this example the Sound File Areas numbers are listed 100-110
  217.  
  218.    Then edit the FgroupS.asc file in \Adept\Afan\Groups so that it has the
  219.    Sound fileareanumbers in it.. all numbers has to be under eachother
  220.    like this:
  221.    100
  222.    101
  223.    102
  224.    103
  225.    104
  226.    105
  227.    106
  228.    107
  229.    108
  230.    109
  231.    110
  232.  
  233.    The File Area numbers for the OS/2 File Group in this example are,
  234.    1, 2, 10, 203, 405, so the contents of FgroupO.asc contents would be:
  235.    1
  236.    2
  237.    10
  238.    203
  239.    405
  240.  
  241.    The File Area numbers for the AdeptXBBS File Group in this example are
  242.    400-405 so the contents of the FgroupX.asc would be:
  243.    400
  244.    401
  245.    402
  246.    403
  247.    404
  248.    405
  249.    
  250.    Normaly it would be a lot of work to type in all these file Area numbers,
  251.    that why an util is included F-Areas.Cmd. This util makes a list with all
  252.    File Areas on your system, to let you easy make the File Group List ! :)
  253.  
  254.    Included in that list are the File Area numbers and descriptions, so all
  255.    you have to do is, start a good text editor (like QEdit or something) and
  256.    select the file areas you want to have in one group and save the block to
  257.    the correct Fgroup?.Asc filename. Remember only the file area numbers are
  258.    used by Afan, you can have the File area description in the Fgroup?.Asc
  259.    file because only the first 5 characters on each line are used by Afan.
  260.  
  261.    (TIP 1.) Use the file that F-Areas.Cmd created as the group the shows all
  262.    File Areas on your system (group called 'All File Areas' or something).
  263.  
  264.    (TIP 2.) Use the Sample.Cfg to setup your File Groups
  265.  
  266.    (TIP 3.) Use the screens in Text.Zip to get the idea how the external
  267.    screens could look like :)
  268.  
  269.  
  270.  
  271.   ────────────────────────────────────────────────────────────────────────────
  272.   ▒▒▒  9.  - Example AFAN.CFG and description                             ▒▒▒▒
  273.   ────────────────────────────────────────────────────────────────────────────
  274.  
  275.    Here is an example Afan.Cfg configuration file (notice: in this file there
  276.    are linenumbers used, the original Afan.Cfg does not use linenumbers).
  277.  
  278.    01  # ------------------  AFAN v1.82 (c) 1996 CliP-Soft ----------------- #
  279.    02  #                                                                     #
  280.    03  #          On/Off - Digits - Min.age - Sec1 - Sec2 - Group Name       #
  281.    04  # ------------------------------------------------------------------- #
  282.    05  FileGroupA 1        3        12        10     10     All Areas
  283.    06  FileGroupB 1 3 12 10 10   BBS Software
  284.    07  FileGroupC 1 3 12 10 10   Communicatie
  285.    08  FileGroupD 0
  286.    09  FileGroupE 0
  287.    10  FileGroupF 0 3 12 10 10   FAQ & TextFiles
  288.    11  FileGroupG 1 3 12 10 10   Graphics
  289.    12  FileGroupH 0
  290.    13  FileGroupI 0 3 12 10 10   InterNet
  291.    14  FileGroupJ 0
  292.    15  FileGroupK 1 3 12 10 10   Simtel I
  293.    16  FileGroupL 1 3 12 10 10   Simtel II
  294.    17  FileGroupM 0 3 12 10 10   MufoNet
  295.    18  FileGroupN 0
  296.    19  FileGroupO 0 3 12 10 10   OS/2 Areas
  297.    20  FileGroupP 0
  298.    21  FileGroupQ 1 3 14 10 10   Adult Files
  299.    22  FileGroupR 0
  300.    23  FileGroupS 0 3 12 10 10   SkyNet
  301.    24  FileGroupT 0
  302.    25  FileGroupU 1 3 12 10 10   UFO & Aliens Stuff
  303.    26  FileGroupV 0
  304.    27  FileGroupW 0 3 12 10 10   Windows95
  305.    28  FileGroupX 1 3 12 10 10   AdeptXBBS Support
  306.    29  FileGroupY 0
  307.    30  FileGroupZ 0
  308.    31  # ------------------------------------------------------------------- #
  309.    32  N            ; Y/N - Turn logging ON (Y) or OFF (N)
  310.    33  3            ; LogLevel 1 (logfile/window), 2 (logfile), 3 (logwindow)
  311.    34  Y            ; Y/N - Display Filelist directly after selecting area
  312.    35  XX           ; this option not in use at the moment
  313.    36  NoActive     ; Show when group is not active
  314.    37  ToYoung      ; Show if user is too young to access group
  315.    38  NoSec1       ; Show if sec1 is too low to access group
  316.    39  NoSec2       ; Show if sec2 is too low to access group
  317.    40  A            ; Default group when user hasn't selected a group before
  318.    41  {FC          ; File Area Number Color
  319.    42  {F3          ; File Area Name Color
  320.    43  {FA          ; Color for the Dots ' ... '
  321.    44  {F4          ; FileArea Description Color
  322.    45  {F2          ; Choose a FileGroup Prompt Color
  323.    46  {F4          ; Select a FileArea Number Prompt Color
  324.    47  {F4          ; Color of brackets '[  ]'
  325.    48  {FC          ; Color of brackets input color  ['25']
  326.    49  Choose which File Group? >>
  327.    50  Press [ENTER] for More, [Q] to Quit or select File Area Number:
  328.    51  Press [ENTER] to Quit or select File Area Number:
  329.    52  # ------------------------------------------------------------------- #
  330.  
  331.  
  332.    Description of this Example Afan.Cfg File:
  333.    ------------------------------------------
  334.    Line 01-04 - Comment Lines
  335.  
  336.    Line 05-30 - Configuration of the File Groups:
  337.   ----------------------------------------------
  338.    Put a space(s) between On/Off  Digits  Min.age  Sec1  Sec2  Group Name
  339.                           |       |       |        |     |     |
  340.    Line 05  FileGroupA    1       3       12       10    10    All Areas
  341.  
  342.    FileGroup A is On/Off       : 1 = this group is enabled  (ON)
  343.                                  0 = this group is disabled (OFF)
  344.                                  (use an 0 here when group is not in use)
  345.    Digits Used                 : 3 - means you can put 3 charakters between
  346.                                  the brackets '[  ]' like [123] or [999]
  347.    Minimum Age to access Group : 12
  348.    Minimum Security Level 1    : 10
  349.    Minimum Security Level 2    : 10
  350.    Group Name used for Logging : All Areas
  351.  
  352.    Line 31  Comment Line
  353.  
  354.    Line 32  Y   - Turn logging ON/OFF
  355.                   Y = Logging is ON
  356.                   N = logging is OFF
  357.  
  358.    Line 33  3   - LogLevel 1 = log to logfile and window
  359.                   LogLevel 2 = log to logfile only
  360.                   LogLevel 3 = Log to window only
  361.  
  362.    Line 34  Y   - Display Filelist directly after selecting area
  363.                   Y = Show File Area Contents after selecting Area
  364.                   N = Don't show Area Contents after selecting Area
  365.  
  366.    Line 35  XX  - This option is not in use at the moment
  367.  
  368.    Line 36-39 - External Text File Configuration Section:
  369.    ------------------------------------------------------
  370.    Notice that you don't use the file extensions .asc/.ans/.avt, these files
  371.    are located in the directory '\Adept\Afan\Text'.
  372.  
  373.    Line 36  NoActive  - is displayed when group isn't active
  374.    Line 37  ToYoung   - is displayed when user is too young to access group
  375.    Line 38  NoSec1    - is displayed when Security Level 1 is too low
  376.    Line 39  NoSec2    - is displayed when Security Level 2 is too low
  377.  
  378.    Line 40  A         - Default File Group to show new AFAN users
  379.                           
  380.    Line 41-48 - Color Configuration Section:
  381.    -----------------------------------------
  382.    ANSI Color and AdeptXBBS Meta Color table:
  383.  
  384.      {F1 = Black                 {F9 = Dark gray
  385.      {F2 = Dark blue             {FA = Blue
  386.      {F3 = Dark green            {FB = Green
  387.      {F4 = Dark cyan             {FC = Cyan
  388.      {F5 = Dark red              {FD = Red
  389.      {F6 = Dark magenta          {FE = Magenta
  390.      {F7 = Brown                 {FF = Yellow
  391.      {F8 = Light gray            {FG = White
  392.  
  393.    Line 41  {FC - File Area Number Color            - '400'
  394.    Line 42  {F3 - File Area Name Color              - 'ADEPTXBBS'
  395.    Line 43  {FA - Dots Color                        - ' .... '
  396.    Line 44  {F4 - File Area Description Color       - 'AdeptXBBS Software'
  397.    Line 45  {F2 - Choose a File Group Prompt Color
  398.    Line 46  {F4 - Select a File Area Number Prompt Color
  399.    Line 47  {F4 - Color of the Brackets             - '['   ']'
  400.    Line 48  {FC - Color of the Brackets input Color -  ['400']
  401.  
  402.    Line 49-50 - Text Prompt Configuration Section:
  403.    -----------------------------------------------
  404.    Line 49  Choose which File Group? >>
  405.    Line 50  Press [ENTER] for More, [Q] to Quit or select File Area Number:
  406.    Line 51  Press [ENTER] to Quit or select File Area Number:
  407.  
  408.    Line 52  Comment Line
  409.  
  410.  
  411.  
  412.   ────────────────────────────────────────────────────────────────────────────
  413.   ▒▒▒  10. - Which files and directory's are used by AFAN?                ▒▒▒▒
  414.   ────────────────────────────────────────────────────────────────────────────
  415.  
  416.    Drive:\Adept
  417.           |
  418.           |__Afan --------> notice: directory \Adept\Afan is hard coded
  419.              |              - AfanA.Erx
  420.              |              - AfanG.Erx
  421.              |              - Afan.Cfg      (Afan Configuration file)
  422.              |              - AfanInfo.Doc  (Afan Information file)
  423.              |              - AfanInst.Cmd  (Installation util)
  424.              |              - F-Group.Cmd   (makes all areas listing)
  425.              |              - File_ID.Diz
  426.              |              - Whats.New     (whats new in this release)
  427.              |              - Text.zip      (sample external screens)
  428.              |              - Sample.Cfg    (sample configuration file)
  429.              |
  430.              |___ Groups -> directory where Fgroup?.asc files are stored
  431.              |              - FgroupA.asc   (config file for group A)
  432.              |              - FgroupB.asc   (config file for group B)
  433.              |              - etc..
  434.              |
  435.              |___ Text --> directory where external screens are stored
  436.              |              - Fgroup.asc/.ans/.avt   (screen showed when asked
  437.              |                                       to choose a group).
  438.              |              - NoActive.asc/.ans/.avt (screen showed when group
  439.              |                                       isn't active).
  440.              |              - NoSec1.asc/.ans/.avt   (screen showed when Sec.
  441.              |                                       level 1 is too low).
  442.              |              - NoSec2.asc/.ans/.avt   (screen showed when Sec.
  443.              |                                       level 2 is too low).
  444.              |              - ToYoung.asc/.ans/.avt  (screen showed when too
  445.              |                                       young to access a group).
  446.              |
  447.              |___ UserInfo -> directory where Afan's userrecords are stored
  448.                             - Koen Koster   (userrecord based on username)
  449.                             - etc..
  450.  
  451.