=============================== NComm Host Script Documentation =============================== The NComm Host Script was written by Daniel Bloch 1989. Documentation written by Torkel Lodberg. The original plan was to implement the NComm host mode as a part of the NComm program, but, since the program would grow _large_, the host mode was implemented as a script. Of course, the NComm script language had to be enhanced, and functions specifically needed for the project were implemented. The result is one of the most powerful host modes available by any communication program... How to set up NHS ================= Before setting up NHS, please assure that the following files are available; 'C:ZOO', 'C:DELETE', 'C:FILENOTE', 'C:EXECUTE' and 'C:COPY'. To set up NHS, a few changes have to be made to the 'host.script'. All variables that need to be maintained have been placed at top of the script. First, a few directory names have to be defined. All directory names should end with a colon or a slash, and the directories must exist before you start using the script. The variable '$dir' shall contain the name of the directory where all miscellaneous files are kept. In other words, this is where bulletins, menus, messages, textfiles and so on have to rely. The NComm Host Script will log all user operations in a log file that will be created in this directory. The variable '$uldir' shall contain the name of the NHS upload directory - all files uploaded will be placed here. The variable '$dldir' shall contain the name of the NHS download directory - copy the files which shall be available for download into this directory. Use the command 'FILENOTE' for adding file descriptions. If '$uldir' and '$dldir' point to the same directory, files uploaded will be available for download immediately. Otherwise, the files have to be moved to the '$dldir' directory. The variable '$hold' shall contain the name of the NHS hold directory. All ZOO files extracted will be placed in this directory. Please notice that existing HOLD files wil be deleted at initialization, do not store other files in this directory! Now, a few file names have to been defined. The variable '$holdzoo' shall contain the name of the temporary hold ZOO file. Files will be added to this file. The variable '$tmp' shall contain the name of the temporary text file used by NHS for file listings and so on. The variable '$passwd' shall contain the user password. Users who do not have knowledge about this password will be conveyed right off the board. The variable '$sysop' shall contain the SYSOP name. Use this account for gaining SYSOP privileges - restricted commands can only be accessed when using this account. The variable '$syspass' shall contain the SYSOP password. The variable '$sysname' shall contain the name of your system. Finally, specify the name of the directory lister in the variable '$list'. This will normally be C:List. A few changes also have to be made to the NComm configuration. End-Of-Line TX should be set to CR+LF, the character set should be set to ISO and G&R Host Mode has to be ENABLED. You should use a two colour screen for faster screen updates. The G&R download dir MUST be set to the directory specified in the variable '$dldir'. This is due to Zmodem downloads always being created in the current download directory. Save the configuration as "host.config" and place it in the directory used for miscellaneous files. A sample configuration file has been included. NHS will display two files at logon. The file "prelog" contains the actual login text, "postlog" will be displayed after a successful login... Edit them to suit your needs. All menus are stored as textfiles. The file "menu0" contains the main menu, "menu1" contains a list of file transfer commands and finally "menu3" contains the SYSOP commands. Example files have been included. To install bulletins, simply create files "bull1", "bull2" and so on. You must also remember to edit the bulletin menu, which is contained in the text file "menu2". Again, example files have been included. Using the NComm Host Script =========================== Execute the 'host.script' using the Execute Script function. If all files and directories have been created successfully, the modem will be initialized and a small menu will appear on screen. You may enter 'Q' to quit the NComm Host Script, or 'SPACE' for logging on locally. Remember to turn off the modem before logging on, otherwise the text will be echoed back from the modem. The NComm Host Script does not support Page Break, so use CTRL-S and CTRL-Q for halting / resuming text output. When logging in, the file 'prelog' will be displayed. The host will now prompt you for your name. Log on with your SYSOP name if you want to gain SYSOP privileges, or use another name to log on as a user. Enter the password that has been configured in the "host.script" file at the 'Password' prompt. The second time you enter an uncorrect password, you will be thrown off the board. You will also be thrown off the board after 5 minutes of inactivity. If you used the correct password, the file 'postlog' will be displayed... Press 'Enter' to continue - NHS will now display the main menu. Here is a description of the different commands available; MAIN MENU File; "menu0" ======================================================================== [G]oodbye Brings up a prompt asking you if you want to log off the system or not. The hangup string will be sent to the modem if the answer is positive. NHS will start waiting for the next caller. [B]ulletins Displays the bulletin menu. A description of bulletin menu commands follows further down. [F]iles Displays the file menu. A description of file menu commands follows further down. [O]perator page Will ring the bell for SYSOP at local console. When chatting, you may return to the main menu by pressing CTRL-Z. [C]omment to SYSOP Enters comment into system. Prompts you for a subject. You will then enter a simple line editor that must be used for entering your comment. Press CTRL-Z on a blank line when finished. The message will be added to the file 'comments' - it can be read by using the SYSOP command [R]ead private messages. [E]nter message Enters message into system. Prompts you for receiver and subject. You will then enter a simple line editor that must be used for entering your message. Press CTRL-Z on a blank line when finished. The message will be added to the file 'messages' - it can be read by using the command [R]ead public messages. [RE]ply message Actually a duplicate of the [E]nter message command. See above. [R]ead public messages Used for reading messages - displays the file 'messages' on screen. [S]ysop functions Only available for SYSOP. Displays the SYSOP menu. A description of SYSOP menu commands follows further down. FILE MENU File; "menu1" ======================================================================== [ADD] file to HOLD Prompts you for a filename. The file will be added to the HOLD directory. [DIR] List files in HOLD Displays the contents of the HOLD directory. [EXT]ract ZOO file to HOLD Prompts you for a filename. The file must have the extension '.ZOO'. The file will be extracted into the HOLD directory. [DEL]ete file(s) from HOLD Prompts you for a filename. The file will be deleted from the HOLD directory. [GET] files in HOLD Packs the contents of the HOLD directory into the hold ZOO file. The command will prompt you for the preferred transfer protocol (Xmodem / YModem / Zmodem), and the transfer will start. [L]ist files Lists the contents of the download directory using the command specified in the '$list' variable. [D]ownload file Prompts you for a filename and transfer protocol (Xmodem / Ymodem / Zmodem). The transfer will start. [U]pload file Prompts you for a filename and transfer protocol (Xmodem / Ymodem / Zmodem). The transfer will start. [V]iew ZOO file Prompts you for a filename. The file must have the extension '.ZOO'. The contents of the file will be displayed on screen. [Q]uit Quits to main menu. BULLETIN MENU File; "menu2" ======================================================================== [xx] Displays bulletin #xx on screen. The file 'BULLxx' must exist. [Enter] Quits to main menu. SYSOP MENU File; "menu3" ======================================================================== [R]ead private messages Displays the file 'comments' on screen. All user comments are contained here. [L]ist user log Displays the file 'log' on screen. The log file contains a list of all user operations that have been made. [D]elete user log Asks for a confirm. Deletes the file 'log' from disk and creates a blank log file. [M]essages delete Asks for a confirm. Deletes the file 'messages' from disk and creates a blank message file. [C]omments delete Asks for a confirm. Deletes the file 'comments' from disk and creates a blank comments file. [P]assword change Prompts you for a new 'user password'. Warning; Password changes are lost when the NHS script is stopped. Edit the file 'host.script' to make changes permanent. [S]ysop password change Prompts you for the 'sysop password'. If the password is correct, the command will prompt you for a new password. Warning; Password changes are lost when the NHS script is stopped. Edit the file 'host.script' to make changes permanent. [E]xecute DOS command Prompts you for a DOS command. The command will be executed and program output will be displayed on screen. [Q]uit to main menu Quits to main menu.