home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / Utils / bbs_exe.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  8.4 KB  |  228 lines
  1.  
  2.  
  3.    =====( BBS V1.00 )=================================================
  4.  
  5.  
  6.         Trion BBS Program.
  7.  
  8.         (c) Copyright Paul Spijkerman, '94-'97. All rights reserved.
  9.  
  10.         Written for use with the Trion BBS package.
  11.  
  12.  
  13.    ===================================================================
  14.  
  15.  
  16.    The program BBS is the main BBS executable, it contains
  17.    the code to answer the phone, and to let users login 
  18.    (manually or with EMSI) or handle mailers when they call.
  19.    Also it can do mail calls to other systems and a simple terminal.
  20.  
  21.    Before a node can be startup the 'TrionRM' Resource Manager
  22.    has to be running or 'BBS' will exit with an error message
  23.    when started.
  24.  
  25.    A node is started with the run command so other things can be
  26.    done in the shell. After the BBS command you have to place
  27.    a number of options which start with a '-' sign. The first
  28.    option is the node number and can be 0 to 9.
  29.    Here is a list of the other options:
  30.  
  31.    -L   = Local node (without serial port)
  32.    -P   = Don't open serial yet but wait on command
  33.    -X   = Spawned by a mailer
  34.    -N   = Don't accept callers
  35.    -A   = Don't list LastCallers for this node
  36.    -I   = Iconized
  37.    -V   = Modem volume (sound) off
  38.    -T   = No logs buffering
  39.    -D   = Debug
  40.    -S   = Debug and log commands of Users
  41.  
  42.  
  43.  
  44.    If you start a node with the (-L) option is doesn't open a
  45.    serial port (local node) and can't be made to handle a
  46.    serial port with external utilities like trion.
  47.    This is usefull if you want to use a node for local use
  48.    so there are no lines busy while you read you mail or
  49.    browse to the BBS.
  50.  
  51.    If the (-P) option is used this node while be configured
  52.    as a serial node, but the serial port isn't opened until
  53.    a command is given. The command can be a click on a button
  54.    in the GUI-screen or a start of the Trion utility in shell.
  55.    This can be usefull if you want to startup a few nodes at
  56.    the same time at the same serial port. Some people do this
  57.    so they can poll with different sysop names .. because
  58.    their fido node nummer belongs to a Co-sysop.
  59.  
  60.    With the (-X) option the node starts up without initializing
  61.    the modem and without waiting for a call so it can be
  62.    started from an external mailer like Trapdoor, but no
  63.    IEMSI can be used if the mailer happens to be a person.
  64.    Also in this mode the node exits when the call is finished.
  65.    Recommended is to use the internal mailer of the trion BBS system.
  66.  
  67.    If the node was started with the (-N) option it doesn't
  68.    pick up the modem if there there is a call. This can be
  69.    usefull if you want to call out a few times and don't
  70.    want the BBS to pick up the modem in the time between
  71.    calls .. you can also toggle this mode from the GUI-screen
  72.    of this node , or with the 'trion' util in a script.
  73.  
  74.    With the (-A) option no lastcallers of this node will be
  75.    added the TrionRM monitor and the Lastcaller util screens.
  76.    This is usefull if you use a node for internal calls, if
  77.    you for instance call your BBS via nullmodem.device with
  78.    your point packet you probably don't want that shown in
  79.    your lastcallers screen.
  80.  
  81.    With the (-I) option the node will not open it's GUI-screen
  82.    when started but show a little icon on the workbench screen.
  83.    This icon will show the status of the node or the name of a
  84.    User when someone is logged in, if a user pages the sysop
  85.    a asterix (*) will appear in the icon before the name.
  86.    If you click on the icon the node is DeIconized and a
  87.    GUI-screen is opened .. or if the node is calling or
  88.    answering the BBS screen is opened.
  89.    The screen of this node can also be DeIconized by the
  90.    'trion' util in a script of with buttons in the TrionRM
  91.    monitor (who actually call the trion util to do this).
  92.  
  93.    If a node is used with a serial port it sends commands to
  94.    the modem to control sound, with this option you can turn
  95.    modem sound on or off with a cron util (via the trion util),
  96.    so can can still hear the modem at daytime (and people who
  97.    call voice) but have a quiet modem at night.
  98.    With the (-V) option the node will startup in quiet mode.
  99.  
  100.    The 'No logs buffering' (-T) option means that logs are not
  101.    stored in memory until the buffer is full or the buffer was
  102.    flushed internally but that lines written to the log are
  103.    written immediatly to the log. This was usefull in some
  104.    debuging situations when the BBS wasn't as stable as it is
  105.    now.
  106.  
  107.    The debug (-D) option is usefull when configuring nodes, because
  108.    more information is stored in the log file.
  109.    The results of modem strings is loged in this mode, also the
  110.    memory use of a node is loged and memory allocated by the BBS
  111.    is checked for overwriting of boundaries.
  112.  
  113.    The (-S) option is the same as the (-D) option but also all
  114.    input of users in the menus is stored.
  115.  
  116.  
  117.  
  118.  
  119.    When a BBS node is started up it wil read the Trion-X.cfg
  120.    from the Trion:cfg/ directory (where the X is the number
  121.    of this node) to determine the information it needs to
  122.    run. This includes information on the serial port, modem strings,
  123.    the screen mode, depth and size and icon size.
  124.  
  125.  
  126.  
  127.  
  128.    Scripts:
  129.    --------
  130.  
  131.    The BBS executable will start scripts in certain situations,
  132.    here is a little overview which scripts and where the were
  133.    mend for:
  134.  
  135.  
  136.  
  137.    When there was an incoming call from a mailer the folowing
  138.    script is called after the modem was initialised.
  139.  
  140.    trion:script/incoming.X       (where X is the number of this BBS node)
  141.  
  142.    In this script you can start the fax.init script which will
  143.    GPFax control to the modem to init the modem with your
  144.    fax details.
  145.    In this script you can start the mail processing script.
  146.    You can start the lastcallers script to make a new lastcaller
  147.    and UsageGraph ANSI screen.
  148.  
  149.  
  150.  
  151.    When an outgoing mail call was made by the mailer (and a connect
  152.    was made) the folowing script is called after the modem was initialised.
  153.  
  154.    trion:scripts/outgoing.x       (where X is the number of this BBS node)
  155.  
  156.    This is usefull for unpacking the collected mail, Update the
  157.    lastcallers screen .. and start the fax.init script.
  158.  
  159.  
  160.  
  161.  
  162.    When a user logs out from the BBS the folowing script is started
  163.    after the modem is initialised.
  164.  
  165.    trion:script/logout.X       (where X is the number of this BBS node)
  166.  
  167.    In this script you can start the fax.init script which will
  168.    GPFax control to the modem to init the modem with your
  169.    fax details.
  170.    In this script you can start the mail processing script.
  171.    You can start the lastcallers script to make a new lastcaller
  172.    and UsageGraph ANSI screen.
  173.    You can start the Trion Log-off police programm.
  174.  
  175.  
  176.  
  177.  
  178.    After an upload the trion:scripts/Upload script is runned to
  179.    proces the upload.  Processing can be:
  180.  
  181.    Checking for viruses
  182.    Deleting displayme files.
  183.    Extracting description files from an archive like FILE_ID.DIZ
  184.  
  185.    The upload script is called with the filename, compressiontype
  186.    and name for a descritionfile as arguments.
  187.    Note that the BBS reads the first bytes of an archive to determine
  188.    the methode which was used to create the archive.
  189.  
  190.  
  191.  
  192.  
  193.    When a user wants to view an archive the trion:scripts/ViewArchive
  194.    is started to make a list of the archive.
  195.    The ViewArchive script is called with the filename, compressiontype
  196.    and name for a listfile as arguments.
  197.    Note that the BBS reads the first bytes of an archive to determine
  198.    the methode which was used to create the archive.
  199.    In the default script the unrecognized archives are processed with
  200.    the Unpack util in list mode. The default config of the unpack
  201.    script contains recognation codes for IFF, GIF and JPEG and
  202.    calls to viewtek to show the sizes and depth of these screens.
  203.  
  204.  
  205.    When an incoming Voice call is detected the
  206.    'trion:scripts/voice.script' is started to take over the serial
  207.    port. When this script returns to the BBS the modem is initialized
  208.    and the BBS returns to the monitoring the serial port mode.
  209.  
  210.  
  211.  
  212.    When an incoming fax call is detected the
  213.    'trion:scripts/fax.script' is started to take over the serial
  214.    port. When this script returns to the BBS the modem is initialized
  215.    and the BBS returns to the monitoring the serial port mode.
  216.  
  217.  
  218.  
  219.    If you exit the terminal mode of the BBS program the folowing
  220.    script is started.
  221.  
  222.    trion:scripts/TerminalExit.X       (where X is the number of this BBS node)
  223.  
  224.    This was meant to start the fax.init script but you also could
  225.    copy downloaded files from ram: to disk if you download to ram:
  226.  
  227.  
  228.