home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbs / sutil044.zip / SUTIL.H02 < prev    next >
Text File  |  1993-03-02  |  36KB  |  1,135 lines
  1. *default*
  2.  
  3. Oops!  No help is available for this topic.  Please check the manual if
  4. you are unsure of something.  You can always call for help on the Fidonet
  5. SUPERBBS International echo.
  6.  
  7. *end*
  8.  
  9. ─────────────────────────────────────────────────────────────────────────
  10.  
  11. *main menu*
  12.  
  13. Welcome to SUtil, the most complete set of utilities available for Super
  14. BBS.  Help is available at nearly any point in this program by pressing
  15. F1.  To navigate the help text, use your cursor up/down keys, your page
  16. up/down keys and your home/end keys.  Press Escape to exit back to the
  17. menu.
  18.  
  19. The menus are roughly laid out by the various major areas of your bbs.
  20. You will find all the functions related to the user base are under the
  21. User Base menu, files base functions are under the Files Base menu etc.
  22.  
  23. To select an option use your up & down cursor keys to move the highlight
  24. to the correct option, then press Enter to select it.  You may then be
  25. presented with a further menu or prompted for parameters if required or
  26. the selection will be executed.
  27.  
  28. To return to a previous menu you can either select Quit, which is always
  29. the last option on a menu, or press Escape.
  30.  
  31. Sometimes there may be too many menu options to display all at once.  In
  32. this case you can scroll the options by pressing the down cursor until you
  33. see the option you want.  If you don't see the Quit option then you know
  34. there are more options to be found.
  35.  
  36. You can quickly exit the program from any menu using Alt-Q and shell to
  37. DOS using Alt-Z.
  38.  
  39. *end*
  40.  
  41. ─────────────────────────────────────────────────────────────────────────
  42.  
  43. *user base menu*
  44. AVAILABLE FUNCTIONS
  45. ───────────────────
  46. KILL USERS                Mark old users as 'deleted'
  47. PACK USER BASE            Pack user base, removing 'deleted' users
  48. SORT USER BASE            Sort user base according to selected criteria
  49. ANSWER FILE PACK          Remove old users from answer files
  50. ASW -> SYSOP COMMENT      Update SysOp comments from ASW file
  51. GLOBAL ATTR RESET         Global attribute reset by security level
  52. GLOBAL ATTR SET           Global attribute set by security level
  53. GLOBAL FLAG RESET         Global flag reset by security level
  54. GLOBAL FLAG SET           Global flag set by security level
  55. GLOBAL HIGH MSG RESET     Reset 'highest message read' to specified number
  56. UPGRADE SECURITY          Upgrade security based on selected criteria
  57. USER LIST                 User list with selected data
  58. FIND USERS                Find users with security and/or flag
  59. SEARCH USERS              Search users for selected string
  60. ALIAS ONLY LIST           Create ANS/ASC user list with aliases only
  61. LIMITS REPORT             Create comparative user limits report
  62. LOST CARRIER REPORT       Report lost carrier counters
  63. LOST CARRIER RESET        Reset lost carrier counters
  64. KILL OLD MSG COMMENTS     Delete old msg comment files
  65. RECOVER USER BASE         Recover corrupted user base files
  66.  
  67. *end*
  68.  
  69. *kill users*
  70.  
  71. Parameters
  72. ──────────
  73. Low Security:  0 - 32767
  74. High Security: 0 - 32767
  75. Days:          0 - 999
  76.  
  77. Marks as deleted any users within the security range specified *inclusive*
  78. that have not called in <days> number of days.  This allows a range of
  79. securities or a single security level to be deleted.  For example if you
  80. want to kill all users from level 20 to level 40 who are older than 120
  81. days then type:
  82.  
  83. KILL 20 40 120
  84.  
  85. If you want to kill all users at security level 10 who are older than 60
  86. days then type
  87.  
  88. KILL 10 10 60
  89.  
  90. Further, you can delete all users within a range or single security level
  91. immediately.  For example to delete all users from level 0 to level 4,
  92. type:
  93.  
  94. KILL 0 4 0
  95.  
  96. Or only level 0 immediately:
  97.  
  98. KILL 0 0 0
  99.  
  100. This allows flexibility for keeping different level users for differing
  101. lengths of time.  For instance, your new users at level 5 who never do
  102. much and probably won't call back can be deleted quickly whilst you can
  103. allow those who have been upgraded time to get back from their vacation.
  104.  
  105. *end*
  106.  
  107. *sort user base*
  108.  
  109. Parameters
  110. ──────────
  111. Mode: F = First Name
  112.       L = Last Name
  113.       A = Ascending Security
  114.       D = Descending Security
  115.       G = Ascending Age
  116.       E = Descending Age
  117.       T = Ascending Calls
  118.       I = Descending Calls
  119.       M = Ascending Msgs Posted
  120.       S = Descending Msgs Posted
  121.  
  122. Sorts the user base according to the mode on the command line. The mode
  123. can be stacked.  For example SORT LD will sort by last name and then by
  124. descending security.  Think in reverse when stacking the sort mode.  For
  125. example if the first priority is security, it should be the last entry in
  126. the sort mode. Before Sutil starts the sort it will attempt to clean up
  127. the users entries.  It will remove any commas and compress any multiple
  128. spaces.
  129.  
  130. *end*
  131.  
  132. *answer file pack*
  133.  
  134. Parameters
  135. ──────────
  136. Answer File: Any questionnaire answer file found in the SBBS system
  137.              directory, no extension.
  138.  
  139. This will remove any entries from your questionnaire answer files from
  140. users who no longer exist in the user base.
  141.  
  142. *end*
  143.  
  144. *asw -> sysop comment*
  145.  
  146. Parameters
  147. ──────────
  148. Keyword:     Keyword to search for in answer file.
  149. Answer File: Answer file to read, no extension (default=NEWUSER).
  150.  
  151. Scans the given questionnaire answer file looking for the given keyword.
  152. Any text on the same line immediately following the keyword will be
  153. written into the SysOp Comment field in the user base for that user.  The
  154. most recent entry in the answer file will always be used.
  155.  
  156. *end*
  157.  
  158. *global attr reset*
  159.  
  160. Parameters
  161. ──────────
  162. Security:  0 - 32767 or ALL
  163. Attribute: 0 - 17
  164.  
  165. Switches off the user attribute you specify for every user at the
  166. specified security.  If security is ALL then the attribute is switched off
  167. for all security levels.
  168.  
  169. Valid User Attributes:
  170.      0. Deleted                       9. Log On New Files Check
  171.      1. Screen Clear Codes           10. No D/l Ratio
  172.      2. Page Pause                   11. Female
  173.      3. Graphics                     12. Delete File After Viewing
  174.      4. No Kill                      13. Display File Once
  175.      5. Ignore D/l Hours             14. File Viewed
  176.      6. ANSI Editor                  15. Full Screen Viewer
  177.      7. Do Not Disturb               16. Combined Mail Check
  178.      8. Log On Mail Check            17. No Hotkeys
  179.  
  180. *end*
  181.  
  182. *global attr set*
  183.  
  184. Parameters
  185. ──────────
  186. Security:  0 - 32767 or ALL
  187. Attribute: 0 - 17
  188.  
  189. Switches on the user attribute you specify for every user at the specified
  190. security.  If security is ALL then the attribute is switched on for all
  191. security levels.
  192.  
  193. Valid User Attributes:
  194.      0. Deleted                       9. Log On New Files Check
  195.      1. Screen Clear Codes           10. No D/l Ratio
  196.      2. Page Pause                   11. Female
  197.      3. Graphics                     12. Delete File After Viewing
  198.      4. No Kill                      13. Display File Once
  199.      5. Ignore D/l Hours             14. File Viewed
  200.      6. ANSI Editor                  15. Full Screen Viewer
  201.      7. Do Not Disturb               16. Combined Mail Check
  202.      8. Log On Mail Check            17. No Hotkeys
  203.  
  204. *end*
  205.  
  206. *global flag reset*
  207.  
  208. Parameters
  209. ──────────
  210. Security: 0 - 32767 or ALL
  211. Flag:     A1 - D8
  212.  
  213. Switches off the user flag you specify for every user at the specified
  214. security level.  If the security is ALL then the flag will be reset for
  215. all security levels.
  216.  
  217. *end*
  218.  
  219. *global flag set*
  220.  
  221. Parameters
  222. ──────────
  223. Security: 0 - 32767 or ALL
  224. Flag:     A1 - D8
  225.  
  226. Switches on the user flag you specify for every user at the specified
  227. security level.  If the security is ALL then the flag will be set for all
  228. security levels.
  229.  
  230. *end*
  231.  
  232. *global high msg reset*
  233.  
  234. Parameters
  235. ──────────
  236. Message Number: 0 - 32767
  237.  
  238. Resets 'highest message read' counter for all users to the number
  239. specified on the command line.
  240.  
  241. *end*
  242.  
  243. Resets all users colors to the default specified in the SBBS config.
  244.  
  245. *upgrade security*
  246.  
  247. Parameters
  248. ──────────
  249. Control File: Any file found in the SUtil home directory.
  250.  
  251. Scans the user base and upgrades any users that meet the criteria as
  252. listed in the specified control file.  The control file is a text file
  253. with one spec per line as follows:
  254.  
  255. <current security> <new security> <msgs> <upk> <calls>
  256.  
  257. Each line contains old and new security specs and the criteria that must
  258. be matched in order to be upgraded to the new security, each number is
  259. seperated by a space.  Any missing numbers will cause SUtil to barf in a
  260. big way.
  261.  
  262. Each user must be at the 'current security' and have at least the number
  263. of messages, uploads in KB's and calls specified in order to be upgraded
  264. to the 'new security'.  If you are not concerned what the current security
  265. is, so long as they meet the other qualifications, then put '-1' as the
  266. current security.  If you are not concerned about any of the
  267. qualifications (msgs,upk,calls) then put '0' for that parameter.  Any line
  268. beginning with a semi-colon (;) is treated as a remark and is ignored.
  269.  
  270. For example:
  271.  
  272. ;sample upgrade security control file
  273. 5 10 20 100 20
  274. 10 20 0 0 20
  275. -1 30 100 400 50
  276.  
  277. For the first line, any users currently at level 5 will be upgraded to
  278. level 10 if they have entered 20 or more messages AND uploaded 100KB or
  279. more AND called 20 or more times.  For the second line, any users
  280. currently at level 10 will be upgraded to level 20 if they have called 20
  281. or more times (because the other parameters are 0 they are effectively not
  282. used).  For the third line, any users, regardless of their current level,
  283. will be upgraded to level 30 if they have written 100 or more messages AND
  284. uploaded 400 KB or more AND have called 50 or more times.
  285.  
  286. *end*
  287.  
  288. *user list*
  289.  
  290. Parameters
  291. ──────────
  292. Options: CITY|SECURITY|ALIAS|DOB|AGE|HOMEPHONE|DATAPHONE
  293.          FIRSTCALL|UPS|UPK|DOWNS|DOWNK|RATIOK|MSGS|CALLS
  294.          MINUTES|COMMENT
  295.          FORM (output format - defaults to list format)
  296.  
  297. Makes a list of all users including the information specified on the
  298. command line.  Any combination of options is allowed.  For example:
  299.  
  300. USERLIST ALIAS SECURITY
  301.  
  302. will produce a list of users' names and their aliases and security. If you
  303. include FORM on the command line the output will be formatted one field
  304. per line, otherwise it is in list format.
  305.  
  306. *end*
  307.  
  308. *find users*
  309.  
  310. Parameters
  311. ──────────
  312. Security:  0 - 32767 or none
  313. Attribute: 0 - 15 or none
  314. Options: NOT or none
  315.  
  316. Will list any users it finds that matches the criteria on the command
  317. line.  You can use either security or flags or both.  If you use only one
  318. criteria, it will list all users that match it.  If you use both criteria,
  319. it will list all users that match both.  The /S and /F switches are not
  320. required when running in the environment.  Options for other keywords
  321. include NOT, which will report all users not matching the given criteria.
  322.  
  323. At the DOS prompt:
  324.  
  325. FINDUSERS /S20
  326.  
  327. Finds all users with security level 20.
  328.  
  329. FINDUSERS NOT /S20
  330.  
  331. Finds all users not at security level 20.
  332.  
  333. FINDUSERS /Fa1
  334.  
  335. Finds all users with flag A1 set.
  336.  
  337. FINDUSERS /S20 /Fa1
  338.  
  339. Finds all users with security level 20 AND flag A1 set.
  340.  
  341. *end*
  342.  
  343. *search users*
  344.  
  345. Parameters
  346. ──────────
  347. Search String: Any string to look for.
  348.  
  349. Searches user records and reports any occurrances of the specified string.
  350. This is useful for finding users in the same town or area code or users
  351. that have suspiciously similar passwords or maybe a number of users have
  352. the same phone number.
  353.  
  354. *end*
  355.  
  356. *lost carrier report*
  357.  
  358. Parameters
  359. ──────────
  360. Entries: Number of entries to include
  361.  
  362. Displays a sorted list of users who have dropped carrier.  'Entries' is
  363. the maximum number of entries to include.  If omitted, all users who have
  364. dropped carrier are included.
  365.  
  366. *end*
  367.  
  368. *lost carrier reset*
  369.  
  370. Parameters
  371. ──────────
  372. User Name: User's name to reset or ALL
  373.  
  374. Resets the lost carrier counter for the specified user.  If the user name
  375. is ALL then all users are reset.
  376.  
  377. *end*
  378.  
  379. ─────────────────────────────────────────────────────────────────────────
  380.  
  381. *files menu*
  382. AVAILABLE FUNCTIONS
  383. ───────────────────
  384. VIEW FILES LISTS          View a selected FILES.BBS file
  385. SBBS DOWNLOAD COUNTER     Update download counters from SBBS log
  386. BIMODEM DOWNLOAD COUNTER  Update download counters from Bimodem log
  387. FRONT DOOR D/LOAD COUNTER Update download counters from Front Door log
  388. DBRIDGE DOWNLOAD COUNTER  Update download counters from DBridge log
  389. POP DOWNLOAD COUNTER      Update download counters from Portal log
  390. MAKE MASTER FILES LISTS   Create master files list and newfiles list
  391. SORT FILES                Sort selected FILES.BBS
  392. ADD UNLISTED FILES        Add unlisted files to FILES.BBS
  393. PACK FILES LISTS          Pack selected FILES.BBS
  394. HURL FILES                Hurl selected files to a new area
  395. LOCAL FILE ATTACH         Create a local file attach
  396. ANNOUNCE NEW FILES        Create new files announcement in message base
  397. CREATE FREQ DIR LIST      Create text file list of freq directories
  398. SEARCH FILES LISTS        Search files lists for given string
  399. SORT FLSEARCH             Sort files config
  400. FILES BASE INFORMATION    Files base information
  401.  
  402. *end*
  403.  
  404. *Super BBS download counter*
  405.  
  406. Parameters
  407. ──────────
  408. Log File: Full path and file name of log file.
  409.  
  410. Updates the download counters in your FILES.BBS files according to entries
  411. in the Super BBS log file.  Specify the complete path, file name and
  412. extension of the log on the command line.  This function may barf the
  413. first time you use it on a log file greater than around 1 MB.  You will
  414. need to trim the log until scount works. After that the size is not
  415. important.
  416.  
  417. *end*
  418.  
  419. *bimodem download counter*
  420.  
  421. Parameters
  422. ──────────
  423. Log File: Full path and file name of log file.
  424.  
  425. Updates the download counters in your FILES.BBS files according to entries
  426. in the BiModem log file.  Specify the complete path, file name and
  427. extension of the BiModem log on the command line.  This function may barf
  428. the first time you use it on a log file greater than around 1 MB.  You
  429. will need to trim the log until bimcount works. After that the size is not
  430. important.
  431.  
  432. *end*
  433.  
  434. *front door download counter*
  435.  
  436. Parameters
  437. ──────────
  438. Log File: Full path and file name of log file.
  439.  
  440. Updates the download counters in your FILES.BBS files according to entries
  441. in the Front Door log file.  Specify the complete path, file name and
  442. extension of the FD log on the command line.  This function may barf the
  443. first time you use it on a log file greater than around 1 MB.  You will
  444. need to trim the log until fdcount works.  After that the size is not
  445. important.
  446.  
  447. *end*
  448.  
  449. *dbridge download counter*
  450.  
  451. Parameters
  452. ──────────
  453. Log File: Full path and file name of log file.
  454.  
  455. Updates the download counters in your FILES.BBS files according to entries
  456. in the DBridge log file.  Specify the complete path, file name and
  457. extension of the DB log on the command line.  This function may barf the
  458. first time you use it on a log file greater than around 1 MB.  You will
  459. need to trim the log until dbcount works.  After that the size is not
  460. important.
  461.  
  462. *end*
  463.  
  464. *portal download counter*
  465.  
  466. Parameters
  467. ──────────
  468. Log File: Full path and file name of log file.
  469.  
  470. Updates the download counters in your FILES.BBS files according to entries
  471. in the Portal Of Power log file.  Specify the complete path, file name and
  472. extension of the log on the command line.  This function may barf the
  473. first time you use it on a log file greater than around 1 MB.  You will
  474. need to trim the log until popcount works.  After that the size is not
  475. important.
  476.  
  477. *end*
  478.  
  479. *master files lists*
  480.  
  481. Parameters
  482. ──────────
  483. List File Name:     Name of list file to create.
  484. New List File Name: Name of new files list to create.
  485. Security:           Highest security to include.
  486. Days:               Days to include in new files list.
  487.  
  488. Creates a files list of all the files areas listed in the FLSEARCH.BBS
  489. file including only those areas with security equal to or less than that
  490. specified.  Will include at the top of the list the contents of a file
  491. BANNER.TXT if found.  SUtil reads the default.lng file or any language
  492. file found in the system directory to get the string for files not found.
  493. Also creates the new files list as set on the command line.  This list
  494. includes files in the security allowed areas that are equal to or younger
  495. than that specified.
  496.  
  497. *end*
  498.  
  499. *hurl file*
  500.  
  501. Parameters
  502. ──────────
  503. Source:       Directory and file names of files to hurl.
  504. Destination:  Destination directory for files.
  505.  
  506. Hurls one or more files and descriptions anywhere within your defined
  507. files base.  No need to type in the whole path, just the file's own
  508. directory and file name and the destination directory.  For example if a
  509. user has just uploaded HOST44.ZIP and you want to put it in the TELIX
  510. directory, type the following:
  511.  
  512. Source:       UPLOADS\HOST44.ZIP
  513. Destination:  TELIX
  514.  
  515. This might translate to:
  516.  
  517. From: C:\SUPERBBS\FILES\UPLOADS\HOST44.ZIP
  518. To:   C:\SUPERBBS\FILES\TELIX\HOST44.ZIP
  519.  
  520. or whatever is configured in your flsearch.bbs file.  If a file can't be
  521. found then just the description will be hurled.  If neither a file or it's
  522. description can be found then no action will be taken.
  523.  
  524. You can specify multiple source files to hurl.  For example, a user has
  525. just uploaded the Telix package in three files which you want to hurl to
  526. the Telix area.
  527.  
  528. Source:       UPLOADS\TLX315-1.ZIP TLX315-2.ZIP TLX315-3.ZIP
  529. Destination:  TELIX
  530.  
  531. This will hurl all three files from the Uploads area to the Telix area.
  532.  
  533. Or alternatively, you can use wildcards such as the following:
  534.  
  535. Source:       UPLOADS\TLX315*.*
  536. Destination:  TELIX
  537.  
  538. or even:
  539.  
  540. Source:       UPLOADS\TLX315-?.ZIP
  541. Destination:  TELIX
  542.  
  543. *end*
  544.  
  545. *local file attach*
  546.  
  547. Parameters
  548. ──────────
  549. User:        User to receive file.
  550. File:        File to attach.
  551. Description: Optional description to appear in files.bbs.
  552.  
  553. This function allows you to do a local file attach to a user at the dos
  554. prompt or maybe do daily file attaches to co-sysops from the daily
  555. maintenance.  Gets the file attach directory from the SCONFIG.BBS file and
  556. checks that the user exists in the user base. The description is optional.
  557. If running from the command line you must use underscores in place of
  558. spaces when typing the user name and description, if running from the
  559. environment it is not necessary.
  560.  
  561. *end*
  562.  
  563. *announce new files*
  564.  
  565. Parameters
  566. ──────────
  567. Message Board: Board number of Hudson message to post announcement.
  568. Exclude File:  Optional exclude file found, in SUtil home directory,
  569.                listing files/paths to exclude.
  570.  
  571. Creates a message describing new files on the system.  Initially, this
  572. function will create a zero length file called "announce" in the 'home'
  573. directory of SUtil.  This is used to remember the last date that this
  574. function was run, so that the next time it is run it will compare file
  575. dates against this date to decide which is new.  Each successive time it
  576. is run it will update the date on this file.  This way you can run it
  577. daily, weekly or whenever you like and it will catch all the new files
  578. since the last time it was run.  To alter the last date simply alter the
  579. date on this file or delete it altogether to start again from today.
  580.  
  581. The optional exclude file is a text file listing paths and/or files you
  582. wish to exclude from the new files announcement.  The paths must have a
  583. trailing backslash.  Comments must start with a semi-colon (;).  For
  584. example:
  585.  
  586. ;exclude file for announce function
  587. c:\superbbs\files\uploads\
  588. c:\superbbs\files\private\
  589. c:\superbbs\files\rough\rough.zip
  590.  
  591. *end*
  592.  
  593. *create d/l dir list file*
  594.  
  595. Parameters
  596. ──────────
  597. File Name: Full path and file name of text file to create.
  598. Security:  Security to include in file.
  599.  
  600. Creates a text file containing full paths to your files area including
  601. areas of specified security or lower.  This file is used, for example, by
  602. Front Door to search for file requested files.  For example:
  603.  
  604. SUTIL FRDIRS C:\FD\DIRS.FRQ 5
  605.  
  606. *end*
  607.  
  608. *search files*
  609.  
  610. Parameters
  611. ──────────
  612. Search String: Any combination of characters to look for.
  613.  
  614. Searches all files.bbs files for the given search string and reports any
  615. areas it was found in.  Case not sensitive.
  616.  
  617. *end*
  618.  
  619. *sort flsearch*
  620.  
  621. Parameters
  622. ──────────
  623. Mode: N = Area Name
  624.       A = Ascending security
  625.       D = Descending security
  626.  
  627. Sorts the files area config file according to the mode specified. The mode
  628. can be stacked.  For example SORTFLSEARCH NA will sort by area name and
  629. then by ascending security.  Think in reverse when stacking the sort mode.
  630. For example if the first priority is security, it should be the last entry
  631. in the sort mode.
  632.  
  633. *end*
  634.  
  635. ─────────────────────────────────────────────────────────────────────────
  636.  
  637. *message base menu*
  638. AVAILABLE FUNCTIONS
  639. ───────────────────
  640. POST FILE TO MESSAGE      Post text file to message base
  641. TWIT FILTER               Delete any message with selected subject/author
  642. CLEAN MESSAGE HEADERS     Remove 're:' from message headers
  643. MESSAGE BASE REPORT       Message base report
  644.  
  645. *end*
  646.  
  647. *post file to message base*
  648.  
  649. Parameters
  650. ──────────
  651. Board Number: Hudson message base board number.
  652. File Name:    Name of text file to post.
  653. To:           Person to receive message.
  654. From:         Who is message from.
  655. Subject:      Message subject.
  656.  
  657. Works similar to many mail tossing programs.  Allows you to post a text
  658. file as a message to the hudson message base.  If running from the command
  659. line, each parameter must have underscores in place of spaces.  If running
  660. from the environment this is not necessary.  If you include the /D
  661. parameter after the subject parameter the file will be deleted after
  662. posting.
  663.  
  664. *end*
  665.  
  666. *twit filter*
  667.  
  668. Parameters
  669. ──────────
  670. Options: /F<name>    = delete messages from a person
  671.          /S<subject> = delete message with a subject
  672.  
  673. Marks as deleted any messages written by a particular person or any
  674. messages with the given text included in the subject.  Use only one of
  675. either the person, subject or specification file on the command line.  For
  676. example:
  677.  
  678. TWIT /FGlenn Delahoy
  679.  
  680. Will delete any messages from Glenn Delahoy.
  681.  
  682. TWIT /Stest
  683.  
  684. Will delete any messages that have 'test' included in the subject line.
  685.  
  686. TWIT @sutil.twt
  687.  
  688. Will read the text file 'sutil.twt' to get the specifications.  The spec
  689. file has one spec per line, each starting with either /F or /S for the
  690. From field or the Subject field.  It is not case sensitive and does not
  691. need underscores.
  692.  
  693. *end*
  694.  
  695. ─────────────────────────────────────────────────────────────────────────
  696.  
  697. *system files menu*
  698. AVAILABLE FUNCTIONS
  699. ───────────────────
  700. PLAY YELL FILE            Play a yell control file
  701. PAMS2BBS                  Create bbs list from Pams list
  702. NODE2BBS                  Create bbs list from nodelist
  703. TRIM SYSTEM LOG           Trim system log file
  704. POST NODE NEWS            Extract news from nodelist and post to msg base
  705. UPDATE FD INBOUND         Add SBBS last caller to FD inbound
  706. UPDATE SBBS INBOUND       Add FD last caller to SBBS inbound
  707. HIDE LOCAL CALLS          Convert local calls to new baud
  708. VIEW BBS LIST             View any BBSLIST file
  709.  
  710. *end*
  711.  
  712. *play yell file*
  713.  
  714. Parameters
  715. ──────────
  716. Yell File: Full path and name of yell file.
  717.  
  718. Plays the yell control file approximately how it would be heard from the
  719. bbs.  The speed seems to be machine dependant, otherwise it's pretty
  720. accurate.
  721.  
  722. *end*
  723.  
  724. *pams to bbs list*
  725.  
  726. Parameters
  727. ──────────
  728. File:  Full path and name of Pams 'all' file.
  729. State: Which state to include.
  730.  
  731. Creates a BBSLIST.BBS file from the Australian BBS directory 'all' file
  732. that can be used with the SBBS bbs list functions.  As of the last release
  733. of the Aust BBS directory, the file required for this function is called
  734. BBSAALL.DAT.  As this may change in the future I have made this file a
  735. command line option.  The second option is the state you want listed.
  736.  
  737.        {state    = VIC, NSW, QLD, ACT, NT, SA, TAS, WA}
  738.  
  739. *end*
  740.  
  741. *nodelist to bbs list*
  742.  
  743. Parameters
  744. ──────────
  745. Zone:Net: Which zone and net to include.
  746.  
  747. Creates a BBSLIST.BBS file from a fido compatible nodelist.  It searches
  748. the SBBS config file to find the nodelist directory, then looks for the
  749. first nodelist in that directory.  Note that this is not necessarily the
  750. latest one.  You must specify zone and net numbers.  For example, 3:635,
  751. is zone 3, net 635.  To specify all nets in a zone type, 3:0.  If the zone
  752. isn't found you get a nice zero length bbslist file.
  753.  
  754. *end*
  755.  
  756. *trim system log file*
  757.  
  758. Parameters
  759. ──────────
  760. File: Full path and name of system log file.
  761. Days: Number of days to keep.
  762.  
  763. Scans specified system log file and removes entries older than specified
  764. number of days.  Before it starts it makes a copy of the log file to *.BAK
  765. so in case it dies half way you can recover the log.  If a *.BAK file
  766. already exists it is deleted.
  767.  
  768. *end*
  769.  
  770. *post node news*
  771.  
  772. Parameters
  773. ──────────
  774. Msg Board: Hudson message base board to post to.
  775.  
  776. Extracts any news bulletins in the current nodelist and writes it to a
  777. message area specified on the command line.  Put this after your nodediff
  778. update.
  779.  
  780. *end*
  781.  
  782. *sbbs last call to fd*
  783.  
  784. Parameters
  785. ──────────
  786. Front Door Directory: Full path to FD directory
  787.  
  788. Examines the SCALLER.BBS file to get the last caller online. Inserts this
  789. info into the Front Door INBOUND.HIS and LASTCALL.FD files.  You can then
  790. use the FD inbound history to see what bbs callers you've had and the last
  791. caller shows up on the FD main screen.  Note that SBBS doesn't put the
  792. SysOp into the SCALLER.BBS file.  The last caller will be the last caller
  793. that isn't the SysOp.  In the FD inbound history the received bytes will
  794. be the caller's total uploads, the sent bytes will be the caller's
  795. downloads for today and the cost will be the caller's age.
  796.  
  797. If you run FD 2.02 then you do not need the dir parameter.  If you are
  798. running the commercial version (2.10) then the dir parameter should point
  799. to the Front Door system directory where all inbound and lastcall files
  800. are stored.  If this parameter is used SUtil will look for the TASK
  801. environment variable used by FD to construct the file names INBx.HIS and
  802. LASTCx.FD where 'x' is the TASK number.
  803.  
  804. In summary:
  805.  
  806. If you have FD 2.02 then
  807.  
  808. SUTIL CALLERS
  809.  
  810. will update INBOUND.HIS and LASTCALL.FD files.
  811.  
  812. If you have FD 2.10 then
  813.  
  814. SUTIL CALLERS [dir]
  815.  
  816. will update INBx.HIS and LASTCx.FD files in the 'dir' directory using the
  817. TASK environment variable for 'x'.
  818.  
  819. This has only been tested with FD 2.02 and 2.10.
  820.  
  821. *end*
  822.  
  823. *fd last call to sbbs*
  824.  
  825. Parameters
  826. ──────────
  827. Front Door Directory: Full path to FD directory.
  828.  
  829. Examines the Front Door LASTCALL file to get the last mail call. Inserts
  830. this info into the SBBS SCALLERS file.  You can then use the SBBS 'view
  831. today's callers' or 'view last 15 callers' to see what mail calls you've
  832. had.  Because FD doesn't store the log on and log off time seperately
  833. these will be the same in the scallers file. Also the baud and age are not
  834. known.
  835.  
  836. If you run FD 2.02 then you do not need the dir parameter.  If you are
  837. running the commercial version (2.10) then the dir parameter should point
  838. to the Front Door system directory where all inbound and lastcall files
  839. are stored.  If this parameter is used SUtil will look for the TASK
  840. environment variable used by FD to construct the file names INBx.HIS and
  841. LASTCx.FD where 'x' is the TASK number.
  842.  
  843. In summary:
  844.  
  845. If you have FD 2.02 then
  846.  
  847. SUTIL FDCALLERS
  848.  
  849. will read INBOUND.HIS and LASTCALL.FD files.
  850.  
  851. If you have FD 2.10 then
  852.  
  853. SUTIL FDCALLERS [dir]
  854.  
  855. will read INBx.HIS and LASTCx.FD files in the 'dir' directory using the
  856. TASK environment variable for 'x'.
  857.  
  858. This has only been tested with FD 2.02 and 2.10.
  859.  
  860. *end*
  861.  
  862. *hide local calls*
  863.  
  864. Parameters
  865. ──────────
  866. New Baud: New baud to replace 0 baud entries.
  867.  
  868. Scans SCALLER.BBS and converts any baud settings of 0 to new setting
  869. specified.  This has the effect of making local log-ons look like remote
  870. calls when viewing Today's Calls and Last 15 Callers.
  871.  
  872. *end*
  873.  
  874. *view bbs list*
  875.  
  876. Parameters
  877. ──────────
  878. File: Any bbslist file (default=BBSLIST.BBS)
  879.  
  880. Displays the given bbslist file.  If no file is given, the default
  881. BBSLIST.BBS will be displayed.  Any valid file name is allowed.
  882.  
  883. *end*
  884.  
  885. ─────────────────────────────────────────────────────────────────────────
  886.  
  887. *doors menu*
  888. This set of functions maintains and reports door usage.  Useful for
  889. determining the popularity, or lack of, of your on-line doors.  This has
  890. only been tested with SBBS 1.16b.  In this version there is a little spare
  891. room in the door templates which may be used by Aki in later versions.
  892.  
  893. AVAILABLE FUNCTIONS
  894. ───────────────────
  895. UPDATE DOOR COUNTER       Update a selected door counter
  896. RESET DOOR COUNTER        Reset a seleced door counter to 0
  897. CREATE GRAPHS             Create ANS/ASC graph of door counters
  898. DOORS REPORT              Report config for all active doors
  899.  
  900. *end*
  901.  
  902. *update door counter*
  903.  
  904. Parameters
  905. ──────────
  906. Door Number: Which door to update.
  907.  
  908. Updates the door counter for the given door template number.  Insert this
  909. into your doors batch file after each door exits and before the bbs
  910. restarts.  Eg:
  911.  
  912. SUTIL DOORUPDATE 14
  913.  
  914. This adds one to the counter for door number 14 in the template.
  915.  
  916. *end*
  917.  
  918. *reset door counter*
  919.  
  920. Parameters
  921. ──────────
  922. Door Number: Which door to reset.
  923.  
  924. Resets the door counter for the given door template number to 0.  If you
  925. remove a door from the bbs or replace it with a new one you will want to
  926. reset it's template counter to get an accurate picture of it's popularity.
  927. Eg:
  928.  
  929. SUTIL DOORRESET 14
  930.  
  931. To reset all doors to 0 type:
  932.  
  933. SUTIL DOORRESET ALL
  934.  
  935. *end*
  936.  
  937. ─────────────────────────────────────────────────────────────────────────
  938.  
  939. *miscellaneous menu*
  940. AVAILABLE FUNCTIONS
  941. ───────────────────
  942. SYSTEM INFORMATION        Useful overall information on your bbs
  943. RENAME FILE TO DATE       Rename a file using today's date
  944. MESSAGE LOST CARRIER      Post a message to callers who drop carrier
  945. CREATE FILE REQUEST       Create file request in netmail directory
  946. CREATE FILE ATTACH        Create file attach in netmail directory
  947. RUN SCRIPT FILE           Run selected script file
  948.  
  949. *end*
  950.  
  951. *rename file with today's date*
  952.  
  953. Parameters
  954. ──────────
  955. File: Full path and name of file to rename.
  956.  
  957. Renames the specified file using today's date in the format yy-mm-dd.ext.
  958. For example to rename the system log type:
  959.  
  960. SUTIL DATEFILE \SUPERBBS\SYSTEM.LOG
  961.  
  962. The resulting file would be:
  963.  
  964. \SUPERBBS\92-05-30.LOG
  965.  
  966. ... or whatever the date happens to be.  The reason for the particular
  967. format for the date is when Xtree or other such program lists the files in
  968. alphabetical order these files will show up in the correct chronological
  969. order.  Here's a little segment of my daily maintenance batch file that
  970. makes a daily backup of the user base.
  971.  
  972. cd \superbbs
  973. pkzip \superbbs\backup\userbak lastread.bbs nameidx.bbs users.bbs
  974.  susers.bbs
  975. sutil datefile \superbbs\backup\userbak.zip
  976.  
  977. If the file name it wants to use to rename the file already exists it will
  978. attempt to rename the extension until it finds an unused file name.
  979.  
  980. *end*
  981.  
  982. *post msg to lost carrier*
  983.  
  984. Parameters
  985. ──────────
  986. Log File:  Full path and name of system log file.
  987. Text File: Text file to post.
  988. Board:     Hudson message base board to post to.
  989.  
  990. Scans the system log and looks for callers who have dropped carrier. It
  991. then reads the text file replacing any parameters and posts it to the
  992. caller in the specified board number.
  993.  
  994. Replacable parameters are:
  995. ^D (ASCII 4)  Date caller dropped carrier
  996. ^T (ASCII 20) Time caller dropped carrier.
  997.  
  998. *end*
  999.  
  1000. *matrix file request*
  1001.  
  1002. Parameters
  1003. ──────────
  1004. Attrib:  Netmail attributes.
  1005. Address: Fido compatible address.
  1006. Files:   List of files to request.
  1007.  
  1008. Creates a file request MSG in your netmail directory as specified in your
  1009. SBBS config.  Each file should be separated by a space.  The msg packet
  1010. attributes are set as specified by the 'attrib' parameter.
  1011.  
  1012.              Valid netmail attributes:
  1013.              P = private     C = crash
  1014.              K = kill        H = hold
  1015.              D = direct      I = immediate
  1016.              N = none
  1017.  
  1018. *end*
  1019.  
  1020. *matrix file attach*
  1021.  
  1022. Parameters
  1023. ──────────
  1024. Attrib:  Netmail attributes.
  1025. Address: Fido compatible address.
  1026. File:    File to attach.
  1027.  
  1028. Creates a file attach MSG in your netmail directory as specified in your
  1029. SBBS config.  The msg packet attributes are set as specified by the
  1030. 'attrib' parameter.
  1031.  
  1032.              Valid netmail attributes:
  1033.              P = private     C = crash
  1034.              K = kill        H = hold
  1035.              D = direct      I = immediate
  1036.  
  1037. *end*
  1038.  
  1039. *run script file*
  1040.  
  1041. Parameters
  1042. ──────────
  1043. Script File: Name of script file to run from the 'home' directory.
  1044.  
  1045. Performs the commands contained in the specified script file. Each line of
  1046. the file should have one command typed exactly how you would normally type
  1047. it on the DOS command line, minus the SUTIL bit of course.  Any line
  1048. beginning with a semi-colon (;) is treated as a remark and is ignored.
  1049. From within a script file you can call another script file much the same
  1050. way that DOS can call a batch file from within a batch file.  When it has
  1051. finished the embedded script file, it returns and continues on the first
  1052. one.
  1053.  
  1054. *end*
  1055.  
  1056. ─────────────────────────────────────────────────────────────────────────
  1057.  
  1058. *external menu*
  1059.  
  1060. This menu allows you to add any external utilities to the SUtil
  1061. environment.  For example, you might want to add the user editor, menu
  1062. editor, ansi editor and the snet manager programs.  Create a text file in
  1063. the SUtil 'home' directory called EXTERNAL.MNU with one entry per line.
  1064. Each line consists of the name as it will appear on the menu, then the
  1065. directory SUtil will change to, then the program to run.  Each parameter
  1066. is separated by the '|' character.  For example, you might have something
  1067. like this:
  1068.  
  1069. EXTERNAL.MNU
  1070. SNet Manager|c:\superbbs\node1|snetmgr.exe
  1071. User Editor|c:\superbbs|sbbsuser.exe
  1072. Menu Editor|c:\superbbs|sbbsmenu.exe
  1073. Ansi Editor|c:\superbbs\text|d:\thedraw\thedraw.exe
  1074. Text Editor|c:\superbbs\text|q.exe
  1075. Config Line 1|c:\superbbs\node1|c:\superbbs\config.exe
  1076. Config Line 2|c:\superbbs\node2|c:\superbbs\config.exe
  1077. Edit SUtil Files|c:\superbbs\sutil|q
  1078.  
  1079. *end*
  1080.  
  1081. ─────────────────────────────────────────────────────────────────────────
  1082.  
  1083. *select files area*
  1084.  
  1085. Highlight the files area you want to work on and press Enter.
  1086.  
  1087. *end*
  1088.  
  1089. *save report*
  1090.  
  1091. Parameters
  1092. ──────────
  1093. File Name: Full path and name to save report to.
  1094.  
  1095. Reports are normally deleted when you are finished but you can save them
  1096. for later perusal.  Type the full path and name for any valid DOS file
  1097. name and the current report will be saved to that file.
  1098.  
  1099. *end*
  1100.  
  1101. *report*
  1102.  
  1103. Valid keys for navigating the report screen:
  1104.  
  1105. Cursor Left:  Move one column to the left.
  1106. Cursor Right: Move one column to the right.
  1107. Page Up:      Move one page backwards.
  1108. Page Down:    Move one page forwards.
  1109. Home:         Move to first column on current line.
  1110. End:          Move to last column on current line.
  1111. Cntl-Home:    Move to first line on current column.
  1112. Cntl-End:     Move to last line on current column.
  1113. Esc:          Return to previous menu.
  1114. F1:           This help screen.
  1115. F2:           Save report to text file.
  1116. F3:           Edit report.
  1117. F4:           Search for given string.
  1118. F10:          Save report to printer.
  1119.  
  1120. To edit a report or files list from the report viewer, you need to create
  1121. a batch file called EDIT.BAT which can reside in the current directory or
  1122. anywhere in the DOS path.  This batch file will call your favorite text
  1123. editor.
  1124.  
  1125. *end*
  1126.  
  1127. *search*
  1128.  
  1129. Enter the string you want to search for.  Case is not sensitive.  Starts
  1130. search from the current position in the file.  To start the search from
  1131. the beginning of the file press Ctl-Home then F4.
  1132.  
  1133. *end*
  1134.  
  1135.