@database Server.guide @master DOCS:FAME/Server.guide @$VER: Server.guide 0.3 (03-15-96) @author "SieGeL/tRSi" @(c) "Copyright 1996 (tRSi/F-iNNOVATiON)" @wordwrap @index HeddleyAutoIndex @remark Created with Heddley v1.1 (c) Edd Dumbill 1994 @remark Heddley Bugs Fixed with FixHeddley 1.2 (c) 1995 by David Zvekic @REM============================================================================== @node "MAIN" "Manual for the FAME Server" @{b}.---------------------------------------------------------. | _ _________ _ _________ _ _______________ _ _______|_ | __\\\\\\_ /__\\\\\\_ /__\\\\\\_______ /__\\\\\\_______/ |/ /_____// __/ // / / // __/___| / __/ / \\ // / / // _/ /| /_____/ /_____/_____//_____/_____/_____//___________/ | | |sYz `--------------[@{ub}@{i} - bULLETIN bOARD sYSTEMS - @{ui}@{b}]-------------'@{ub} @{b}@{fg highlight}F@{ub}@{fg text}_inal @{b}@{fg highlight}A@{ub}@{fg text}_miga @{b}@{fg highlight}M@{ub}@{fg text}_ailbox @{b}@{fg highlight}E@{ub}@{fg text}_ngine @{b}~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~@{ub} @{b}FAME SERVER MANUAL@{ub} @{" Contents " link "Contents"} @{" Pre-Release Info " link "PreRelease"} @{" Back to Main Index " LINK FAMEIndex.guide/Main} @{i}FAME is (c) 1993-96 by David "Strider" Wettig@{ui} All @{AMIGAGUIDE} documentations by: David 'Strider' Wettig Sascha 'SieGeL' Pfalz Oliver 'Bloodrock' Lange Kai 'big-rat' Hoepner @endnode @REM============================================================================== @node "PreRelease" "Pre-Release Informations" @{b}Pre-Release Informations ~~~~~~~~~~~~~~~~~~~~~~~~~~@{ub} FAME is a brand new MailBox program which seems to become very popular and FAMEous as we can see on the very positive reactions we receive daily. We already have many bug-reports and suggestions and we beleave we will get tones more from the very first release on. We work hard on fixing all reported bugs and realize suggestions as best we can, but it's impossible to do all at the same time. The same with the documents. The documents are not complete at all... we have to enhance and anlarge the documents as long as we have to do this with the FAME executables. You have bought FAME in an early stage and because of this not everything written here must be 100% correct but we work on it. @{u}@{b}Known not described parts in FAME.guide@{uu}@{ub} - None. @endnode @REM============================================================================== @node "Contents" "FAME Amigaguide Document - FAME Server Contents" @{b}FAME SERVER DOCUMENT CONTENTS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~@{ub} @{b}@{u}Introduction@{ub}@{uu} The Server is the controlling center of FAME, without it the FAME BBS won't work ! The Server manages the controlling of FAME and the nodes, allows to execute Programs on specific actions of FAME and also gives you a quick overview what currently happen in your BBS when users are online. The Server is a commodity, so it could be controlled via ExChange or other similiar programs. Also all other features a commodity have are available, like it's own definable PopUp-Hotkey for the Server. This documentation describes how to install, configure and use the Server. Also this documentation can be used as an Online-Manual to give you help when you press the HELP-Key over a gadget on the Server. @{b}@{u}Contents of this documentation@{ub}@{uu} @{" TOOLTYPES " link "TOOLTYPES" 0} - Describes the Start and the Tooltypes/Shell arguments @{" CONFIGURATION " link "CONFIGURATION" 0} - How to configure the System- and Userbuttons @{" SERVER WINDOW " link "MAIN_WINDOW" 0} - Complete description of the Server Window and Buttons @endnode @REM============================================================================== @node "TOOLTYPES" "How to start the Server/List of Tooltypes & Shell args" @{u}How to start the Server@{uu} The Server could be started from Workbench or CLI, but the CLI-Start should only be used for debugging purposes, because the Server writes all actions in the Shell window it was started from. This is only useful, if you i.e. have an unknown error and you need to know exactly whats happend. If you start the Server from CLI, the only Argument the Server accepts is the @{fg shine}IDLE/S@{fg text} option, this starts the Server but doesn't start the nodes. This Option is also available as a ToolType. When starting the Server from Workbench, some of the standard commodity tooltypes and also some own tooltypes are available, but with the exception of the @{fg shine}BBSLOCATION@{fg text} Tooltype they are not required for the Server to work. All Server related settings are also configurable in the SystemEditor under Server Settings. Refer to the SystemEditor manual for further informations on those settings. @{b}List of all currently supported tooltypes:@{ub} BBSLOCATION=FAME: @{b}->@{ub} This Tooltype is the only important ToolType for the Server, without this it won't start! Here you must specify the main location of FAME, which by default is set to the Assign FAME: CX_POPUP= @{b}->@{ub} Set it to YES to let the Server open it's window when starting. If set to NO, the Server starts iconified. This Tooltype will be overridden if you have specified the Iconify Option in the SystemEditor/Server Settings. CX_PRIORITY=0 @{b}->@{ub} Specifies the Priority for the Server. Normally this is set to 0. This Tooltype will be over- written if you have specified the Priority in the SystemEditor/Server Settings. CX_POPKEY=alt f @{b}->@{ub} Here you may specify a hotkey to open the Server window without double-clicking on it's App-Icon first. IDLE @{b}->@{ub} If this Tooltype is present, the Server will be started without starting the nodes. The following Tooltypes only take affect when starting the Server from your SYS:WBStartup/ drawer. For detailed information about these and other Tooltypes for WBStartup Icons, please look in your Workbench Manual. DONOTWAIT @{b}->@{ub} Necessary to let Workbench continue it's work after starting Server. If you don't specify it, WorkBench will wait until you have finished the Server! STARTPRI= @{b}->@{ub} Specifies the starting order of your WBStartup programs. The priority defines which programs are executed before others. The priority ranges from -127 to +127, normally it is set to 0 if not specified. WAIT= @{b}->@{ub} Defines the time in seconds the WBStartup-Loader should wait before loading the next Program. This is useful for FAME, because the Server loads in many datafiles at once, and other programs which where started while loading the datafiles could slow down the time the Server needs to load in the datafiles. If you have a SCSI-System or very fast HD's, it's not necessary to use this Tooltype, but on slow HD's or AT-Systems it could improve the Load-Time. @endnode @REM============================================================================== @node "CONFIGURATION" "How to configure the System- and Userbuttons" @{u}CONFIGURATION OF THE SERVER@{uu} Some of the main-buttons are configurable, in addition there are @{i}28@{ui} user- definable buttons for your own purposes. All of the buttons are configured with the SystemEditor. For a complete description of all buttons from the Server, please refer to the Chapter @{"GUI-Description" link "MAIN_WINDOW" 0} in this document. @{b}Configuration of the System-Buttons:@{ub} The @{"system-buttons" link "BANKCYCLE" 0} of the Server contain calls to external FAME programs. The pathes for those programs are configurable in the @{fg fill}SystemEditor@{fg text} under the Section @{fg fill}FAME Modules@{fg text}. Please refer to the SystemEditor documentation for further information about the FAME Modules window. @{b}The following system-buttons of the Server are configurable:@{ub} UserEditor @{b}->@{ub} Used to start an external User-Editor, like the MUI User-Editor contained in your FAME release. Look in the @{"GUI-description" link "MAIN_WINDOW" 0} of this documentation for further information. Info @{b}->@{ub} Used to start an external Info-command which shows some values about the online user and his transfers @{b}Configuration of the User-Buttons:@{ub} In addition the the System-Buttons, also 28 freely-configurable buttons are available. To access them, switch the @{"System-Bank Cyclegadget" link "BANKCYCLE" 0} to the User- Bank 1 & 2 position. All User-Buttons are configurable in the @{fg fill}SystemEditor@{fg text} under Section @{fg fill}Server Settings@{fg text}. To configure your own buttons, follow these steps: @{b}1.@{ub} Select with the Cyclegadget if you want to configure a button for bank one or bank two. @{b}2.@{ub} Select the number of the button you want to change. Please note that all buttons are numbered from left to right, so button number one is the leftmost button, button two the one right after it etc. @{b}3.@{ub} Now enter a name for the button. Make sure that the name is max. 10 chars long, longer names are cut. @{b}4.@{ub} Finally enter the command line for this button to be executed. Here you should enter exactly the same line like when using this command via shell. @{b}Example for a User-Button (Bank 1/Button 1):@{ub} This example shows how to create a user-button called '@{fg shine}LASTCALLER@{fg text}' which should display the last callers to your BBS. Assuming that your LastCallers bulletin is called: @{fg shine}FAME:LastCallers.TXT@{fg text} and you have an ANSI-Textviewer called @{fg shine}BBS-View@{fg text} in C: , the configuration for this button should be: ButtonName: LastCaller Command: C:BBS-VIEW FAME:LASTCALLERS.TXT That's all! As you can see, it's not a problem to configure your own buttons inside the server. @endnode @REM============================================================================== @node "MAIN_WINDOW" "Server Main Window - System Button Bank 1" @next "CLOSE_BUTTON" @prev "MAIN" @{u}THE SERVER-WINDOW@{uu} @{" * " link "CLOSE_BUTTON" 0} @{"Nodes 0--1" link "NODE_SWITCH" 0} @{"About" link "ABOUT" 0} @{"Save Win" link "SAVE_WIN" 0} @{"Iconify" link "ICONIFY" 0} @{"Ports/Processes/Handler" link "PORTLIST" 0} @{" ^ " link "WIN_SIZE" 0} @{"Node 0" link "NODES" 0}|@{" " link "CHAT_SWITCH" 0}|@{" SieGeL/tRSi (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{"Info" link "INFO" 0} @{"UsEd" link "NODE_USEREDIT" 0} @{"Node 1" link "NODES" 0}|@{" " link "CHAT_SWITCH" 0}|@{" Strider (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{"Info" link "INFO" 0} @{"UsEd" link "NODE_USEREDIT" 0} @{"Node 2" link "NODES" 0}|@{" " link "CHAT_SWITCH" 0}|@{" BLOODROCK (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{"Info" link "INFO" 0} @{"UsEd" link "NODE_USEREDIT" 0} @{"SysopLogin" link "SYSOPLOGIN" 0} @{"SysFastLgn" link "SYSFASTLGN" 0} |@{" Last UL/DL/Callers " link "INFO_CYCLE" 0}| @{" System Bank 1 " link "MAIN_WINDOW2" 0} @{"LocalLogin" link "LOCALLOGIN" 0} @{"LocFastLgn" link "LOCFASTLGN" 0} | | @{"Exit Node " link "EXIT_NODE" 0} @{"N# offhook" link "N#_OFFHOOK" 0} @{"Remote Lgn" link "REMOTELGN" 0} @{"RemFastLgn" link "REMFASTLGN" 0} | | @{"Icnfy Node" link "ICNFY_NODE" 0} @{" System Ed" link "System_Ed" 0} @{"Init Modem" link "INITMODEM" 0} @{"Node Chat " link "NODE_CHAT" 0} | | @{"Drop User " link "DROP_USER" 0} @{" User Edit" link "USER_EDIT" 0} @endnode @REM============================================================================== @node "MAIN_WINDOW2" "Server Main Window - System Button Bank 2" @next "CLOSE_BUTTON" @prev "MAIN" @{u}THE SERVER-WINDOW@{uu} @{" * " link "CLOSE_BUTTON" 0} @{"Nodes 0--1" link "NODE_SWITCH" 0} @{"About" link "ABOUT" 0} @{"Save Win" link "SAVE_WIN" 0} @{"Iconify" link "ICONIFY" 0} @{"Ports/Processes/Handler" link "PORTLIST" 0} @{" ^ " link "WIN_SIZE" 0} @{"Node 0" link "NODES" 0}|@{" " link "CHAT_SWITCH" 0}|@{" SieGeL/tRSi (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{"Info" link "INFO" 0} @{"UsEd" link "NODE_USEREDIT" 0} @{"Node 1" link "NODES" 0}|@{" " link "CHAT_SWITCH" 0}|@{" Strider (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{"Info" link "INFO" 0} @{"UsEd" link "NODE_USEREDIT" 0} @{"Node 2" link "NODES" 0}|@{" " link "CHAT_SWITCH" 0}|@{" BLOODROCK (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{"Info" link "INFO" 0} @{"UsEd" link "NODE_USEREDIT" 0} @{"N# Reserve" link "N#_RESERVE" 0} @{"Spy Node " link "SPY_NODE" 0} |@{" Last UL/DL/Callers " link "INFO_CYCLE" 0}| @{" System Bank 2 " link "MAIN_WINDOW" 0} @{"Quiet Node" link "QUIET_NODE" 0} @{"Conf. Node" link "CONF_NODE" 0} | | @{" --- " link "UNUSED" 0} @{" --- " link "UNUSED" 0} @{" --- " link "UNUSED" 0} @{" --- " link "UNUSED" 0} | | @{"AllIconify" link "ALLICONIFY" 0} @{" --- " link "UNUSED" 0} @{" --- " link "UNUSED" 0} @{" --- " link "UNUSED" 0} | | @{" --- " link "UNUSED" 0} @{" --- " link "UNUSED" 0} @endnode @REM============================================================================== @node "CLOSE_BUTTON" "Main Window: Close Button" @prev "MAIN_WINDOW" @{u}CLOSE BUTTON:@{uu} The close button has a double-function. When pressing only once, all currently empty nodes (@{"Status" link "ACTION_FIELD" 0} Awaiting Call) get made inactive (Node Offhook). When all nodes are Offhook and you press the close button again, the Server closes and FAME terminates. The state of the nodes after closing them depends on the settings in @{fg fill}SystemEditor/Node Edit/More NodeEdit/Default OffHook.@{fg text} If you have started the Server in @{"IDLE" link "TOOLTYPES" 0} mode, it will terminate after the first click on the close button, because no nodes are started and therefor it's not necessary to shutdown them first. @{b}NOTE:@{ub} It's not possible to terminate FAME until all nodes are free ! @endnode @REM============================================================================== @node "NODE_SWITCH" "Main Window: Node Cycling" @{u}NODE-CYCLING:@{uu} If your BBS has more nodes than the Server is able to display at one time, the nodes gets split to fit on your screen. In this case you are able to choose which nodes the Server should display by pressing on this Gadget and choosing the node-range you would like to see now. If all of your nodes fit on screen, this Gadget is disabled (ghosted) and can't be used. @endnode @REM============================================================================== @node "ABOUT" "Main Window: About Button" @next "SAVE_WIN" @{u}ABOUT BUTTON:@{uu} By clicking on this button you'll get another window containing information about all guys who helped in the creation of FAME. The following buttons are available inside the About Window: @{" Quit About " link "ABOUT_QUIT" 0}@{" Main Code " link "ABOUT_MAIN_CODE" 0}@{" Develop Team " link "ABOUT_DEVELOP_TEAM" 0}@{" Support Team " link "ABOUT_SUPPORT_TEAM" 0}@{" Support BBS " link "ABOUT_SUPPORT_BBS" 0} @{" Beta Testers " link "ABOUT_BETA_TESTERS" 0}@{" Dist. Sites " link "ABOUT_DIST_SITES" 0}@{" ------------ " link "UNUSED" 0}@{" ------------ " link "UNUSED" 0}@{" ------------ " link "UNUSED" 0} Also your Registration number, the SysOp- and BBS-Name are shown inside the About window if you have started at least one Node. @endnode @REM============================================================================== @node "ABOUT_QUIT" "About Window: Quit About Button" @prev "ABOUT" @{u}ABOUT WINDOW: QUIT ABOUT@{uu} Press this button or the window close button to get rid of the about window. @endnode @REM============================================================================== @node "ABOUT_MAIN_CODE" "About Window: Main Code Button" @prev "ABOUT" @{u}ABOUT WINDOW: MAIN CODE@{uu} Lists the main programmers of the FAME System incl. their E-Mail adresses. These persons are the Inventors of FAME. @endnode @REM============================================================================== @node "ABOUT_DEVELOP_TEAM" "About Window: Develop Team Button" @prev "ABOUT" @{u}ABOUT WINDOW: DEVELOP TEAM@{uu} Lists the FAME development team and their E-Mail adresses. These guys are responsible for external FAME-Programs like FullEditor, User-Editor or the FAMEChat. Also they are developing the Programmer-Examples and some of the documents including the Installation-Script. @endnode @REM============================================================================== @node "ABOUT_SUPPORT_TEAM" "About Window: Support Team Button" @prev "ABOUT" @{u}ABOUT WINDOW: SUPPORT TEAM@{uu} Lists the people and their E-Mail adresses who are developing FAME-Tools and other things related to FAME, mainly BBS-Doors for the FAME Doorport. @endnode @REM============================================================================== @node "ABOUT_SUPPORT_BBS" "About Window: Support BBS Button" @prev "ABOUT" @{u}ABOUT WINDOW: SUPPORT BBS@{uu} Here you have the phone numbers to call the Support BBS for FAME. This BBS offers the full support for FAME including the latest updates of FAME, their external Doors and also all doors from the @{"Supporter Team" link "ABOUT_SUPPORT_TEAM" 0}. If you have suggestions or bug-reports for FAME or any of their external tools, please write these reports also in this BBS, as all reports are stored there and forwarded immediatly to the @{"Coders" link "ABOUT_DEVELOP_TEAM" 0} of the FAME-System. Additionally it's also possible to write your Suggestions via E-Mail, but we recommend to call this BBS first, as this Board will be called every day by the coders. @endnode @REM============================================================================== @node "ABOUT_BETA_TESTERS" "About Window: Beta Testers Button" @prev "ABOUT" @{u}ABOUT WINDOW: BETA TESTERS@{uu} Here you have a list of all the guys who are testing the FAME-System. These guys have the hard work to find all the nasty bugs and other things a coder misses... @endnode @REM============================================================================== @node "ABOUT_DIST_SITES" "About Window: Dist. Sites Button" @{u}ABOUT WINDOW: DIST. SITES@{uu} Lists all the BBS-Systems where you can get the FAME-System as a registered User, but in difference to the @{"Support-BBS" link "ABOUT_SUPPORT_BBS" 0} you only get working versions of FAME and their required external programs, Beta-Versions are only accessable on the Support BBS ! @endnode @REM============================================================================== @node "SAVE_WIN" "Main Window: Save Window Position" @{u}SAVE WIN BUTTON:@{uu} This button allows you to save the position of the Server Window without entering the coordinates in the @{fg fill}SystemEditor@{fg text} under @{fg fill}Server Settings@{fg text}. Simply move the window to the position where the Server should open it's window everytime and click on the @{b}Save Win@{ub} button. The coordinates of the window are now copied to the Server Settings and The Server will open it's window at exactly the same position next time. The server also saves the positions of the @{"small/big" link "WIN_SIZE" 0} Serverwindow and the position of the @{"Spy Window" link "SPY_NODE" 0}. @endnode @REM============================================================================== @node "ICONIFY" "Main Window: Iconify Button" @{u}ICONIFY BUTTON:@{uu} This button allows you to iconify the Server. When pressed, the icon from the Server is used as an AppIcon, which will be shown on the Workbench screen. If you want to use another icon for iconifying the server, simply create/copy the icon of your choice to @{fg shine}Env:Sys/def_FAME.info@{fg text} and the Server will use this icon to iconify the Server. To start the Server in Iconify mode, you'll have to use the @{"ToolTypes" link "CONFIGURATION" 0} or set the @{fg fill}Iconify option@{fg text} in the @{fg fill}SystemEditor/Server Settings@{fg text}. Also you could set here the X and Y coordinates for the AppIcon to let it appear on the same place everytime the Server gets iconified. Enter the Pixel-coordinates for the AppIcon. More Informations about the Server Settings are available in the System- Editor documentation. @endnode @REM============================================================================== @node "PORTLIST" "Main Window: Ports/Processes/Handler Button" @{u}PORTS/PROCESSES/HANDLER BUTTON:@{uu} This button opens another window with definitions to auto-start external programs on specific actions by FAME. So you could i.e. let the Server execute every day at a specific time a User-Lister, which creates bulls for all your users. So this (in most cases very time-intensive) actions have to be executed only once, not for every user. @{fg shine}@{fg text} @endnode @REM============================================================================== @node "WIN_SIZE" "Main Window: Resize Server-Window" @{u}^ (RESIZE) BUTTON:@{uu} This button enables/disables the button bank at the bottom of the Serverwindow. In some cases it could be useful to display only the nodes and not the button banks too, i.e. if your Workbench screen is full of windows or you need a short overview of what happend on your BBS. To do this, simply press this button and the whole button bank disappears. Another click on this button lets the button bank appear again. To save the actual Server window setting, use the @{"SAVE WIN" link "SAVE_WIN" 0} button. @endnode @REM============================================================================== @node "NODES" "Main Window: Node Buttons" @{u}NODE BUTTON(S):@{uu} Depending on the number of nodes your BBS has, you'll see the according Node @{fg fill}@{fg text} buttons, where @{fg fill}@{fg text} stands for the nodenumbers ranging from 0 to your maximum number of nodes, i.e. if your BBS has three nodes, you'll have the Node-Buttons @{b}NODE 0@{ub} , @{b}NODE 1@{ub} and @{b}NODE 2@{ub} displayed in the Server window as shown in the @{"Server Main Window" link "MAIN_WINDOW" 0} description. By clicking on one of these Node buttons the according Node screen opens, or, if it is already open it will pop to the front. If no user is online, you'll see the start screen of FAME, which is described in the MainPart documentation. If a user is online, you are now able to view/edit his actions. Please note that scrolling is much slower if the node screen is open, so if you don't need the screen, you should leave it closed for speed reasons. If you click on one of the node buttons and no screen appears, it is possible that something is wrong with the communication of the Server and the according node. In this case, the Server performs a ScreenBeep after ten seconds of unsuccessful communication to inform you about the problem. If this happens, try to restart FAME or consult the FAQ in the FAME main documentation. @endnode @REM============================================================================== @node "CHAT_SWITCH" "Main Window: Chat on/off" @{u}CHATFLAG ON/OFF:@{uu} This flag determines if you want to be pageable by the '@{fg shine}O@{fg text}' command for the specific node. If set to on (checkmark appears) the users on this node are able to page you. If set to off, the users can't page you. @{b}NOTE:@{ub} If you use a replacement for the '@{fg shine}O@{fg text}' command, the replacement door is responsible for the checking of the ChatFlag! This flag is also setable in the @{fg fill}SystemEditor@{fg text} under @{fg fill}Node Edit@{fg text} Settings. @endnode @REM============================================================================== @node "ACTION_FIELD" "Main Window: Information Fields" @{u}SERVER NODE-STATUS DISPLAY:@{uu} This field is used by the Server to display certain informations about the current status of the specific node. The field is seperated in four columns which shows the following informations: Actual User @{b}->@{ub} Name of the current online user, empty if node was just started and no user is online yet. Location @{b}->@{ub} Location/Group of the current online user, empty if node was just started and no user was online yet. Action @{b}->@{ub} Shows the node status or the user's current action. Also if programs write to the server's action field, those texts are displayed here. Baud/CPS @{b}->@{ub} Shows the current Baudrate. If no user is online, the Initialization Baudrate of the node is shown, otherwise the Baudrate of the online user will be displayed. When a transfer is in progress, you'll see the UL/DL CPS rate the user currently has. In addition, the whole line can be written in different colors to indicate special actions of the online user. The following colorcodes are available: Black @{b}->@{ub} Normal Textoutput, no special action. @{fg fill}Blue@{fg text} @{b}->@{ub} User is Hidden from other users. If another user takes a look at the nodes by using the @{b}WHO@{ub} command, hidden users are shown with the Name @{b}HIDDEN@{ub} and the Action @{b}DO NOT DISTURB@{ub}. Additional informations could be found in the SystemEditor documentation under the chapter Access/Secure. @{fg shine}White@{fg text} @{b}->@{ub} The user has paged you. This color overwrites the Blue colorcode in any case, so you are able to see which user wants to chat with you. If you go to the SysOp chat with a user who has paged you, the color will be restored to the original state. If you have set the Page Flag off and a user pages you, the action field of this user will be written in white too. @endnode @REM============================================================================== @node "INFO" "Main Window: Info Button" @{u}INFO BUTTON:@{uu} This button is used to start an external program which displays information about the current online user. As this program is an external program, you could easily replace it with your own program. To let this work you must set the correct path to the Info program in the @{fg fill}SystemEditor@{fg text} under @{fg fill}FAME Modules@{fg text} (FAME-Info). @{b}NOTE:@{ub} If you plan to write your own program, make sure that you have the necessary know-how to write such kind of programs, or major problems may occure if you make mistakes when writing such programs! Take a look at the Programmer-documentation for further informations! @{fg shine}@{fg text} @endnode @REM============================================================================== @node "NODE_USEREDIT" "Main Window: Start UserEditor to edit online User" @{u}USER-EDITOR ON NODES:@{uu} If you want to edit the settings of an online user, click on this button. This requires that you have set the correct path to the external User-Editor in the @{fg fill}SystemEditor@{fg text} under @{fg fill}FAME Modules@{fg text}. If you click on this button, the User-Editor will be started with two arguments given, so if you want to write your own one, you must support the following template: @{fg shine}FAME-LOCATION/A, SLOT/N@{fg text} So the Server may call the User-Editor in the following way: @{fg shine}User-Editor FAME: 10@{fg text} This will force the User-Editor to load in the Settings from @{fg shine}FAME:Settings/@{fg text} and also immediatly load in the Usersettings for SlotNumber @{fg shine}10@{fg text}. If a user is shown in the @{"Status-Display" link "ACTION_FIELD" 0} of the Server but is no longer online, you could also use this button to edit his settings! The Server sends the Userslot argument the Slotnumber of the user which was last online. @{b}WARNING:@{ub} If you change the settings of an online user and save them, the changes you've made will be overwritten when the user logs out!! FAME copies the user.datas of the online user out of the normal user.data and uses the temporary datas for the time the user is online. If you make any changes on the online user, these changes will only be saved in the real user.datas! When the user logs out, FAME copies the temporary datas back into the real user.datas and overwrites your changes. For security reasons it's not allowed for the User-Editor to edit the temporary datas, as this could cause trouble if the user edits his datas at the same time! We are working on a way to make this possible, but this may take some time until it's finished. @{fg shine}So please *DON'T* change user.datas of an online user, only change Datas of users which are no longer online until we have found a solution!@{fg text} @endnode @REM============================================================================== @node "SYSOPLOGIN" "Main Window: Sysop Login Button" @{u}SYSOP LOGIN BUTTON:@{uu} This button lets you login as SysOp with the full login procedure. You will not asked be for a Username/Password in this Login mode. After pressing this button select the node you wish to login on as SysOp. Click on the Node @{fg fill}@{fg text} button (@{fg fill}@{fg text} = nodenr. you wish) and FAME starts the Login procedure. It's not necessary to have the node screen open, the login will be done in any case. This function is equal to the @{fg shine}@{fg text} key in the Node Startup-Screen of FAME. @endnode @REM============================================================================== @node "LOCALLOGIN" "Main Window: Local Login Button" @{u}LOCAL LOGIN BUTTON:@{uu} This button allows you to login local under a specific Username. Of course you will not be asked for a Password as this Check is disabled when login is from the local side. After pressing this button click on the node @{fg fill}@{fg text} button of the node you wish to login on (@{fg fill}@{fg text} = the nodenr. you wish). The fact that you now have to enter the username that you wish to login as means that you need to open the node screen to type the details into. Of course you could also login using the @{"Spy Mode" link "SPY_NODE" 0}, if you wish. This function is equal to the @{fg shine}@{fg text} key in the Node Startup-Screen of FAME. @endnode @REM============================================================================== @node "REMOTELGN" "Main Window: Remote Login Button" @{u}REMOTE LOGIN BUTTON:@{uu} Use this Button if you want to let a user come onto your BBS on the same line that you are currently talking to him on (via voice). To use this, click once on this button, then click on the node @{fg fill}@{fg text} button of the node the user should login (@{fg fill}@{fg text} = nodenr. you wish). At the same time the user should enter @{b}ATD@{ub} in his Terminal to force the modem to connect. Also you must hang up your telephone to establish the connection. This function is equal to the @{fg shine}@{fg text} key in the Node Startup-Screen of FAME. @endnode @REM============================================================================== @node "INITMODEM" "Main Window: Init Modem Button" @{u}INIT MODEM BUTTON:@{uu} Use this button to re-initialize your modems. Click once on this button and then on the Node @{fg fill}@{fg text} button of the node you wish to re-initialize (@{fg fill}@{fg text} = nodenr. you wish). The Server uses the Initialization Commands specified in the @{fg fill}SystemEditor/Node Settings@{fg text} for the according node. This function is equal to the @{fg shine}@{fg text} key in the Node Startup-Screen of FAME. @endnode @REM============================================================================== @node "SYSFASTLGN" "Main Window: Sysop Fast Login" @{u}SYSOP FAST LOGIN BUTTON:@{uu} This button lets you login as SysOp, but in difference to the normal @{"SysOp Login" link "SYSOPLOGIN" 0} Procedure, all Textfiles are skipped and no Message/File Scanning will be performed. The rest of this Logon type is the same as described in the SysOp Login Procedure. After pressing this button select the node you wish to login as SysOp. Click on the Node @{fg fill}@{fg text} button (@{fg fill}@{fg text} = nodenr. you wish) and FAME starts the Login procedure. It's not necessary to have the node screen open, the login will be done in any case. This function is equal to the <@{fg shine}SHIFT+F1@{fg text}> key in the Node Startup-Screen of FAME. @endnode @REM============================================================================== @node "LOCFASTLGN" "Main Window: Local Fast Login Button" @{u}LOCAL FAST LOGIN BUTTON:@{uu} This button allows you to login local under a specific Username, but in difference to the normal @{"Local Login" link "LOCALLOGIN" 0} procedure all Textfiles and the File/Message Scanning are disabled. The rest of this login procedure is the same as the Local Login. After pressing this button, click on the node @{fg fill}@{fg text} button of the node you wish to login (@{fg fill}@{fg text} = the nodenr. you wish). The fact that you now have to enter the username that you wish to login as means that you need to open the node screen to type the details into. This function is equal to the <@{fg shine}SHIFT+F2@{fg text}> key in the Node Startup-Screen of FAME. @endnode @REM============================================================================== @node "REMFASTLGN" "Main Window: Remote Fast Login Button" @{u}REMOTE FAST LOGIN BUTTON:@{uu} Use this Button if you want to let a user come onto your BBS on the same line you are currently talking to him on (e.g. via voice). To use this, click once on this button, then click on the node @{fg fill}@{fg text} button of the node the user should login (@{fg fill}@{fg text} = nodenr. you wish). At the same time the user should enter @{b}ATD@{ub} in his Terminal to force the modem to connect. Also you must hang up your telephone to establish the connection. In difference to the normal @{"Remote Login" link "REMOTELGN" 0} procedure, all textfiles and the File/Message scanning are disabled. This function is equal to the <@{fg shine}SHIFT+F3@{fg text}> key in the Node Startup-Screen of FAME. @endnode @REM============================================================================== @node "NODE_CHAT" "Main Window: Node Chat Button" @{u}NODE CHAT BUTTON:@{uu} Use this button to go to the SysOp chat with one of your online users. You have to click first on this button, then select the Node @{fg fill}@{fg text} button of the node you want to go to SysOp chat (@{fg fill}@{fg text} = Nodenr. you wish). FAME will then (if needed) open the Nodescreen and start the SysOp-Chat. This function is equal to the <@{fg shine}F1@{fg text}> key inside the Nodescreen @{b}if a user@{ub} @{b}is currently online on this node@{ub}. @endnode @REM============================================================================== @node "INFO_CYCLE" "Main Window: List of last UL/DL/Callers " @{u}CYCLE-GADGET: LAST CALLERS/UPLOADS/DOWNLOADS@{uu} This Gadget is used to cycle between the list of the @{b}last ten callers@{ub}, the @{b}last ten uploads@{ub} (filenames) or the @{b}last ten downloads@{ub} (filenames). This is useful to have a quick overview what recently happend on your BBS. @endnode @REM============================================================================== @node "BANKCYCLE" "Main Window: Cycle the Button-Banks" @{u}CYCLE-GADGET: SYSTEM/USER-BUTTON SWITCH@{uu} Use this Cycle-Gadget to switch between the @{b}System Button@{ub} and @{b}Userbutton@{ub} banks one and two. The Userbutton banks are freely configurable in the SystemEditor of FAME. Look also in Chapter @{"Configuration of the Buttons" link "CONFIGURATION" 0} for further information how to install your own buttons. @endnode @REM============================================================================== @node "EXIT_NODE" "Main Window: Exit Node Button" @{u}EXIT NODE BUTTON:@{uu} This Button allows you to ShutDown already started nodes. To use this, click once on this button then choose the Node @{fg fill}@{fg text} button of the node you want to shutdown (@{fg fill}@{fg text} = Nodenr. you wish). FAME will then ShutDown the choosen node. It can be restarted by pressing once on the Node button. This function is equal to the <@{fg shine}F9@{fg text}> key of the Node-Startup screen of FAME. @endnode @REM============================================================================== @node "ICNFY_NODE" "Main Window: Iconify Node Button" @{u}ICONIFY NODE BUTTON:@{uu} Use this Button to iconify node screen(s). Click once on this button, then choose the Node @{fg fill}@{fg text} button of the Node you want to iconify it's screen (@{fg fill}@{fg text} = Nodenr. you wish). FAME will then iconify the Nodescreen if it's currently open. This function is equal to the <@{fg shine}SHIFT+F10@{fg text}> or <@{fg shine}RAMIGA+I@{fg text}> key shortcuts in the FAME node Await Logon screen. @endnode @REM============================================================================== @node "DROP_USER" "Main Window: Drop User Button" @{u}DROP USER BUTTON:@{uu} Use this button to drop the carrier on a currently online user. Click once on this button, then choose the Node @{fg fill}@{fg text} button of the node you want to drop the carrier of the user (@{fg fill}@{fg text} = Nodenr. you wish). FAME will then drop the user's carrier and re-initialize after the logoff batches where executed. This function is equal to the <@{fg shine}F10@{fg text}> key in the FAME node screen (@{b}but only@{ub} @{b}if a user is currently online!@{ub}). @endnode @REM============================================================================== @node "N#_OFFHOOK" "Main Window: Node OffHook Button" @{u}NODE OFFHOOK BUTTON:@{uu} Use this button to @{b}shutdown@{ub} and @{b}offhook@{ub} specific nodes. In difference to the @{"Exit Node" link "EXIT_NODE" 0} button the node you have choosen will be made offhook, which means the line will be busy to anyone that tries to call this node. To use this, click once on this button, then choose the Node @{fg fill}@{fg text} button of the node you want to make shutdown/offhook (@{fg fill}@{fg text} = Nodenr. you wish). FAME will then shutdown the node and also make it offhook (busy). This function is equal to the <@{fg shine}F10@{fg text}> key of the Node-Startup screen if no user is online, and the <@{fg shine}SHIFT+F10@{fg text}> key if a user is currently online. See documentation of the @{i}FAME Nodescreen GUI@{ui} for further informations about all supported function keys. @endnode @REM============================================================================== @node "System_Ed" "Main Window: System Editor Button" @{u}SYSTEM-EDITOR BUTTON:@{uu} This button starts the System-Editor of FAME. To let this work, you have to set the correct path to the System-Editor in the @{fg fill}System-Editor@{fg text} settings under @{fg fill}FAME Modules@{fg text}. The System-Editor is used whenever you need to change something in the configuration of FAME. A complete description of the System-Editor can be found in the @{i}System-Editor documentation@{ui} supplied with FAME. This function is equal to the <@{fg shine}SHIFT+F5@{fg text}> key in the node-startup screen of FAME. Also you are able to access the System-Editor when pressing the @{b}HELP@{ub} key on an activated FAME Nodescreen. See @{i}Nodescreen GUI documentation@{ui} for further informations about all available keycommands. @endnode @REM============================================================================== @node "USER_EDIT" "Main Window: User Editor Button" @{u}USER-EDITOR BUTTON:@{uu} Use this button to start the external User-Editor supplied with FAME. You have to set the correct path to the User-Editor in the @{fg fill}System-Editor@{fg text} under @{fg fill}FAME Modules@{fg text} to let this button work. The external User-Editor can be used to change datas of specific users without using the internal Usereditor which requires a node to be started. See also the @{"Node-specific calls" link "NODE_USEREDIT" 0} for the User-Editor to get more detailed informations. This function is equal to the <@{fg shine}SHIFT+F6@{fg text}> key in the node-startup screen of FAME. Also you are able to access the User-Editor when pressing the @{b}HELP@{ub} key on an activated FAME Nodescreen. See @{i}Nodescreen GUI documentation@{ui} for further informations about all available keycommands. @endnode @REM============================================================================== @node "N#_RESERVE" "Main Window: Reserve Node Button" @{u}NODE RESERVE BUTTON:@{uu} Use this button to reserve a node for a specific user. To use this, click once on this button and then choose the Node @{fg fill}@{fg text} button of the node you want to reserve (@{fg fill}@{fg text} = Nodenr. you wish). FAME will then open the choosen nodescreen and you will now asked for the Username to reserve the node for. If you press @{b}ENTER@{ub} without entering a name, the reserving will be aborted, otherwise the Node will now be reserved for the user you have entered. This function is equal to the <@{fg shine}F4@{fg text}> key in the Node-Startup screen of FAME. @endnode @REM============================================================================== @node "QUIET_NODE" "Main Window: Quiet Node Button" @{u}QUIET NODE BUTTON:@{uu} Use this button to make a user "@{b}hidden@{ub}" for other users. Click once on this button, then select the Node @{fg fill}@{fg text} button of the user's node you want to make hidden (@{fg fill}@{fg text} = Nodenr. you wish). This function is equal to the '@{fg shine}Q@{fg text}' command on the BBS-Prompt. See the @{i}MainPart documentation@{ui} for detailed informations about all supported commands of FAME. @endnode @REM============================================================================== @node "SPY_NODE" "Main Window: Spy Node Button" @{u}SPY NODE BUTTON:@{uu} This button allows you to "@{b}spy@{ub}" on a specific node, which means that you could view all actions by the online user without having to open the node screen first. To use this, click once on this button, then select the Node @{fg fill}@{fg text} button of the node you want to spy (@{fg fill}@{fg text} = Nodenr. you wish). FAME will then open a window on your Workbench screen and show all user actions in this window. You can configure the window in the @{fg fill}System-Editor@{fg text} under @{fg fill}System Datas/@{fg text} @{fg fill}More System Datas@{fg text}. Here you can define @{b}how many lines@{ub} the window should display and if @{b}your keyinputs@{ub} should @{b}passed through the node@{ub} or if all @{b}inputs inside the Spy window are disabled@{ub}. Look in the @{i}System-Editor@{ui} @{i}documentation@{ui} for further informations about these settings. @endnode @REM============================================================================== @node "CONF_NODE" "Main Window: Config Node Button" @{u}CONFIGURE NODE BUTTON:@{uu} This button will be used to configure specific node settings. Click once on this button, then choose the Node @{fg fill}@{fg text} button of the node you want to configure (@{fg fill}@{fg text} = Nodenr. you wish). <@{fg shine}THIS FUNCTION IS CURRENTLY UNDER DEVELOPMENT AND IS NOT 100% WORKING !@{fg text}> @endnode @REM============================================================================== @node "ALLICONIFY" "Main Window: All Iconify Button" @{u}ALL ICONIFY BUTTON:@{uu} Use this button to iconify all currently open node screens. Useful if you have chatted with many users on different nodes and forgot to close all screens after the chats. A single click on this button will do this for you. @endnode @REM============================================================================== @node "UNUSED" "Main Window: Unused Buttons" < @{fg shine}THESE BUTTONS ARE CURRENTLY EMPTY. ANY SUGGESTIONS FOR THEM ? :)@{fg text} > @endnode @REM============================================================================== @node HeddleyAutoIndex "Index" @remark Index auto-generated by Heddley Index of database Server.guide Documents @{"About Window: Beta Testers Button" link "ABOUT_BETA_TESTERS"} @{"About Window: Develop Team Button" link "ABOUT_DEVELOP_TEAM"} @{"About Window: Dist. Sites Button" link "ABOUT_DIST_SITES"} @{"About Window: Main Code Button" link "ABOUT_MAIN_CODE"} @{"About Window: Quit About Button" link "ABOUT_QUIT"} @{"About Window: Support BBS Button" link "ABOUT_SUPPORT_BBS"} @{"About Window: Support Team Button" link "ABOUT_SUPPORT_TEAM"} @{"How to configure the System- and Userbuttons" link "CONFIGURATION"} @{"How to start the Server/List of Tooltypes & Shell args" link "TOOLTYPES"} @{"Main Window: About Button" link "ABOUT"} @{"Main Window: All Iconify Button" link "ALLICONIFY"} @{"Main Window: Chat on/off" link "CHAT_SWITCH"} @{"Main Window: Close Button" link "CLOSE_BUTTON"} @{"Main Window: Config Node Button" link "CONF_NODE"} @{"Main Window: Cycle the Button-Banks" link "BANKCYCLE"} @{"Main Window: Drop User Button" link "DROP_USER"} @{"Main Window: Exit Node Button" link "EXIT_NODE"} @{"Main Window: Iconify Button" link "ICONIFY"} @{"Main Window: Iconify Node Button" link "ICNFY_NODE"} @{"Main Window: Info Button" link "INFO"} @{"Main Window: Information Fields" link "ACTION_FIELD"} @{"Main Window: Init Modem Button" link "INITMODEM"} @{"Main Window: List of last UL/DL/Callers " link "INFO_CYCLE"} @{"Main Window: Local Fast Login Button" link "LOCFASTLGN"} @{"Main Window: Local Login Button" link "LOCALLOGIN"} @{"Main Window: Node Buttons" link "NODES"} @{"Main Window: Node Chat Button" link "NODE_CHAT"} @{"Main Window: Node Cycling" link "NODE_SWITCH"} @{"Main Window: Node OffHook Button" link "N#_OFFHOOK"} @{"Main Window: Ports/Processes/Handler Button" link "PORTLIST"} @{"Main Window: Quiet Node Button" link "QUIET_NODE"} @{"Main Window: Remote Fast Login Button" link "REMFASTLGN"} @{"Main Window: Remote Login Button" link "REMOTELGN"} @{"Main Window: Reserve Node Button" link "N#_RESERVE"} @{"Main Window: Resize Server-Window" link "WIN_SIZE"} @{"Main Window: Save Window Position" link "SAVE_WIN"} @{"Main Window: Spy Node Button" link "SPY_NODE"} @{"Main Window: Start UserEditor to edit online User" link "NODE_USEREDIT"} @{"Main Window: Sysop Fast Login" link "SYSFASTLGN"} @{"Main Window: Sysop Login Button" link "SYSOPLOGIN"} @{"Main Window: System Editor Button" link "System_Ed"} @{"Main Window: Unused Buttons" link "UNUSED"} @{"Main Window: User Editor Button" link "USER_EDIT"} @{"Manual for the FAME Server" link "MAIN"} @{"Server Main Window - System Button Bank 1" link "MAIN_WINDOW"} @{"Server Main Window - System Button Bank 2" link "MAIN_WINDOW2"} Buttons @{" " link "CHAT_SWITCH" 0} @{" --- " link "UNUSED" 0} @{" System Bank 1 " link "MAIN_WINDOW2" 0} @{" System Bank 2 " link "MAIN_WINDOW" 0} @{" --- " link "UNUSED" 0} @{" Last UL/DL/Callers " link "INFO_CYCLE" 0} @{" TOOLTYPES " link "TOOLTYPES" 0} @{" Main Code " link "ABOUT_MAIN_CODE" 0} @{" Quit About " link "ABOUT_QUIT" 0} @{" * " link "CLOSE_BUTTON" 0} @{" ------------ " link "UNUSED" 0} @{" Beta Testers " link "ABOUT_BETA_TESTERS" 0} @{" BLOODROCK (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{" CONFIGURATION " link "CONFIGURATION" 0} @{" Develop Team " link "ABOUT_DEVELOP_TEAM" 0} @{" Dist. Sites " link "ABOUT_DIST_SITES" 0} @{" SERVER WINDOW " link "MAIN_WINDOW" 0} @{" SieGeL/tRSi (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{" Strider (tRSi/F-iNN Awaiting Call 115200 " link "ACTION_FIELD" 0} @{" Support BBS " link "ABOUT_SUPPORT_BBS" 0} @{" Support Team " link "ABOUT_SUPPORT_TEAM" 0} @{" System Ed" link "System_Ed" 0} @{" User Edit" link "USER_EDIT" 0} @{" ^ " link "WIN_SIZE" 0} @{"About" link "ABOUT" 0} @{"AllIconify" link "ALLICONIFY" 0} @{"Coders" link "ABOUT_DEVELOP_TEAM" 0} @{"Conf. Node" link "CONF_NODE" 0} @{"Configuration of the Buttons" link "CONFIGURATION" 0} @{"Drop User " link "DROP_USER" 0} @{"Exit Node" link "EXIT_NODE" 0} @{"Exit Node " link "EXIT_NODE" 0} @{"GUI-Description" link "MAIN_WINDOW" 0} @{"Icnfy Node" link "ICNFY_NODE" 0} @{"Iconify" link "ICONIFY" 0} @{"IDLE" link "TOOLTYPES" 0} @{"Info" link "INFO" 0} @{"Init Modem" link "INITMODEM" 0} @{"Local Login" link "LOCALLOGIN" 0} @{"LocalLogin" link "LOCALLOGIN" 0} @{"LocFastLgn" link "LOCFASTLGN" 0} @{"N# offhook" link "N#_OFFHOOK" 0} @{"N# Reserve" link "N#_RESERVE" 0} @{"Node 0" link "NODES" 0} @{"Node 1" link "NODES" 0} @{"Node 2" link "NODES" 0} @{"Node Chat " link "NODE_CHAT" 0} @{"Node-specific calls" link "NODE_USEREDIT" 0} @{"Nodes 0--1" link "NODE_SWITCH" 0} @{"Ports/Processes/Handler" link "PORTLIST" 0} @{"Quiet Node" link "QUIET_NODE" 0} @{"RemFastLgn" link "REMFASTLGN" 0} @{"Remote Lgn" link "REMOTELGN" 0} @{"Remote Login" link "REMOTELGN" 0} @{"Save Win" link "SAVE_WIN" 0} @{"Server Main Window" link "MAIN_WINDOW" 0} @{"small/big" link "WIN_SIZE" 0} @{"Spy Node " link "SPY_NODE" 0} @{"Spy Mode" link "SPY_NODE" 0} @{"Spy Window" link "SPY_NODE" 0} @{"Status" link "ACTION_FIELD" 0} @{"Status-Display" link "ACTION_FIELD" 0} @{"Support-BBS" link "ABOUT_SUPPORT_BBS" 0} @{"Supporter Team" link "ABOUT_SUPPORT_TEAM" 0} @{"SysFastLgn" link "SYSFASTLGN" 0} @{"SysOp Login" link "SYSOPLOGIN" 0} @{"SysopLogin" link "SYSOPLOGIN" 0} @{"System-Bank Cyclegadget" link "BANKCYCLE" 0} @{"system-buttons" link "BANKCYCLE" 0} @{"ToolTypes" link "CONFIGURATION" 0} @{"UsEd" link "NODE_USEREDIT" 0} @endnode