@database Welcome.Guide @author Urban Lindeskog Organization : ProNova SoftWare Development Group Created : 30-Jan-93 @node Main "Welcome to Welcome" WELCOME ! ŻŻŻŻŻŻŻŻŻŻŻ Documentation for Welcome Release 2 @{fg highlight}*Under development, THINGS MAY CHANGE@{fg text} @{" History " Link "History"} @{" Function " Link "Function"} @{" Options " Link "Options"} @{" Examples " Link "Examples"} @{" ARexx Commands " Link "ARexx Commands"} @{" WEcho " Link "WEcho"} @{" Development and support " Link "Development"} @endnode @node History My startup-sequence didn't echo anything, thus no initial CLI opens. It looked quite boring whith the blank screen while the machine was booting, so I thought of Macintosh with it's "Welcome to Macintosh"-requester. Stefan Ervik suggested the message-box, it was a brilliant idea, so it was added. This software is FreeWare. You may use it without paying anything to me. You may distribute the Welcome archive freely as long as you don't alter or omit any files, or make a profit out of distributing it. You may not crunch any of the files in the archive and distribute them in that form, however, you can archive the files in LhArc format. @{fg highlight}*** As mentioned earlier, you don't have to pay anything to me, but I would appreciate if you sent me a postcard.@{fg text} @endnode @node Function Welcome requires AmigaOS 2.0 or higher. You can start Welcome from both Shell and Workbench. @endnode @node Options @{b}Welcome@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} PUBSCREEN/K,PORTNAME/K,NOBREAK/S,TIMEOUT/N/K,LEFT/K, RIGHT/K,COLUMNS/K/N,ROWS/K/N,TEXT/K,TEXTFONT/K, TEXTFONTSIZE/K/N,XPOSITION/K,YPOSITION/K,XSIZE/K, YSIZE/K,DRAGBAR/S,DRAGWINDOW/S @{b}Function:@{ub} @{b}Options:@{ub} PUBSCREEN/K Where the Welcome window should open. PORTNAME/K The name of Welcome's ARexx port NOBREAK/S The user will not be able to quit welcome by pressing CTRL-C or CTRL-D. @{fg highlight}@{"*" Link "NotReady"}@{fg text} TIMEOUT/N/K A timeout in seconds that Welcome will wait for ARexx commands before quitting. LEFT/K Name of picture that will be placed on the left side RIGHT/K Name of picture that will be placed on the right side COLUMNS/K/N The width of the message-mox in character columns. ROWS/K/N The height of the message-box in character rows. TEXT/K The text between the pictures. TEXTFONT/K Name of the font used in the message-box. TEXTFONTSIZE/K/N Size of the font used in the message-box. @{fg highlight}@{"*" Link "NotReady"}@{fg text} XPOSITION/K X Coordinate for the Top left corner in the Welcome window. @{fg highlight}@{"*" Link "NotReady"}@{fg text} YPOSITION/K Y Coordinate for the Top left corner in the Welcome window. @{fg highlight}@{"*" Link "NotReady"}@{fg text} XSIZE/K The width of the Welcome window. @{fg highlight}@{"*" Link "NotReady"}@{fg text} YSIZE/K The height of the Welcome window. @{fg highlight}@{"*" Link "NotReady"}@{fg text} DRAGBAR/S The Welcome-window will have a dragbar DRAGWINDOW/S The whole Welcome-Window acts like a dragbar @{b}Example:@{ub} @endnode @node "Arexx Commands" Welcome features an ARexx-interface, from there you can control the program behaviour. If you are not familiar with ARexx, please refer to the "ARexx User's Guide" supplied with your computer. There is an alternative to ARexx if you don't have or want to install it for some reason. A separate program, @{"WEcho" Link "WEcho"} can send ARexx commands to Welcome. Commands you can send from ARexx or WEcho: @{"ASK " Link "ASK" } @{"BACKGROUNDPEN " Link "BACKGROUNDPEN"} @{"CLEAR " Link "CLEAR" } @{"DISABLE " Link "DISABLE" } @{"ENABLE " Link "ENABLE" } @{"HELP " Link "HELP" } @{"NOP " Link "NOP" } @{"OPEN " Link "OPEN" } @{"QUIT " Link "QUIT" } @{"REQUESTFILE " Link "REQUESTFILE" } @{"REQUESTSTRING " Link "REQUESTSTRING"} @{"TEXT " Link "TEXT" } @{"TEXTPEN " Link "TEXTPEN" } @{"TIMEOUT " Link "TIMEOUT" } @{"TITLE " Link "TITLE" } @{"WINDOWTOBACK " Link "WINDOWTOBACK" } @{"WINDOWTOFRONT " Link "WINDOWTOFRONT"} @endnode @node ASK @{b}ASK@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} TEXT/A,GADGETS/M/A @{b}Function:@{ub} This command will display a requester inside the Welcome window, waiting for the user to respond. If you invoked ask from WEcho, the user's choise will be returned in the local variable "Result.2". If ASK was invoked from ARexx, the result is returned in 'result'. The gadget numbering is as follows: 1, 2, 3, 4, ... 0. If you want keyboard shortcuts for the gadgets, preceed the wanted shortcut letter with a underscore '_'. Like this: "_Yes", then the 'Y' will be underlined. NOTE: if the gadgets won't fit in the requester the result will be 0. @{b}Options:@{ub} ACTIVATE/S Activate the Welcome Window TEXT/A The question or information the user is presented with. GADGETS/M/A Names for the gadgets the user can click on. You @{b}Example:@{ub} ; This is an AmigaDOS script ; WEcho ASK "Hello, how are you today?" _Nice _Blunt If $Result.2 EQ 1 WEcho "Good, then I'll be nice too." Else WEcho "Well, well, I will watch you." EndIf @endnode @node BACKGROUNDPEN @{b}BACKGROUNDPEN@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} /N @{b}Function:@{ub} Changes the text background colour, the colour-number ranges from zero to seven. @{b}Options:@{ub} /N Colour number @{b}Example:@{ub} WEcho BACKGROUNDPEN 3 @endnode @node CLEAR @{b}CLEAR@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} , @{b}Function:@{ub} This command clears the message-box. @{b}Options:@{ub} None @{b}Example:@{ub} WEcho CLEAR @endnode @node DISABLE @{b}DISABLE@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} NAMES/M @{b}Function:@{ub} This command will let you disable ARexx-commands in Welcome, it's useful if you don't want to execute a certain command by accident. @{b}Options:@{ub} NAMES/M A list of command names that will be disabled. @{b}Example:@{ub} WEcho DISABLE QUIT @endnode @node ENABLE @{b}ENABLE@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} NAMES/M @{b}Function:@{ub} This command enables ARexx-commands disabled with DISABLE. @{b}Options:@{ub} NAMES/M A list of command names that will be enabled. @{b}Example:@{ub} WEcho ENABLE QUIT @endnode @node HELP @{b}HELP@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} COMMAND,PROMPT/S @{b}Function:@{ub} This command will display a list of the available commands in Welcome. This might be useful if you don't have the documentation at hand. @{b}Options:@{ub} COMMAND PROMPT/S @{b}Example:@{ub} WEcho HELP @endnode @node NOP @{b}NOP@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} , @{b}Function:@{ub} This command is a do-nothing-operation. Very useful for absolutely nothing at all. @{b}Options:@{ub} , No options, all parameters are ignored. @{b}Example:@{ub} Well, this command exists only for completeness, and does not have any functonality. @endnode @node OPEN @{b}OPEN@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} FILENAME/K @{b}Function:@{ub} Displays the file in the message-box. @{b}Options:@{ub} FILENAME/K Full pathname to the file. @{b}Example:@{ub} /* Testing Welcome in conjunction with @{"Fortune" Link "Fortune"} */ Address WELCOME 'CLEAR' Address COMMAND 'Fortune UNDERLINE 0 OVERLINE 0 NOTAB >PIPE:' Address WELCOME 'OPEN FILENAME PIPE:' @endnode @node QUIT @{b}QUIT@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} FORCE/S WAIT/S @{b}Function:@{ub} Quits Welcome. @{b}Options:@{ub} FORCE/S Added for completeness, no function. WAIT/S The 'QUIT WAIT' command will not return until the user press the keys 'Ctrl-C' or 'Ctrl-D'. @{b}Example:@{ub} WEcho QUIT @endnode @node REQUESTFILE @{b}REQUESTFILE Under development, THINGS MAY CHANGE@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} DRAWER,FILE/K,PATTERN/K,TITLE/K,POSITIVE/K,NEGATIVE/K, ACCEPTPATTERN/K,REJECTPATTERN/K,SAVEMODE/S,MULTISELECT/S, DRAWERSONLY/S,NOICONS/S MAKEDIRS/S,DIRS/S,FILES/S,SELECTOR/S,SELECT/K,UNSELECT/K @{b}Function:@{ub} Provides 'Installer-like' directory manipulation and file selection. @{b}Options:@{ub} DRAWER Start CD FILE/K Filename that appears in the file-gadget SELECTOR/S Add a selection pattern gadget SELECT/K Pattern filtering in files selected UNSELECT/K Pattern filtering out files selected MAKEDIRS/S Add Makedir gadget DIRS/S Show Dirs FILES/S Show Files @{b}Example:@{ub} @endnode @node REQUESTSTRING @{b}REQUESTSTRING Under development, THINGS MAY CHANGE@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} TEXT/A,DEFAULT @{b}Function:@{ub} Prompts the user for keyboard input. @{b}Options:@{ub} TEXT/A Explanatory text over the string-gadget DEFAULT Default contents in the string-gadget @{b}Example:@{ub} WEcho REQUESTSTRING "Please enter your name:" "John Doe" @endnode @node TEXT @{b}TEXT@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} NOLINE/S,TEXT/F @{b}Function:@{ub} Welcome will display the text in the message-box. Note that if you send an misspelled or unimplemented ARexx-command to Welcome, the command-line will be displayed in the message- box. This behaviour is a compability tradeoff so you don't have to alter your old scripts too much that used WEcho release 1. NOTE: If you use the NOLINE option, it must be the first in the commandline. Like: TEXT NOLINE "Hello there, ", @{b}not:@{ub} TEXT "Hello there, " NOLINE. @{b}Options:@{ub} NOLINE/S The cursor won't jump to the next line. TEXT/F The text that will be written in the text box. @{b}Example:@{ub} @endnode @node TEXTPEN @{b}TEXTPEN@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} /N @{b}Function:@{ub} Changes the text colour, the colour-number ranges from zero to seven. @{b}Options:@{ub} /N Colour number. @{b}Example:@{ub} WEcho TEXTPEN 1 @endnode @node TIMEOUT @{b}TIMEOUT Not implemented yet@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} /N @{b}Function:@{ub} @{b}Options:@{ub} /N @{b}Example:@{ub} @endnode @node TITLE @{b}TITLE@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} LEFT/K,RIGHT/K,TEXT/K @{b}Function:@{ub} The TITLE-command let you change the appearances of the images and text. Every new element must be less than or equal the size of the old pictures or text. Look at Welcome @{"Options" Link Options}. @{b}Options:@{ub} LEFT/K -Filename for the left picture RIGHT/K -Filename for the right picture TEXT/K -The text displayed in the middle @{b}Example:@{ub} @endnode @node WINDOWTOBACK @{b}WINDOWTOBACK@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} , @{b}Function:@{ub} Pops the Welcome window to back. @{b}Options:@{ub} None @{b}Example:@{ub} @endnode @node WINDOWTOFRONT @{b}WINDOWTOFRONT@{ub} @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} , @{b}Function:@{ub} Pops the Welcome window to front. @{b}Options:@{ub} None @{b}Example:@{ub} @endnode @node Examples This simple ARexx program is mainly a speed performance test. ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ /* Welcome ARexx program */ Address WELCOME Do i=200 To 1 By -1 TEXT 'This is row number 'i End This ARexx program demonstrates the OPEN command. ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ /* Testing Welcome in conjunction with @{"Fortune" Link "Fortune"} */ Address WELCOME 'CLEAR' Address COMMAND 'Fortune UNDERLINE 0 OVERLINE 0 NOTAB >PIPE:' Address WELCOME 'OPEN FILENAME PIPE:' This ARexx program demonstrates simple user interaction. ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ /* Welcome and interactivity */ Address WELCOME Options RESULTS 'ASK "Do you want to install the Fonts?" Yes No' IF result THEN DO 'TEXT "Installing Fonts..." NOLINE' ADDRESS COMMAND 'Copy "Install Disk 1:Fonts" FONTS: all' ADDRESS WELCOME 'TEXT Ready.' END @endnode @node WEcho WEcho @{fg shine}ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ@{fg text} @{b}Template:@{ub} PORTNAME/K,COMMAND/A/F @{b}Function:@{ub} If you want to send commands to Welcome from an ordinary AmigaDOS script or shell, WEcho is a better choise than RX, because you don't have to specify the port-name. Though it should work, I recommend that you don't use WEcho to send commands to other ARexx hosts than Welcome, since WEcho doesn't act on all the message-flags defined in ARexx. @{b}Options:@{ub} PORTNAME/K The name of the ARexx port where the commands will be posted. Note that the name is case sensitive. Default name is WELCOME. COMMAND/A/F The command line sent to PORTNAME. @{b}Examples:@{ub} WEcho Hello there, and welcome! WEcho PORTNAME WELCOME2 ASK "How are you doing?" Fine Awfully @endnode @node Fortune Fortune is an exellent Fortune-cookie-program developed by Stefan Ervik. The data-file contains over 4500 cookies, and is still growing. Some samples: _________________________________________________ Paranoia is simply an optimistic outlook on life. ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ ____________________________________________________________ A chubby man with a white beard and a red suit will approach you soon. Avoid him. He's a Commie. ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ ______________________________________________________________ It is generally agreed that "Hello" is an appropriate greeting because if you entered a room and said "Goodbye," it could confuse a lot of people. -- Dolph Sharp, "I'm O.K., You're Not So Hot" ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ @endnode @node Development This is release 2 of Welcome, the previous highest version was 1.46. This release differs from the previous release in: ARexx interface, interactivity (ASK) and font support. Actually, this release is a total rewrite. Written by Urban Lindeskog of ProNova SoftWare Development Group. ProNova Members are: Urban Lindeskog Stefan Ervik David Nilsson Daniel Johansson Stefan Andersson Send Comments, Bug-Reports and such to: Electronic Mail: H.I.V. BBS: +46-(0)31-426985 (Try there first) (NOTE:New number) CCW BBS: +46-(0)31-132310 FidoNet: 2:203/143.1 AmyNet: 39:160/305.1 User Name: Urban Lindeskog Regular Mail: Address: Ekċsv. 18 B S-433 62 PARTILLE SWEDEN Telephone: +46-(0)31-266806 If you contact me, I will let you know when future versions are available. Thank you for your kind attention. @endnode @node NotReady "Under Development THINGS MAY CHANGE" This function may or may not change, it is uncertain if it will be implemented at all. So just see that part of the documentation as a hint of what might come. @endnode