home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ftp.wwiv.com
/
ftp.wwiv.com.zip
/
ftp.wwiv.com
/
pub
/
BBS
/
DOCS25.ZIP
/
MENU.DOC
< prev
next >
Wrap
Text File
|
1990-03-11
|
37KB
|
1,425 lines
------------------------------------------------------------------
---/ Telegard Bulletin Board System -- Version 2.5 Standard \---
---( Copyright 1988,89,90 by Eric Oman, Martin Pollard, )---
---\ and Todd Bolitho - All Rights Reserved /---
------------------------------------------------------------------
Menu Command Documentation
March 11, 1990
Telegard Bulletin Board System Menu Command Documentation
Copyright 1988,89,90 by Eric Oman, Martin Pollard, and Todd Bolitho.
All rights reserved.
No part of this publication may be reproduced without the prior
written consent of the copyright holders. All brand and product names
mentioned in this publication are trademarks or registered trademarks
of their respective copyright holders.
Original documentation written by Bill Schram.
Additional documentation provided by Eric Oman, Bill Schram,
John Dixon, and Martin Pollard.
The Telegard development team wishes to extend special thanks to the
following individuals:
Bill Schram, whose extensive work on the original documentation
provided the major portion of this work;
John Dixon, who provided much information on the use of Telegard
and US Robotics high-speed modems;
and all the other individuals who assisted in making Telegard the
product it is today.
___________________________________
T A B L E O F C O N T E N T S
___________________________________
Introduction ..................................................... 1
"-" - File/Menu Commands ......................................... 2
"A" - Archive Manipulation Commands .............................. 5
"B" - Batch File Transfer Commands ............................... 6
"D" - Door Commands .............................................. 7
"F" - File System Commands ....................................... 9
"H" - Hangup Commands ............................................ 12
"M" - Message System Commands .................................... 13
"O" - Miscellaneous Commands ..................................... 15
"U" - AutoMessage Commands ....................................... 18
"*" - SysOp Commands ............................................. 19
Telegard Menu Command Documentation - Version 2.5
______________
INTRODUCTION
______________
On the next few pages are described all the actual commands available
for use in Telegard menus. They are broken up into several sections:
File/menu related, archive manipulation related, batch transfer
related, door related, file system related, hangup related, message
related, other functions (main menu, etc.), automessage related and
SysOp related.
- Page 1 -
Telegard Menu Command Documentation - Version 2.5
__________________________
"-" - FILE/MENU COMMANDS
__________________________
Cmdkeys : "-C"
Function: Display message on commandline (use with linking)
MString : <string>
Cmdkeys : "-F"
Function: Display a text file
MString : [<path>] <filename> [.<ext>]
[<path>] Optional directory location of file.
<filename> An 8-character MS-DOS filename.
[.<ext>] Optional MS-DOS extension, if not ".MSG"
and/or ".ANS".
This command will display a text file. If no <path> is
given, the file is assumed to be located in the AFILES
directory. If no .<ext> is given, Telegard will look for
the standard "*.MSG" and/or "*.ANS" extensions. That is, if
the "*.ANS" version exists and the user's ANSI is enabled,
it will be displayed, otherwise the "*.MSG" is displayed.
Cmdkeys : "-H"
Function: Menu key help (use for ?:Help command)
MString : None
Not really required any more. Telegard will automatically
display the current menu's help file (or the generic short
or long menu) from ANY menu if the user enters a "?".
Cmdkeys : "-L"
Function: Display a line of text
MString : <string>
Cmdkeys : "-Q"
Function: Read an InfoForm questionaire file (answers in .ASW)
MString : <InfoForm questionaire filename>
Cmdkeys : "-R"
Function: Read an InfoForm questionaire answer file
MString : <InfoForm questionaire filename>
If the MString is "", the filename is prompted for.
Cmdkeys : "-S"
Function: Append line to sysop log file (SYSOP.LOG) (use with linking)
MString : <string>
- Page 2 -
Telegard Menu Command Documentation - Version 2.5
Cmdkeys : "-;"
Function: Execute macro
MString : <macro>
This command will enter <macro> into the user's macro
buffer, and the macro will be executed in the same manner as
that of a user-defined macro. All occurances of ";" in the
<macro> string are substituted with <CR>s. Many different
things are possible with this command.
Cmdkeys : "-$"
Function: Prompt for password
MString : <password> [ [;<prompt>] ;<bad-message>]
This command first will display <prompt>, if it exists. If
not, a default ":" prompt will be displayed. If the
password is entered incorrectly, <bad-message> will be
displayed, if it exists, and all further linking will be
terminated. This can be used for special passwords for
remote shelling to DOS, etc.
Cmdkeys : "-^"
Function: Goto menu
MString : <menu file> [ [;C] ;<link command>]
Loads in <menu file> (automatic assumed extension of
".MNU"). If ";C" is specified, the Menu Stack is cleared
BEFORE going to the new menu.
If <link command> is specified, the command with command
letters of <link command> will be executed after the new
menu is loaded. Example: "-^", "msg;C;M" will clear the
Menu Stack, load MSG.MNU, and execute command "M" (Read
Mail).
Cmdkeys : "-/"
Function: Gosub menu
MString : <menu file> [ [;C] [;<link command>] ]
Adds the CURRENT menu to the Menu Stack, and loads in <menu
file> (automatic assumed extension of ".MNU"). If ";C" is
specified, the Menu Stack is cleared BEFORE going to the new
menu.
If <link command> is specified, the command with command
letters of <link command> will be executed after the new
menu is loaded. Example: "-/", "msg;;M" will save the
current menu file on the Menu Stack, load MSG.MNU, and
execute command "M" (Read Mail).
See also Cmdkeys "-\" (Return from menu).
- Page 3 -
Telegard Menu Command Documentation - Version 2.5
Cmdkeys : "-\"
Function: Return from menu
MString : [ [C] [;<link command>] ]
Loads in the last menu file in the Menu Stack. If "C" is
specified, the Menu Stack is cleared BEFORE returning to the
old menu.
If <link command> is specified, the command with command
letters of <link command> will be executed after the new
menu is loaded. Example: "-\", "C;M" will clear the Menu
Stack, return to the previous menu, and execute command "M"
(Read Mail, if the menu returning to is "MSG.MNU").
See also Cmdkeys "-/" (Gosub menu).
- Page 4 -
Telegard Menu Command Documentation - Version 2.5
_____________________________________
"A" - ARCHIVE MANIPULATION COMMANDS
_____________________________________
Cmdkeys : "AA"
Function: Add files to archive
MString : None
Cmdkeys : "AC"
Function: Convert between archive formats
MString : None
Cmdkeys : "AE"
Function: Extract files from archive
MString : None
Cmdkeys : "AG"
Function: Manipulate files extracted from archives
MString : None
Cmdkeys : "AM"
Function: Modify comment fields in archive
MString : None
Cmdkeys : "AR"
Function: Re-archive archive files using same format
MString : None
Cmdkeys : "AT"
Function: Run integrity tests on archives
MString : None
- Page 5 -
Telegard Menu Command Documentation - Version 2.5
____________________________________
"B" - BATCH FILE TRANSFER COMMANDS
____________________________________
Cmdkeys : "BC"
Function: Clear batch queue
MString : [U]
If "U" is specified, the UPLOAD batch queue is cleared.
Cmdkeys : "BD"
Function: Download batch queue
MString : None
Cmdkeys : "BL"
Function: List batch queue
MString : [U]
If "U" is specified, the UPLOAD batch queue is listed.
Cmdkeys : "BR"
Function: Remove single file from batch queue
MString : [U]
If "U" is specified, files from the UPLOAD batch queue can
be removed.
Cmdkeys : "BU"
Function: Upload batch queue
MString : None
Cmdkeys : "B?"
Function: Display number of files left in batch download queue
MString : None
- Page 6 -
Telegard Menu Command Documentation - Version 2.5
_____________________
"D" - DOOR COMMANDS
_____________________
NOTE: As the format of each door file is extensive, please refer to
the file "DOORFMT.TXT", which details the format of each door file
that can be created by Telegard.
Cmdkeys : "DC"
Function: Create CHAIN.TXT (WWIV door) and execute MString
MString : <command to execute>
<command to execute> is the command required to execute the
door. Door MCI codes may be used.
Cmdkeys : "DD"
Function: Create DORINFO1.DEF (RBBS door) and execute MString
MString : <command to execute>
<command to execute> is the command required to execute the
door. Door MCI codes may be used. If the command begins
with "R;", then the user's real name is written to the file
instead of the user's handle (the "R;" is stripped before
being passed to DOS).
Cmdkeys : "DG"
Function: Create DOOR.SYS (GAP door) and execute MString
MString : <command to execute>
<command to execute> is the command required to execute the
door. Door MCI codes may be used.
Cmdkeys : "DS"
Function: Create SFDOORS.DAT (Spitfire door) and execute MString
MString : <command to execute>
<command to execute> is the command required to execute the
door. Door MCI codes may be used. If the command begins
with "R;", then the user's real name is written to the file
instead of the user's handle (the "R;" is stripped before
being passed to DOS).
Cmdkeys : "DW"
Function: Create CALLINFO.BBS (Wildcat! door) and execute MString
MString : <command to execute>
<command to execute> is the command required to execute the
door. Door MCI codes may be used. If the command begins
with "R;", then the user's real name is written to the file
instead of the user's handle (the "R;" is stripped before
being passed to DOS).
- Page 7 -
Telegard Menu Command Documentation - Version 2.5
Cmdkeys : "D-"
Function: Execute MString without creating a door information file
MString : <command to execute>
<command to execute> is the command required to execute the
door. Door MCI codes may be used.
- Page 8 -
Telegard Menu Command Documentation - Version 2.5
____________________________
"F" - FILE SYSTEM COMMANDS
____________________________
Cmdkeys : "FA"
Function: Change file bases
MString : [<file base> [;<menu file>] ] | [<movetype>] | L
<movetype> "-" : Previous- Goto previous file base (**)
"+" : Next - Goto next file base (**)
If MString="", the command will display a listing of
accessible file bases and allow the user to select one.
If MString="+" or "-", the command will search forward or
backward for the next accessible file base. If none is
found, the user will remain in the current section.
If MString="L", the command will ONLY display a listing of
available file bases.
If none of the above, the file base is changed to <file
base>, if the user has access to it. A menu file is loaded
if <menu file> exists.
Cmdkeys : "FB"
Function: Browse through files
MString : None
This command allows a user to view the files in the current
file base, starting at any file number. Other commands
available are Download, Upload, Back page, forward page,
Jump to file number, and Numbered download. In numbered
download, the user can specify up to 20 file numbers to
download, and they will be added to their batch queue (after
a "For sure?" prompt is passed). If only 1 file number is
specified, the user can either *immediately* download that
particular file, or add it to their batch queue.
Cmdkeys : "FD"
Function: Download file BBS to user
MString : None
Cmdkeys : "FF"
Function: Search all file bases for description
MString : None
Cmdkeys : "FI"
Function: Select file list types, toggle verbose on/off
MString : None
Cmdkeys : "FL"
Function: List filespec in current file base only
MString : None
- Page 9 -
Telegard Menu Command Documentation - Version 2.5
Cmdkeys : "FN"
Function: Scan file sections for new files
MString : <newtype>
<newtype> "G" : Global - NewScan all file bases
"C" : Current - NewScan current file base
# : Any - NewScan file base #
"" : Ask - Asks if want a global or a
current file base NewScan
Scans one or more file sections for new files according to
the new file pointer date. Files which are not validated
may or may not be available depending on the ACS setting in
the System Configuration.
Cmdkeys : "FP"
Function: Change pointer date for new files
MString : None
Cmdkeys : "FR"
Function: Remove file(s), if user is owner of file or file base SysOp
MString : None
Cmdkeys : "FS"
Function: Search all file bases for filespec
MString : None
Cmdkeys : "FU"
Function: Upload file from user to BBS
MString : None
Cmdkeys : "FV"
Function: List contents of an archived file
MString : None
Cmdkeys : "FY"
Function: Show user's file ratio and file point info
MString : None
Cmdkeys : "FZ"
Function: Set file bases to be scanned for new files
MString : None
Cmdkeys : "F@"
Function: Create temporary directory
MString : None
If there is enough file base space left (less than 96 file
bases have been specified), this command prompts for a
directory and creates a new, temporary, file base. After
changing to a new area from the file base, it disappears
completely, does not show up in any list.
No files in the directory LIST are deleted, and the next
time this command is executed, those files will remain. If
the temporary file path is different, however, the files
- Page 10 -
Telegard Menu Command Documentation - Version 2.5
uploaded previously will not actually BE in the temporary
file path.
Cmdkeys : "F#"
Function: Quick file base change
MString : None
Wherever it is, if this command is located in the current
menu file, users may switch file bases by entering the file
base NUMBER at the command prompt, instead of using the "A"
command to switch areas.
Cmdkeys : "F$"
Function: Give statistics on current file base
MString : None
- Page 11 -
Telegard Menu Command Documentation - Version 2.5
_______________________
"H" - HANGUP COMMANDS
_______________________
Cmdkeys : "HC"
Function: Carefull logoff of user
MString : [<string>]
<string> is printed, and the user must enter either Yes or
No. If Yes is entered, LOGOFF.* is displayed and the user
is logged off.
Cmdkeys : "HI"
Function: Immediate logoff of user
MString : None
Cmdkeys : "HM"
Function: Display string and logoff user
MString : [<string>]
- Page 12 -
Telegard Menu Command Documentation - Version 2.5
_______________________________
"M" - MESSAGE SYSTEM COMMANDS
_______________________________
Cmdkeys : "MA"
Function: Change message bases
MString : [<message base> [;<menu file>] ] | [<movetype>] | L
<movetype> "-" : Previous- Goto previous message base
"+" : Next - Goto next message base
If MString="", the command will display a listing of
accessible message bases and allow the user to select one.
If MString="+" or "-", the command will search forward or
backward for the next accessible message base. If none is
found, the user will remain in the current section.
If MString="L", the command will ONLY display a listing of
the available message bases.
If neither of the above, the message base is changed to
<message base>, if the user has access to it. A menu file
is loaded if <menu file> exists.
Cmdkeys : "ME"
Function: Send private mail to user
MString : [<user #> [;<reason>] ]
If MString is blank, this command will prompt for a user
name or number to send private mail to.
Mail is sent to <user #> if it specifies a valid user
number. If <reason> is specified, it is used as a "RE:"
reason in the letter sent. If <reason> is not specified,
the default reason is "Feedback".
Cmdkeys : "MJ"
Function: Selectively purge user's public posts
MString : <purgetype>
<purgetype> "G" : Global - Purge from all message bases
"C" : Current - Purge from current base only
# : Any - Purge from message base #
"" : Ask - Asks if want a global or a
current message base purge
Cmdkeys : "MK"
Function: Selectively delete user's old private mail
MString : None
Cmdkeys : "ML"
Function: Send "mass mail" - private mail sent to multiple users
MString : None
- Page 13 -
Telegard Menu Command Documentation - Version 2.5
Cmdkeys : "MM"
Function: Read private mail
MString : None
Cmdkeys : "MN"
Function: Display new messages
MString : <newtype>
<newtype> "G" : Global - NewScan all message bases
"C" : Current - NewScan current message base
# : Any - NewScan message base #
"" : Ask - Asks if want a global or a
current message base NewScan
Cmdkeys : "MP"
Function: Post public message in the current message base.
MString : None
Cmdkeys : "MS"
Function: Read messages in current message base
MString : None
Cmdkeys : "MU"
Function: Lists users with access to the current message base
MString : None
Cmdkeys : "MZ"
Function: Set message bases to be scanned for new messages
MString : None
Cmdkeys : "M#"
Function: Quick message base change
MString : None
Wherever it is, if this command is located in the current
menu file, users may switch message bases by entering the
message base NUMBER at the command prompt, instead of using
the "A" command to switch areas.
Cmdkeys : "M$"
Function: Give statistics on current message base
MString : None
- Page 14 -
Telegard Menu Command Documentation - Version 2.5
______________________________
"O" - MISCELLANEOUS COMMANDS
______________________________
Cmdkeys : "O1"
Function: Ask for BBS password (SHUTTLE LOGON ONLY)
MString : None
This command will ask for the BBS password, and if it is
correctly entered, the user will be logged into the BBS.
Cmdkeys : "O2"
Function: Apply to BBS as a new user (SHUTTLE LOGON ONLY)
MString : None
This command allows the user to apply to the BBS as a new
user. The procedure is exactly, step-by-step, as if the
user had entered "NEW" at the logon prompt of a BBS not
using the Shuttle Logon, the only difference being that the
user will be returned to the Shuttle Logon menu after logon
has been finished.
Cmdkeys : "O3"
Function: Allow user to find out the BBS password (SHUTTLE LOGON ONLY)
MString : None
Will only show the user the BBS password if their SL level
is greater than that of the new user SL level, or their DSL
level is greater than that of the new user DSL level.
Cmdkeys : "OA"
Function: Allow auto-validation of users
MString : <password>
New users must enter the <password> in order to validate
themselves. This command is recommended only for VERY
public, open-to-all-type systems.
Cmdkeys : "OB"
Function: Add entry to the BBS list
MString : None
Cmdkeys : "OC"
Function: Page the SysOp
MString : [<user #>] [;<string>]
<user #> If the SysOp is not available, this is the
user number to whom the message is left.
<string> String to print, other than "Why do you want
to chat?"
If <string> exists it is printed, else "Why do you want to
chat?" is displayed. The user then enters a short reason,
and the SysOp is paged if the SysOp status is set to
- Page 15 -
Telegard Menu Command Documentation - Version 2.5
"available". If the SysOp is not available, or does not
respond to the page, NOCHAT.* is displayed. Then a message
may be left to the user specified in <user #>, IF <user #>
is the number of a valid user. If the user attempts to chat
more than allowed, GOAWAY.* is printed.
Cmdkeys : "OI"
Function: Show current Telegard version info, LOGON.* and SYSTEM.*
MString : None
Cmdkeys : "OM"
Function: Go into macro menu
MString : None
Cmdkeys : "OO"
Function: Display SysOp chat status
MString : None
If the "SYSOPIN.*" or "SYSOPOUT.*" files exist in the AFILES
directory, those files are displayed; otherwise, the "SysOp
status strings" (defined in system configuration) will be
displayed.
Cmdkeys : "OP"
Function: Modify user information
MString : <info type>
<info type> Contains the type of user information to be
modified. Refer to below.
1. Address 12. Sex (gender)
2. Age * 13. BBS reference
$ 3. ANSI type 14. Zip code
4. City & State 15. Mail box status
5. Computer type 16. Video emulation mode
6. Occupation 17. Color (toggle)
* 7. User Name 18. Pause (toggle)
8. Phone number 19. Input type (toggle)
9. Password 20. Message CLS (toggle)
* 10. Real Name 21. Edit user colors
11. Screen size 22. Expert mode (toggle)
25. AVATAR adjustment (toggle)
* - Recommended for higher access only.
$ - Not recommended for use at all. Use types 16 and 17 for
ANSI type modification - this command is the one used
during a new user logon.
Cmdkeys : "OS"
Function: Go to bulletins menu
MString : [<main bulletin> [;<sub-bulletin>] ]
<main bulletin> is the bulletin displayed initially, and
after a "?" is entered. <sub-bulletin> is the file prefix
used for bulletin selections. Example: If <sub-bulletin> is
ONLINE, and the user enters "5", ONLINE5.* is displayed.
- Page 16 -
Telegard Menu Command Documentation - Version 2.5
If MString="", <main bulletin> is assumed to be "BULLETIN"
and <sub-bulletin> is assumed to be "BULLET". This is also
the default when bulletins are included in the initial
logon.
Cmdkeys : "OT"
Function: Go into text-files menu
MString : None
Cmdkeys : "OV"
Function: Go into voting menu
MString : None
Cmdkeys : "OY"
Function: Displays a short list of info on user's account
MString : None
Cmdkeys : "O$"
Function: Time Bank
MString : [<max time add>] [;<max bank account>]
<max time add> Maximum time a user can add to
their Time Bank in one call.
<max bank account> Maximum time user can have in their
Time Bank account. If user's Time
Bank account contains more time
than this amount, their account is
decreased to this amount.
- Page 17 -
Telegard Menu Command Documentation - Version 2.5
____________________________
"U" - AUTOMESSAGE COMMANDS
____________________________
Cmdkeys : "UA"
Function: Reply to author of current automessage
MString : None
Cmdkeys : "UR"
Function: Display current automessage
MString : None
Cmdkeys : "UW"
Function: Write automessage, if not restricted from doing so
MString : None
- Page 18 -
Telegard Menu Command Documentation - Version 2.5
______________________
"*" - SYSOP COMMANDS
______________________
Note the meaning of the following flags:
! - These commands are recommended for SysOp use alone. Each of
these commands prompt for the SysOp password and will not
execute if it is incorrectly entered. Some of these
commands are DANGEROUS and could quite possibly destroy your
board if they got into the "wrong hands".
* - These commands are somewhat dangerous in certain cases, and
are recommended for users with high or SysOp access alone.
Cmdkeys : "*B" (*!)
Function: Enter the message base editor
MString : None
Cmdkeys : "*C" (*!)
Function: Change to a different user's acount
MString : None
Cmdkeys : "*D" (*)
Function: MiniDos environment
MString : None
This command allows certain users you may not COMPLETELY
trust to modify text files used by the BBS, and to perform
other system maintenance in DOS. Several security features
exist. Refer to the section "Mini-DOS" in the main Telegard
documentation for more details.
Cmdkeys : "*E" (*!)
Function: Enter the event editor
MString : None
Cmdkeys : "*F" (*!)
Function: Enter the file base editor
MString : None
Cmdkeys : "*I" (*!)
Function: Enter the voting question editor
MString : None
Cmdkeys : "*L"
Function: Show SysOp Log for today, or other days
MString : None
Cmdkeys : "*N" (*)
Function: Edit a text file
MString : None
- Page 19 -
Telegard Menu Command Documentation - Version 2.5
Cmdkeys : "*P" (*!)
Function: Enter the system configuration editor
MString : None
Cmdkeys : "*T" (*!)
Function: Enter the Tfile editor
MString : None
Cmdkeys : "*U" (*!)
Function: Enter user list editor
MString : None
Cmdkeys : "*V" (*)
Function: Create and/or view VOTES.TXT - list of voting results
MString : None
Cmdkeys : "*X" (!)
Function: Enter the protocol editor
MString : None
Cmdkeys : "*Z"
Function: Displays system activity log file
MString : None
Cmdkeys : "*1" (*)
Function: Edit files in current file base
MString : None
Cmdkeys : "*2" (*)
Function: Sort files in current/all file bases, by name/date
MString : None
Cmdkeys : "*3" (*!)
Function: Read ALL private mail
MString : None
Cmdkeys : "*4" (*)
Function: Download an unlisted file from ANY path or drive
MString : [<filespec>]
If <filespec> does not exist, the user is prompted for a
file to download. Otherwise, <filespec> is the file to be
downloaded. Then a download protocol is prompted for, and
the file is sent.
Cmdkeys : "*5" (*)
Function: Move file(s) to other file bases
MString : None
Cmdkeys : "*6" (*)
Function: Upload files not in file lists
MString : None
This command allows you to upload every file that is not
currently in the Telegard file lists. It will display
filenames, and file size, and then prompt for a description.
- Page 20 -
Telegard Menu Command Documentation - Version 2.5
You may hit "\" as the first letter of the description to
enter a verbose description in addition to the normal one.
You can enter "." to abort all the uploads, ".S" to skip
this file only (not upload it), ".N" to skip to the next
directory, and ".D" to delete this file from the drive.
Cmdkeys : "*7"
Function: Validate files in all file bases or current file base
MString : None
Cmdkeys : "*8"
Function: Add GIFspecs to all *.GIF files in current file base
MString : None
A GIFspec is a description in the format "(XXXxYYY,CCC)",
where "XXX" is the X-resolution, "YYY" is the Y-resolution,
and "CCC" is the number of colors in the palette. The
description is placed in front of the file description; if
it becomes longer than the description field length, the
description is truncated at the end.
Cmdkeys : "*9"
Function: Pack the message bases
MString : None
Cmdkeys : "*#" (*!)
Function: Enter the menu editor
MString : None
Cmdkeys : "*$" (*)
Function: Gives a detailed directory of the current file base
MString : None
Cmdkeys : "*%" (*)
Function: Gives a condensed directory of the current file base
MString : None
- Page 21 -