home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / citadel2 / util.doc < prev    next >
Text File  |  1989-12-01  |  17KB  |  340 lines
  1. /************************************************************************/
  2. /*                Util.doc                */
  3. /************************************************************************/
  4.  
  5. /************************************************************************/
  6. /*                Audience                */
  7. /*                                    */
  8. /*  Sysop and other troll-like folk.                    */
  9. /************************************************************************/
  10.  
  11. /************************************************************************/
  12. /*                Purpose                 */
  13. /*                                    */
  14. /*  Let the poor unfortunates be even more confused over what's     */
  15. /*  available.                                */
  16. /************************************************************************/
  17.  
  18. /************************************************************************/
  19. /*                Contents                */
  20. /*                                    */
  21. /*    Introduction        Intro to this doc.            */
  22. /*    Clog.ttp        Description of Clog.            */
  23. /*    Recover1.ttp        Description of Recover1.        */
  24. /*    Ctdlchng.ttp        Description of Ctdlchng.        */
  25. /*    Lexpand.ttp        Description of Lexpand.         */
  26. /*    Logedit.ttp        Description of Logedit.         */
  27. /*    Popular.ttp        Description of Popular.         */
  28. /*    Citar.ttp        Description of Citar.            */
  29. /*    Citsh.ttp        Description of Citsh.            */
  30. /************************************************************************/
  31.  
  32. /************************************************************************/
  33. /*                Introduction                */
  34. /************************************************************************/
  35.  
  36.    Since the days of yore when we received Citadel (the Z80 version of
  37. Citadel, that is...) from CUG (C User's Group), several utilities of interest
  38. have been added to the package to supplement the original two .com files that
  39. came with the package, to wit CITADEL.COM and CONFIGUR.COM.  These come in two
  40. types: one, to provide information about what's going on inside this monster
  41. which, due to runtime space considerations, could not be gotten at; two, the
  42. ability to change certain parameters which were either impossible to change
  43. once a BBS was set up, or were, at the least, difficult to change.
  44.    The descriptions (such as they are) follow herein!
  45.  
  46. /************************************************************************/
  47. /*                Clog.ttp                */
  48. /************************************************************************/
  49.  
  50.    Clog provides access to the userlog for the Sysop.  To use it, the file
  51. CTDLTABL.SYS (the one generated by CONFIGUR and maintained by CITADEL.COM)
  52. must be on the default disk, and so must be CTDLLOG.SYS.
  53.  
  54.    There are two ways of using Clog.  First, there is the simple call:
  55.  
  56.     D>CLOG
  57.  
  58. This will print out on the console the list of users in the file as they
  59. appear in the file.  The user of this program should be warned that Citadel
  60. does not put new users into the userlog in sequential order.  Instead, they
  61. are hashed into the log.  Usually, first user to log into the system ends
  62. up occupying the last position in the file!  In general, users are sprinkled
  63. everywhere, so don't be alarmed if nothing shows up right away.  Be patient.
  64.  
  65.    In any case, the list is printed out as follows.  First, the log position
  66. will be printed out, which will always be in sequential order.    If nobody
  67. occupies that position, then Clog proceeds to the next log position.  If
  68. somebody does occupy that position, then the name of that person (or alias)
  69. will be printed out, followed by his/her status as aide, expert/non-expert, and
  70. screen width.
  71.  
  72.     The second way to use Clog is to give it arguments.    There are two arguments
  73. currently available in the GEMDOS version; the -p argument and the -a argument.
  74.  
  75.       D>clog -p -a
  76.  
  77.    -p will cause the passwords to be listed along with the user's name. This
  78. is very useful if somebody forgets their password. -a will only list the aides
  79. on the system (this was put in because some unscrupulous users might make
  80. themselves aides if they get access to the system console).
  81.  
  82.    If, for some reason, the sysop wants a list to be put out to a file, use
  83. the GEMDOS re-direction commands. If you want the list to be put out to the
  84. file LOG.LST, the type
  85.  
  86.       D>CLOG >LOG.LST
  87.  
  88. Naturally, arguments may still be used when re-directing output.
  89.  
  90. /************************************************************************/
  91. /*                Expand.ttp                */
  92. /************************************************************************/
  93.  
  94.    Expand's purpose in life is to allow the sysop to expand the size of his/her
  95. message file (CTDLMSG.SYS).  This makes it easy to move upwards as one gets
  96. rich running Citadel for cold, hard cash and acquires better and better
  97. equipment.
  98.  
  99.    Expand expects to find the file CTDLTABL.SYS on the default disk in the
  100. default user area and the CTDLMSG.SYS file on MSGDISK.    Simply call Expand
  101. without arguments.  Once it has loaded CTDLTABL.SYS, it will display the
  102. current size (in internal sectors, not* kbytes) of the message file, and
  103. then ask for the new size.  Answer in sectors, in decimal (unlike
  104. CTDLCNFG.SYS -- remember when changing CTDLCNFG.SYS to accomodate the new
  105. message size to change the number back to hex).  Now Expand will do it's job.
  106. THIS IS A SLOW PROCESS.  Be patient.  The program will be printing some stuff
  107. out that might allow the sysop to figure out where the program is.
  108.  
  109.    Once the program is done, it will say so, and will also tell you that
  110. there is no reason to reconfigure.  This is not* true -- the current version
  111. diddles something in CTDLTABL.SYS which vapes the userlog, so you must*
  112. reconfigure to keep the userlog valid.
  113.  
  114.    IF you are changing the value of MSGDISK, which would usually merit a
  115. reconfigure (groan), please see the section of this doc covering the
  116. program called Ctdlchng.ttp.  This should be of help to you.
  117.  
  118. /************************************************************************/
  119. /*                Ctdlchng.ttp                */
  120. /************************************************************************/
  121.  
  122.    The purpose of Ctdlchng.ttp is to allow the sysop to change certain of
  123. the parameters present in CTDLCNFG.SYS to a different value without going
  124. thru the entire reconfiguration process one more time.    Ctdlchng expects to
  125. find CTDLTABL.SYS on the default disk and directory.
  126.  
  127.    To use this program, ctdlchng may be called with 0 or more arguments.  If
  128. it is called with 0 arguments, the program prints on the sysop's console an
  129. explanation of Ctdlchng's purpose and it's argument usage and returns the
  130. sysop to GEMDOS.  If 1 or more arguments are present, then each argument is
  131. processed.  Each argument on the command line should be separated by a space.
  132.  
  133.    The user of this program will note that in the following list of supported
  134. arguments, all derive straight from CTDLCNFG.SYS parameters.
  135.  
  136.    There are two types of arguments possible, one to change a "boolean" value,
  137. and one to change a "numerical" value.
  138.  
  139.    To change a boolean value, merely type its name as an argument to Ctdlchng.
  140. The value of that boolean will then be "flipped" to its opposite value.  The
  141. list of boolean arguments supported is as follows:
  142.  
  143. ROOMOK          -- Is it ok for ordinary folk to create rooms?
  144. ENTEROK       -- Is it ok for unlogged folk to enter messages?
  145. READOK          -- Is it ok for unlogged folk to read messages?
  146. LOGINOK       -- Can unlogged people make their own logins? (Is system private?)
  147. CLOCK          -- Does system have a clock?
  148. ALLMAIL       -- Can everybody send mail, or only aides?
  149. SEARCHBAUD    -- Should the system do an auto search for 300 or 1200 callers?
  150.          (SPECIAL NOTE: If you are changing SEARCHBAUD from 0 to 1
  151.           and never wrote the SET300 and SET1200 routines, then don't
  152.           bother to use Ctdlchng.ttp. You'll have to go into
  153.           CTDLCNFG.SYS, write up those two routines, and then run
  154.           CONFG.COM so that those two routines are in CTDLTABL.SYS.)
  155. TIMEOUT       -- Do you want the system to take itself down in x (HOUROUT)
  156.          hours?
  157. MIRRORMSG     -- Do you want two message files functioning, one for writing
  158.          only, the other for both? This is for RAM disk operations.
  159. NETWORK       -- Wanna be part of the network?
  160. LONG-HAUL     -- Wanna be part of the national/long distance network?
  161.  
  162.    So, if the sysop had originally configured with ALLMAIL set to 0, i.e., s/he
  163. didn't want ordinary users to have access to the mail, and now has decided to
  164. allow all access to the mail, the sysop would type
  165.  
  166.    A>d:ctdlchng allmail
  167.  
  168. and the value would be flipped.  More than one of the above could be entered on
  169. the command line.
  170.  
  171.    To change a numerical value, the sysop types the name of the numerical
  172. variable, followed immediately by an '=x', where x is an integer.  NOTE THAT
  173. X MUST BE A DECIMAL NUMBER, UNLIKE THE CTDLCNFG.SYS FILE!!!!  Also note that
  174. when changing CTDLCNFG.SYS, remember to convert back to hex.  Yah, it's a pain
  175. in the neck.  The reason CTDLCNFG.SYS must be changed is that the next time
  176. Citadel crashes (whether it be a software or hardware crash), you don't want
  177. to reconfigure with the old values still present.  ALSO, THERE CAN BE NO SPACES
  178. BETWEEN THE VARIABLE NAME, THE EQUAL SIGN, AND THE INTEGER, OR CTDLCHNG.EXE
  179. WILL BE HORRIBLY, HORRIBLY CONFUSED.  The list of supported numerical values
  180. is as follows:
  181.  
  182. MSGDISK       -- Disk the message disk is on (A:=0, B:=1, ...).
  183. HOMEDISK      -- Disk where all .HLP, .BLB, and .MNU file are kept.
  184. SYSDISK       -- Disk where CTDLLOG.SYS and CTDLROOM.SYS are kept.
  185. NETDISK       -- Disk where all net files (.ML and CTDLNET.SYS) are kept.
  186. HOUROUT       -- If TIMEOUT is TRUE, then this determines how many hours before
  187.          system comes down after being brought up.
  188. MSG2DISK      -- If MIRRORMSG is TRUE, then this determines where the file for
  189.          write-only is kept.
  190. DAYDIV          -- For networking. Determines on what days the networker goes
  191.          into operation. WARNING: This value should only be changed in
  192.          conjunction with the rest of the network.
  193. NETLENGTH     -- For networking. Determines how long networking lasts. WARNING:
  194.          This value should only be changed in conjunction with the rest
  195.          of the network.
  196. SYSBAUD       -- If installing new modem with differing bauds. Currently,
  197.          0=300, 1=300/1200, 2=300/1200/2400.
  198.  
  199.    So, to change the baud rate your modem is running at, type
  200.  
  201.    A>d:ctdlchng SYSBAUD=2
  202.  
  203.    or whatever the new baud rate is.
  204.  
  205.    Numerical and boolean variable changes may be mixed as the sysop pleases.
  206.  
  207. /************************************************************************/
  208. /*                Lexpand.ttp                */
  209. /************************************************************************/
  210.    The LEXPAND utility allows the sysop to expand his log beyond the
  211. size selected for when the system was originally configured.  This program
  212. does NOT destroy the log file, it merely enlarges it.
  213.  
  214.    Usage: Make sure that the log file is in it's usual drive. Call
  215. Lexpand. After some grinding, it'll state the old size and ask for the
  216. new size. Give it the new size, and sit back. It'll announce when it is
  217. done and remind you to modify CTDLCNFG.SYS accordingly.
  218.  
  219. /************************************************************************/
  220. /*                Logedit.ttp                */
  221. /************************************************************************/
  222.    LOGEDIT is provided for when strange things start happening in the
  223. log file, such as duplicate or semi-duplicate logs start appearing.
  224. LOGEDIT allows any account to be killed purely by account# (position
  225. in the log).
  226.  
  227.    To run, make sure the disk(s) with the HOMEDISK and SYSDISK files are
  228. in their normal positions, and run LOGEDIT.  After some grinding, the
  229. system will ask you what account you want to kill.  Give it the number, it
  230. will display name and pwd, and ask for confirmation.  If you answer yes,
  231. then the account will be killed.  It will then ask for an account to kill
  232. again.    When finished killing accounts, answer this prompt with the number
  233. it should provide.
  234.  
  235. /************************************************************************/
  236. /*                Popular.ttp                */
  237. /************************************************************************/
  238.    The POPULAR utility is a statistics-gathering utility, and, as such,
  239. can be easily viewed as your basic feeping creaturism.    However, for those
  240. of us who have somehow acquired that horrible taste for odd statistics about
  241. how people use Citadel, it does serve some purpose.
  242.  
  243.    POPULAR gathers statistics about the Public rooms on a system.  These
  244. statistics consist of simply calculating how many people have forgotten
  245. each Public room on a system.  Yes, a rather odd statistic to gather, but
  246. there it is.  Once it has finished processing the data, it displays the
  247. results in tabular form, in (roughly) the following form:
  248.  
  249. <room name>    <# of people who have forgotten this room> <% of total users>
  250.  
  251.    To use this utility, simply make sure your data files are in their normal
  252. drives, and run this program.  The output of this program may be redirected
  253. to a file via the GEMDOS ">" directive, although not all the output will end
  254. up in the output file. Unimportant output will continue to go to the screen;
  255. the important data will end up in the file you designated.
  256.  
  257.    There is one command line option available, "-m".  If this option is on
  258. the command line to Popular, it will also scan the message file, counting
  259. the number of messages that originated in each room, and display that value
  260. for each public room in the same tabular format.
  261.  
  262. /************************************************************************/
  263. /*                Citar.ttp                */
  264. /************************************************************************/
  265. Citar was made up to copy files to and from Citadel directory  rooms, adding
  266. or deleting the file descriptions as it goes. If you want to copy a file
  267. into a Citadel directory, type 
  268.   
  269.     CITAR <FILE> <CITADEL-FILE> 
  270.  
  271.   and enter a one line description of the file at the Comment? prompt. (the 
  272. file nnames must be the full pathname -- you can't just specify the 
  273. destination directory.  If you are copying BLEH.ARC to the Citadel directory 
  274. FOO, you would type 
  275.   
  276.    CITAR BLEH.ARC FOO\BLEH.ARC) 
  277.   
  278.   To copy a file out of a Citadel directory, you type 
  279.   
  280.    CITAR -X <CITADEL-FILE> <FILE> 
  281.   
  282.   To read the desciptive tags on one or more files in a Citadel directory,
  283. type
  284.  
  285.    CITAR -V <FILE-1> <FILE-2> .... <FILE-N>
  286.  
  287.   Finally, if you have more than one file you want to copy into or out of 
  288. a directory room, you may use citar in batch mode. To use batch mode, type 
  289.   
  290.    CITAR @<BATCH-FILE> 
  291.   where BATCH-FILE is set up as a bunch of one-line entries like 
  292.   
  293.     <cmd> <from-file> <to-file> [comment] 
  294.   The <cmd> is either 'a' to add files to the Citadel directory (if you 
  295. are adding files to the Citadel directory, you must* provide a comment,)
  296. 'x' to copy files from the Citadel directory, or 'v' to view the description
  297. of the file.  For example, if you want  to copy F1, F2, ..., FN into the
  298. Citadel directory STUFF and Q1,Q2,...,QN  out of STUFF into the current
  299. directory, you'd make up a batch file like this: 
  300.   
  301.   
  302.      a F1 STUFF\F1 Comments for F1 
  303.      a F2 STUFF\F2 Comments for F2 
  304.         . 
  305.         . 
  306.         . 
  307.      a FN STUFF\FN Comments for FN 
  308.   
  309.      x STUFF\Q1 Q1 
  310.      x STUFF\Q2 Q2 
  311.         . 
  312.         . 
  313.         . 
  314.      x STUFF\QN QN 
  315.   
  316.   If the batch file was called DOIT, you'd type CITAR @DOIT. 
  317.   NOTE: If you are running from the desktop, don't type the CITAR part when the 
  318. TTP parameters window pops up. 
  319.   NOTE2: If you are copying into a Citadel directory, CITAR will prompt 
  320. you before you overwrite anything, but if you are copying out of a Citadel 
  321. directory, CITAR will silently overwrite things.  BEWARE! 
  322.  
  323. /************************************************************************/
  324. /*                Citsh.ttp                */
  325. /************************************************************************/
  326. Citsh was made up for people who are running Citadel on a ramdisk and wish
  327. to have regular backups made.  Instead of running Citadel, you run Citsh --
  328. whenever Citadel exits, the log, room, and message files will be backed up
  329. onto the current directory.  (And, when Citsh starts, it will copy those three
  330. files from the current directory to their appropriate drives.)  If Citsh
  331. cannot find CTDLTABL.SYS, it will run CONFIGUR.TOS and inform Citadel that
  332. it had to reconstruct the tables.
  333.  
  334.     If you pass any arguments to Citsh, it will assume that the various
  335. system files are already loaded onto their respective disks and not* try to
  336. load them itself. If Citsh has anything go wrong with it, it will print out
  337. a error message and exit.
  338.  
  339.     This is particularly useful when run in conjunction with timeouts.
  340.