OVERVIEW
The following utilities will be discussed in this document:
- aidepost Post standard input to the Aide> room. NOTE: called by chat.c
- whobbs Who is on the system (connected to the server, actually.)
- stats Print the calling statistics & graph.
- msgform Format a binary message to the screen (stdin or in a file)
- userlist Print the userlist.
- readlog Read the caller log
- useradmin Full-screen user account editor. NOTE: requires the "curses" lib
- sysoputil Various and sundry sysop utilities.
+ aidepost Post standard input to the Aide> room
+ whobbs Who is on the system
+ stats Print the calling statistics & graph
+ msgform Format a binary message to the screen (stdin or in a file)
+ userlist Print the userlist
+ readlog Read the caller log
+ sendcommand Send a server command
It is up to you to decide which utilities should be made accessible only
to sysops. It is important that you set the file permissions correctly. All
-utilities should have access to the BBS data files, whether through ownership
-or set-user-id. In addition, aidepost should be accessible by the chat program,
-and userlist & whobbs should be accessible by citadel. I will attempt to
+utilities should have access to the BBS data files. We will attempt to
address each program individually.
The nature of this program is rather simple. Standard input (stdin) is
converted into a message, filed in the main message file (msgmain), and posted
in the Aide> room. This is useful for keeping transcripts of system activity
-that has to do with the BBS. You may also wish to have a really BIG msgmain
-file, and have all of your normal system logs go in there also.
+that has to do with the BBS. You might even elect to send all of your system
+logs there, too.
+
+ aidepost also accepts the usage "aidepost -rTargetRoom", where TargetRoom
+is the name of a room to which you'd like the message to be sent.
WHOBBS
file. This file records all times the Citadel/UX program has been started, and
at what baud rate, as well as logins, proper logouts, loss of carrier (SIGHUP),
bad password attempts, and new user logins.
+
-
- USERADMIN
-
- Useradmin is a full-screen program to view and edit any user's account.
-The program will prompt for a user name. After you enter the name, various
-parameters of the user's account will appear on the screen. To change one
-of the parameters, simply enter its number.
+ SENDCOMMAND
- 1. User name - you may change a user's name at any time. If you do this,
-the hash table to the user file will be rewritten when you exit useradmin.
- 2. User number - if you change a user's number, keep in mind that the user's
-account will no longer be attached to any other records which are indexed by
-user number, such as registration, room aide assignments, etc. These must be
-changed as well.
- 3. UID attachment - if you wish to attach a BBS account to an /etc/passwd
-account, simply make the uid's the same. Likewise, if a user is to no longer
-have an account in /etc/passwd, simply set this to the same as BBSUID. Note
-that the user's "full name" in /etc/passwd MUST be the same as their BBS login
-name, otherwise a new (and probably unwanted) account will be created.
- 4. Password - these four fields are self explanatory.
- 5. Screen width
- 6. Times called
- 7. Messages posted
- 8. Last call - Date and time of last call. If you select this,
-it will not prompt for a new time, but set it to the current time.
- 9. Access Level - choose from the standard access levels:
- 0 = Marked for deletion
- 1 = New unvalidated user
- 2 = Problem user
- 3 = Validated user without network privileges
- 4 = Validated user with network privileges
- 5 = Preferred user
- 6 = Aide
-
- The rest are boolean flags. Selecting them will toggle the options.
- 10. Permanent user (do not scroll off)
- 11. Print last old message on new message request
- 12. Expert mode (supress automatic hints)
- 13. Do not list in .RU command
- 14. Prompting after each message
- 15. Registered in the registration file
- 16. Pause after each screenful of text
-
- In addition, if the user is registered, you can type -1 to make the
-corresponding record in the registration file appear on the screen.
- When you are finished examining or editing an account, type 0 to exit. It
-will ask you if you wish to save the changes.
-
-
- SYSOPUTIL
-
- This program handles some of the sysop functions of the system. It can
-be called three ways: sysoputil by itself brings up the menu. Also:
- sysoputil -u Execute option 7 (user purge) and exit
- sysoputil -r Execute option 1 (room purge) and exit
-
- The menu choices are as follows:
+ sendcommand will interpret its arguments (except for "-hDIRNAME") as a
+server command, which is sent to the server. Commands which require textual
+input will read it from stdin. Commands which generate textual output will
+be sent to stdout.
- 1. Purge old rooms. This will delete any rooms which have not been written
-to (posted in) in two weeks. Notification of purged rooms is posted in the
-Aide> room (using the aidepost utility).
- 7. Purge old users. This will delete any users which have not called in
-two months. Notification of purged users is posted in the Aide> room (using
-the aidepost utility).
- 9. Quit
-
+ This utility is intended to be used to enable Citadel server commands to be
+executed from shell scripts. Review the script called "weekly" which ships
+with the Citadel distribution for an example of how this can be used.
+
+ NOTE: be sure that this utility is not world-executable. It connects to the
+server in privileged mode, and therefore could present a security hole if not
+properly restricted.
+
+
+ --------------------------------------------------------------------------
- That should cover all of the included utilities. Comments, suggestions,
-etc. may be sent to ajc@uncnsrd.mt-kisco.ny.us or call UNCENSORED! BBS at
-(914) 244-3252 (modem) or uncnsrd.mt-kisco.ny.us (Internet).
+ That should cover all of the included utilities.
+ For more information, visit the Citadel/UX web site at UNCENSORED! BBS
+ http://uncnsrd.mt-kisco.ny.us
+
projects / citadel.git / blobdiff