home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / bbs / fn132bin / man / citadel.man < prev    next >
Text File  |  1991-09-05  |  5KB  |  137 lines
  1.  
  2.  
  3. CITADEL(1)           FNORDADEL BBS SOFTWARE            CITADEL(1)
  4.  
  5. NAME
  6.      citadel.tos - main Fnordadel bbs program
  7.  
  8. SYNOPSIS
  9.      citadel [+backup] [+debug] [+door] [+hup] [+line] [+multi]
  10.      [+netdebug] [+netlog] [+purge] [+restrict] [+ymodem] [+zap]
  11.      [foo]
  12.  
  13. DESCRIPTION
  14.      Citadel is the main Fnordadel BBS program.  It expects to
  15.      find the table file (ctdltabl.sys) in the current directory.
  16.      If it can't find it, it will complain and exit.  You must
  17.      run configur in this case to regenerate the tables.
  18.      Ctdltabl.sys will be read and erased by citadel when it
  19.      runs; when it exits, ctdltabl.sys will be rewritten.  This
  20.      prevents the use of old system tables in the event of a
  21.      serious crash.
  22.  
  23. OPTIONS
  24.      +backup
  25.           use [B]ackup instead of old [U]ngoto command; U now
  26.           means [U]pload
  27.  
  28.      +debug
  29.           general debugging flag
  30.  
  31.      +door
  32.           execute Fnordadel as a door from within some other pro-
  33.           gram, presumably another BBS; avoids all normal modem
  34.           control and exits when the user terminates, returning
  35.           control to the calling program
  36.  
  37.      +hup causes Fnordadel to lower the modem DTR line when it
  38.           exits (disabling modem autoanswer)
  39.  
  40.      +line
  41.           turn on the status bar
  42.  
  43.      +multi
  44.           indicates that you're running Fnordadel in the back-
  45.           ground under some sort of multitasking system (e.g.
  46.           MX2, Amulti)
  47.  
  48.      +netdebug
  49.           debugging specifically for the network stuff
  50.  
  51.      +netlog
  52.           instructs Fnordadel to keep a log of network activity
  53.           in the file `netlog.sys' in #auditdir
  54.  
  55.      +purge
  56.           enable automatic message purging for those users
  57.           specified in #sysdir\purge.sys
  58.  
  59.      +restrict
  60.           enable login restriction to those users specified in
  61.           #sysdir\restrict.sys
  62.  
  63.      +ymodem
  64.           enable the use of ymodem in networking
  65.  
  66.      +zap turn on the network loop-zapper
  67.  
  68.      foo  any miscellaneous character or word that doesn't start
  69.           with '+' or '-'; Fnordadel takes this as a sign that
  70.           the BBS has recovered from a crash, and generates an
  71.           Aide> message to that affect; generally supplied from
  72.           inside a batch file or shell script that detected a
  73.           "crash" exit value and recovered the system
  74.  
  75. EXIT STATUS
  76.      Citadel returns various exit values depending on why it is
  77.      exiting.  The following are predefined:
  78.  
  79.      0       Normal exit.  The Sysop used [Q] from the Sysop
  80.              menu to bring the BBS down.
  81.      1       #timeout exit.  You have defined a timeout (see
  82.              Chapter 8 of the Manual) and a timeout has
  83.              occurred.
  84.      2       Crash exit.  The BBS has crashed, but gracefully.
  85.              Hints on why it crashed may be (possibly) found in
  86.              the file `crash' in the current directory.
  87.      3       Remote exit.  A Sysop has used the [Q] command as
  88.              above, but was logged in on the modem at the time.
  89.      255     Absolutely Grotesquely Ugly exit.  The BBS has
  90.              crashed, not at all gracefully.  There might* be
  91.              something in `crash' to tell you why, but there
  92.              probably isn't.
  93.  
  94.      In addition, you may define any number of other exit values.
  95.      See "Chapter 8: Events" in the Reference Manual for more on
  96.      this.
  97.  
  98.      In all cases except the Absolutely Grotesque (255), citadel
  99.      writes the table file (ctdltabl.sys) to the current direc-
  100.      tory when it exits.  If it doesn't write ctdltabl.sys, you
  101.      have to run configur to regenerate the tables.
  102.  
  103. BUGS
  104.      The +door option can not be used to call Fnordadel as a door
  105.      from within itself or STadel, due to the way the door code
  106.      sets things up.
  107.  
  108.      The +multi option may or may not work with any given multi-
  109.      tasker.  We have put very little effort into supporting this
  110.      sort of thing, which was started by orc.
  111.  
  112.      A really nasty situation will arise if your BBS disk or hard
  113.      drive partition runs out of free space.  The code currently
  114.      won't detect this fact, and will blithely continue trying to
  115.      run.  Things will probably screw up soon, and when the board
  116.      comes down, ctdltabl.sys can't be written out since there's
  117.      no room left.
  118.  
  119. FILES
  120.      citadel.tos    main BBS program
  121.      configur.tos   configuration program
  122.      ctdltabl.sys   table file, read & written by citadel,
  123.                     regenerated by configur
  124.  
  125. SEE ALSO
  126.      configur.man   man page for configur
  127.      The Fnordadel Reference Manual
  128.  
  129. AUTHORS
  130.      Fnordadel is maintained by Adrian Ashley (elim @ secret) and
  131.      Royce Howland (Mr. Neutron @ RT).
  132.  
  133.      Fnordadel is directly descended from STadel by David Par-
  134.      sons, which is in turn directly descended from Citadel-86 by
  135.      Hue, Jr., which is in ITS turn descended from Citadel by
  136.      CrT.
  137.