AmigaOS Documentation Wiki - User contributions [en]

SDK Developer Tools

2026-01-24T00:08:40Z

Janne Peräaho: Clarified what the tool does

= Introduction =

The Software Development Kit (SDK) contains a suite of software tools to aid developers in making software for AmigaOS.

== Tags ==

Incomplete description.

{|
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Archiving || An archiving tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Building || A building tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Code Generation || A source code generator tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Conversion || A conversion tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Debugging || A debugging tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Documenting || A documenting tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Localization || A localization tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Optimizing || An optimizing tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Testing || A testing tool
|-
| style="padding-left: 12px; padding-right: 12px; padding-top: 1px; padding-bottom: 1px;" | <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Versioning || A versioning tool
|}

== Format ==

The following lists the characters that indicate the type of argument shown in format listings. Do not use these characters as part of the command.

{| class="wikitable"
| < > || Angle brackets indicate where additional information, such as a file name, must be included. This argument is required if it is not surrounded by square brackets. (For example, [<filename>]; see below.)
|-
| [ ] || Square brackets enclose optional arguments and keywords. Although not required, these arguments and keywords are accepted by the command.
|-
| { } || Braces enclose items that can be given once or repeated any number of times. For example, {<args>} indicates that several items can be given for this argument.
|-
| <nowiki>|</nowiki> || Vertical bars separate lists of options from which you can choose only one. For example, <nowiki>[OPT R|S|RS]</nowiki> indicates a choice of the R option, the S option, or both options.
|-
| <n> || A numeric value is expected by the argument.
|-
| KEYWORD || An upper case keyword indicate that the argument's keyword is required if you include that argument.
|-
| ... || An ellipsis (...) after a string argument indicates that the string must be the final argument on the command line. Including a comment is not allowed. The remainder of the command line is taken as the desired string. Quotation marks are not needed around the string, even if it contains spaces. If you enter quotation marks, they are part of the string. If you specify the keyword, you can put leading and trailing spaces in the string.
|-
| command line indentation || On command lines that are long enough to wrap to the next line, this manual shows the wrapped lines as indented for documentation purposes only. In practice, the wrapped lines align with the first character of the Shell prompt.
|}

= AutoDoc =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Documenting

AutoDoc extracts and sorts [[Autodoc_Style_Guide|autodocs]] from the given files and prints them in the standard output.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: AUTODOC [-t <number>] [-i] [-o] [-a] [-s] [-C] [-l <length>] [-w] [-c] [-f] [-r] [-F <file>] [-I] {<infile>}

; Template
: -t <number> -i -o -a -s -C -l <length> -w -c -f -r -F file -I {infile}

; Location
: SDK:C

The options are:
{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| {<infile>} || List of files to be processed.
|- style="vertical-align: top;"
| -t<number> || Turn tabulators to given number of spaces.
|- style="vertical-align: top;"
| -i || Process only INTERNAL autodocs.
|- style="vertical-align: top;"
| -o || Process only OBSOLETE autodocs.
|- style="vertical-align: top;"
| -a || Do not process autodocs starting with an asterisk.
|- style="vertical-align: top;"
| -s || Process autodocs starting with a semicolon.
|- style="vertical-align: top;"
| -C || Process autodocs starting with "/*". This is the default setting.
|- style="vertical-align: top;"
| -l<number> || Set the line length for the output. The default is 78.
|- style="vertical-align: top;"
| -w || Turn off word wrapping.
|- style="vertical-align: top;"
| -c || Do not convert "\*" to "/*" or "*\" to "*/".
|- style="vertical-align: top;"
| -f || Do not add form feeds between the autodoc entries.
|- style="vertical-align: top;"
| -r || Generate Troff source output.
|- style="vertical-align: top;"
| -F<file> || Use <file> as a temporary file. The default temporary file is "tmpfile".
|- style="vertical-align: top;"
| -I || Do not print "Table of Contents" before entries. If omitted, "Table of Contents" will be printed after the entries.
|}

; Example
Extract autodocs from files "main.c" and "functions.h" and redirect AutoDoc's output to file "MyDocs.doc".
1> autodoc -a -C main.c functions.h >MyDocs.doc

== ARexx Interface ==

AutoDoc has no ARexx interface.

= BuildLanguageCT =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Code Generation <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Localization

This tool generates a catalog translation file (CT file) from the current system language driver.

A new language.catalog can be created with a [[SDK_Developer_Tools#CatComp|CatComp]] tool using the generated CT file and a language catalog descriptor file (located in "SYS:Locale-Source/language.cd").
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: BUILDLANGUAGECT

; Template
: (none)

; Location
: SDK:C

; See also
* [[SDK_Developer_Tools#CatComp|CatComp]]

; Example 1
List the current language driver strings.
1> BuildLanguageCT

; Example 2
Create a "language.ct" file with the built-in strings of the current system language driver.
1> BuildLanguageCT >language.ct

== ARexx Interface ==

BuildLanguageCT has no ARexx interface.

= BuildMapTable =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Localization

BuildMapTable converts Charset-To-Unicode mapping tables in text form (e.g. available at http://www.unicode.org/Public/MAPPINGS/) to mapping tables in binary form usable by diskfont.library.

BuildMapTable can either display a text form of the parsed table or create a binary mapping table in the "L:Charsets/" directory. Currently only 8-bit character set mapping tables are supported.

If "L:Charsets/character-sets" or "L:Charsets/custom-character-sets" contains a MIME name for an 8-bit character set where no mapping table in "L:Charsets/" does not exist, and you have a mapping table in text form, use BuildMapTable to create the binary mapping table and reboot (diskfont.library searches tables only once) to be able to use the new character set (e.g. in fonts or catalog files).

The expected format of text mapping tables is as follows:
* Anything from a '#' character to the end of a line is considered a comment.
* A valid line does contain the index on the left and the Unicode point at the right side, in either hexadecimal (starting with 0x or 0X) or octal (starting with 0) or decimal form, separated by empty space.

; Example
<code>0xA4 0x20AC # EURO SIGN</code>
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: BUILDMAPTABLE <ASCII mapping table> [CHARSET]

; Template
: UNICODEMAPTABLE/A,CHARSET/K

; Location
: SDK:C

The parameters are:

{| class="wikitable"
| UNICODEMAPTABLE || A character set mapping table file.
|-
| CHARSET || A MIME character set name or alias.
|}

The '''UNICODEMAPTABLE''' parameter specifies a character set mapping table file to be read and the '''CHARSET''' parameter the binary mapping table file to be written.

The MIME character set name obtained from diskfont.library will be used as file name of the binary character set mapping table which will be stored in "L:Charsets/". If the '''CHARSET''' parameter is omitted, no file will be written, instead the resulting mapping table is displayed in text form.

; Example 1
Parse a text file "CP1258.TXT" and display a list of entries with the index on the left and the Unicode codepoint at the right side.
1> BuildMapTable CP1258.TXT

Note: unmapped entries (with Unicode codepoint 0) are not displayed.

; Example 2
Parse a text file "8859-1.TXT" and create a file "L:Charsets/ISO-8859-1" (latin1 is an alias for ISO-8859-1).
1> BuildMapTable 8859-1.TXT CHARSET LATIN1

== ARexx Interface ==

BuildMapTable has no ARexx interface.

= BumpRev =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Code Generation <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Versioning

BumpRev updates version and revision information and makes this available for program code to use it. It generates header file for '''C''' and '''Assembly''' language programs to use. The typical application is to "bump" (i.e. increment) the revision number of a program, library, device, etc. after it has been changed and before it is released.

There are two common practices to use BumpRev:
<ol style="list-style-type:lower-alpha">
<li>Update the revision number whenever the software is rebuilt</li>
<li>Update the revision number only when a new release is created</li>
</ol>

The advantage of '''a.''' is that you can integrate it into your built process, and you won't ever forget to bump a revision number when something has changed. The disadvantage is that revision numbers can increase very quickly (do not worry: you have 65535 revisions to spare).

The advantage of '''b.''' is that it saves revision numbers (which can become scarce), but the disadvantage is that you might forget to bump a revision number before you rebuilt a new release.

Practice '''a.''' has a lot going for it, and it was the preferred default at Commodore when AmigaOS 2.x/3.x were created.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: BUMPREV [-q] [-v <version>] [-r <revision>] [-n <name>] [-b <base name>] [-d <depend list file>]
:: [-e <exclude suffix>] [-i <include suffix>] [-D] [-L] [<version> <base name> [<depend list file>]]

; Template
: -q -v <version> -r <revision> -n <name> -b <base name> -d <depend list file>
: -e <exclude suffix> -i <include suffix> -D -L <version> <base name> <depend list file>

; Location
: SDK:C

The options are:
{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| -q || Activate "quiet" operation, i.e. will not print any warning or progress messages, but will print error message.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -v <version> || Set the version number to use. This must be a number greater than 0. Note that version numbers greater than 255 are unsafe to use for some applications since a "struct Resident" only reserves an unsigned 8-bit integer for storing a version number in it.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -r <revision> || Set the revision number to use rather than let BumpRev read and increment it instead. This must be a number greater than 0.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -n <name> || Set the name of the program, library, device, etc. If it is not the same as the base name (see below). This can be useful for software built on systems which do not use a case-insensitive file system
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -b <base name> || Set the base file name all the work and header file names are generated from. This also becomes the name that is written to the files unless you override this with the '''-n''' option (see above).
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -d <depend list file> || A file which contains a list of file names whose modification times should be compared against the modification time of the file which contains the revision number. If any of these files has been modified after the revision number file has a new revision will be created; otherwise BumpRev will exit immediately. There must be one file name per line. Note that if you give "-" as the file name, BumpRev will try to read the file name list from standard input.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -e <exclude suffix> || By default BumpRev generates three header files: one for use with '''C''' and two for use with '''Assembly'''. language The '''C''' header file name ends with ".h" and the two '''Assembly''' language file names end with ".i" and ".s", respectively. You can tell BumpRev not to create all of these files with the '''-e''' option.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -i <include suffix> || This controls which header files should be created, with the default being the ".h", ".i", and ".s" files. The difference between the '''-i''' option and '''-e''' option is that with '''-i''' you say exactly what header files you want, and not what you do not want.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -D || Add a '''DEVNAME''' definition to the output files.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -L || Add a '''LIBNAME''' definition to the output files.
|}

You can specify the base name, the version number and the dependencies file name both using options and as regular parameters. But you do not need to specify both. For example, the following commands are equivalent:
BumpRev -b foo 1
BumpRev 1 foo
BumpRev -v 1 foo
BumpRev -v 1 -b foo

The following commands are equivalent, too:
BumpRev 1 bar dependencies_file
BumpRev -b bar 1 dependencies_file
BumpRev -v 1 -d dependencies_file bar
BumpRev -v 1 -b bar dependencies_file

; Example 1
Create or update a revision file "foo_rev.rev" unless it already exists, and create three more header files: "foo_rev.h", "foo_rev.1", and "foo_rev.s".
1> BumpRev 1 foo
BumpRev: Creating new file "foo_rev.rev"
BumpRev: Bumped "foo" to version 1.1.

If you invoke BumpRev with the same parameters again, the revision file will be updated, incrementing the revision number. The three header files will be updated, too.
1> BumpRev 1 foo
BumpRev: Bumped "foo" to version 1.2.

; Example 2
The name you give BumpRev goes into the names of the header files, and it also becomes the name printed in each string. This can be overridden with the '''-n''' option.
1> BumpRev -n Bar 1 bar
BumpRev: Creating new file "bar_rev.rev".
BumpRev: Bumped "Bar" to version 1.1.
The resulting files still use the same base name, but the names printed in the files are different.

'''bar_rev.h'''
<syntaxhighlight lang="c">
#define VERSION 1
#define REVISION 1
#define DATE "15.6.2020"
#define VERS "Bar 1.1"
#define VSTRING "Bar 1.1 (15.6.2020)\r\n"
#define VERSTAG "\0$VER: Bar 1.1 (15.6.2020)"
</syntaxhighlight>

; Example 3
BumpRev defaults to create three header files, but at times there may be only one you need. To create just the '''C''' language header file, you would use the '''-e''' option like this:
1> BumpRev -e si 1 baz
This would create only "baz_rev.h" and omit "baz_rev.i" and "baz_rev.s".

== ARexx Interface ==

BumpRev has no ARexx interface.

= CatComp =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Localization

CatComp is a program to handle the creation and maintenance of the message catalogs used by locale.library. Message catalogs are IFF files read by locale.library that contain all the text strings used by an application. By providing several of these catalog files, an application can use locale.library and transparently adapt itself to the user's preferred language.

CatComp reads and processes two kinds of input files, and produces five types of output files.

; CatComp Input Files

The first kind of file read by CatComp is a catalog description file. That file describes all the strings used by an application. There is one such file per localized application. In this file, you assign numbers to all the application strings as well as specify their minimum and maximum lengths.

The second kind of file read by CatComp is a catalog translation file. That file contains all strings from the application translated to one language. There is one catalog translation file per language supported by a localized application.

; CatComp Output Files

CatComp can produce several different kinds of output files. The first is an IFF catalog. These are regular IFF files. There is one catalog produced for every catalog text file successfully processed. Catalogs are read directly by locale.library whenever the OpenCatalog() call is made.

The second type of file output by CatComp is an empty translation file. This is useful when starting a translation. It lets CatComp convert a catalog description file into a ready to fill-in translation file.

The third type of file output by CatComp is a new translation file based on an old one. This is useful when re-starting a translation after a catalog description file was modified, because the new and the modified strings will be stored in the the new catalog translation file.

The fourth and fifth type of files output by CatComp are '''C''' and '''Assembly''' language programming source files. These are used by application writers to convert catalog description files into source files that can be directly used in their applications.

The sixth and seventh type of files output by CatComp are '''Modula-2''' language definition and implementation source files, which are used by programmers in much the same way '''C''' and '''Assembly''' files are used.

Finally, the last type of file output by CatComp is an AmigaDOS load file. These load files are used by application writers to include a set of strings directly inside an application. This is normally used to encode the default strings that an application uses when there are no external catalogs available.

; File Formats

To learn more about CatComp's input and output files, consult CatComp documentation located in the Software Development Kit: '''SDK:Documentation/Tools/Locale/CatComp.doc'''.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: CATCOMP <descriptor> [<cd file>] [CATALOG=<catalog file>] [CTFILE=<ct file>] [CFILE=<c source file>]
:: [SYMBOLS={<symbol>}] [VERBOSITY=<verbosity level>] [NOOPTIM] [NONUMBERS] [NOSTRINGS] [NOARRAY]
:: [NOBLOCK] [NOCODE] [SORT] [COMMENTS]

; Template
: DESCRIPTOR/A,TRANSLATION,CATALOG/K,CTFILE/K,CFILE/K,SYMBOLS/M/K,VB=VERBOSITY/N/K,NOOPTIM/S,
: NONUMBERS/S,NOSTRINGS/S,NOARRAY/S,NOBLOCK/S,NOCODE/S,SORT/S,COMMENTS/S

; Location
: SDK:C

The options are:
{| class="wikitable"
| DESCRIPTOR || Specifies the name of a catalog descriptor file. Typically, the file extension for catalog descriptor files is ".cd".
|- style="vertical-align: top;"
| TRANSLATION || Specifies the name of a catalog translation file. Typically, the file extension for catalog translation files is ".ct".
|- style="vertical-align: top;"
| CATALOG || Specifies the name of the IFF catalog file to produce. When this option is specified, a translation file must have been given in the previous argument.
|- style="vertical-align: top;"
| CTFILE || Specifies the name of the catalog translation file to produce. This option only requires a catalog descriptor file be provided, then the catalog translation file will be blank. When you also specified a source translation file, the version string, language, codeset, and strings of the source translation file will be copied to the new translation file.
|- style="vertical-align: top;"
| CFILE || Specifies the name of the '''C''' language source file header to produce. This option only requires a catalog descriptor file be provided, there is no need for a translation file.
|- style="vertical-align: top;"
| SYMBOLS || Specifies any number of symbols that are used for determining which section of the available strings get included within generated '''C''', '''Assembly''', and object files. The valid symbols are:

{| class="wikitable"
! style="text-align:left;"| Symbol
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CATCOMP_NUMBERS || This symbol causes the name of each string to be defined with the value of its ID, as listed in the catalog descriptor file.
|- style="vertical-align: top;"
| CATCOMP_STRINGS || This symbol causes each string to be defined.
|- style="vertical-align: top;"
| CATCOMP_ARRAY || This symbol causes a table of CatCompArray structure to become available.
|- style="vertical-align: top;"
| CATCOMP_BLOCK || This symbol causes a compact table of all strings and their ID values to be generated.
|- style="vertical-align: top;"
| CATCOMP_CODE || This symbol causes the generation of source code for a function called GetString().
|}

|- style="vertical-align: top;"
| VB or VERBOSITY || Specifies the amount of information CatComp should output while doing some processing. The lower this number, the less CatComp will output messages.

{| class="wikitable"
! style="text-align:left;"| Verbosity Level
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| 0 || No warnings
|- style="vertical-align: top;"
| 1 || At verbosity level 1 or higher, warnings about '''C''' language formatting commands and warnings about missing strings in catalog translation files can appear.
|- style="vertical-align: top;"
| 2 || At verbosity level 2 or higher, warnings about missing trailing ellipsis (...) in catalog descriptor files can appear.
|- style="vertical-align: top;"
| 3 || At verbosity level 3 or higher, warnings about trailing blank characters and non-ASCII characters in catalog descriptor files can appear. This is the default verbosity level.
|- style="vertical-align: top;"
| 4 || At verbosity level 4 or higher, CatComp will output every message it could. This includes warnings about identical strings in catalog descriptor and catalog translation files (which are not shown when the '''NOOPTIM''' switch was spesified).
|}

|- style="vertical-align: top;"
| NOOPTIM || When generating a catalog file, CatComp normally skips strings that are identical in the catalog descriptor file and in the catalog translation file and does not include them in the generated catalog file. This option disables this optimization.
|- style="vertical-align: top;"
| NONUMBERS || This option is only useful when generate '''C''' or '''Assembly''' language header files. It prevents the generation of the '''CATCOMP_NUMBERS''' section within the header file.
|- style="vertical-align: top;"
| NOSTRINGS || This option is only useful when generate '''C''' or '''Assembly''' language header files. It prevents the generation of the '''CATCOMP_STRINGS''' section within the header file.
|- style="vertical-align: top;"
| NOARRAY || This option is only useful when generate '''C''' or '''Assembly''' language header files. It prevents the generation of the '''CATCOMP_ARRAY''' section within the header file.
|- style="vertical-align: top;"
| NOBLOCK || This option is only useful when generate '''C''' or '''Assembly''' language header files. It prevents the generation of the '''CATCOMP_BLOCK''' section within the header file.
|- style="vertical-align: top;"
| NOCODE || This option is only useful when generate '''C''' or '''Assembly''' language header files. It prevents the generation of the '''CATCOMP_CODE''' section within the header file.
|- style="vertical-align: top;"
| SORT || When specified, all strings will be sorted by ID before they are written to header/assembler/object/catalog files. Catalog translation files will, however, get written in the same order in which the strings showed up in the catalog descriptor file.
|- style="vertical-align: top;"
| COMMENTS || When both this switch and '''CTFILE''' were spesified, the comment lines from the catalog description file will be copied into the new catalog translation file.
|}

; Example 1
Test if "app.cd" is a valid catalog descriptor file.
1> CatComp app.cd

; Example 2
Generate a blank translation file called "app.ct".
1> CatComp app.cd CTFILE app.ct

; Example 3
Create a catalog file "app.catalog".
1> CatComp app.cd app.ct CATALOG app.catalog

== ARexx Interface ==

CatComp has no ARexx interface.

= ChangeRegs =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Code Generation <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Conversion

Missing description.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: CHANGEREGS <source file> <destination> [HEADER] [NEWSUFFIX=<file extension>]

; Template
: SRC=SOURCE/A,DEST=DESTPATH,HEADER/S,NS=NEWSUFFIX/K

; Location
: SDK:C

The parameters are:

{| class="wikitable"
| SRC or SOURCE || C source code file to be processed.
|-
| DEST or DESTPATH || Path to directory where the processed source code will be saved.
|-
| HEADER || Add register definitions for SAS/C and GNU/C at the beginning of the source code.
|-
| NS or NEWSUFFIX || Save the processed source code with a new file extension.
|}

== ARexx Interface ==

ChangeRegs has no ARexx interface.

= DistCC =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Building

DistCC is a program to distribute builds of C or C++ code across several machines on a network. It does not require all machines to share a filesystem, have synchronized clocks, or to have the same libraries or header files installed. They can even have different processors or operating systems if cross-compilers are installed.

DistCC is not itself a compiler, but rather a front-end to the GNU C/C++ compiler ([[SDK_Developer_Tools#GCC|GCC]]), or another compiler of your choice. All the regular GCC options and features work as normal.

For each job, DistCC sends the complete preprocessed source code and compiler arguments across the network from the client to a [[SDK_Developer_Tools#DistCCD|compilation server]]. Compilation is driven by a client machine, which is typically the developer's workstation. The DistCC client runs on this machine, as does [[SDK_Developer_Tools#Make|Make]], the preprocessor, the linker, and other stages of the build process. Any number of volunteer machines act as compilation servers and help the client to build the program by running the [[SDK_Developer_Tools#DistCCD|DistCCD]] daemon, C compiler and assembler as required.

DistCC runs across TCP sockets (on port 3632 by default). For TCP connections the volunteers must run the [[SDK_Developer_Tools#DistCCD|DistCCD]] daemon directly.

DistCC is intended to be used with [[SDK_Developer_Tools#GMake|GNU Make]]'s '''-j''' option, which runs several compiler processes concurrently. DistCC spreads the jobs across both local and remote CPUs. Because DistCC is able to distribute most of the work across the network, a higher concurrency level can be used than for local builds. As a rule of thumb, the '''-j''' value should be set to about twice the total number of available server CPUs but subject to client limitations. This setting allows for maximal interleaving of tasks being blocked waiting for disk or network IO.

It is strongly recommended that you install the same compiler version on all machines participating in a build. Incompatible compilers may cause mysterious compile or link failures.

; Environment Variables

DistCC uses the following environment variables:

{| class="wikitable"
! style="text-align:left;"| Variable
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| DISTCC_DIR || Path to the host list and locks files.
|- style="vertical-align: top;"
| DISTCC_HOSTS || Name of the host list file. The default name is "hosts".
|- style="vertical-align: top;"
| DISTCC_LOG || Name of the log file. When set, DistCC writes its output to the log.
|- style="vertical-align: top;"
| DISTCC_VERBOSE || Setting this to 1 enables debug messages.
|}

; Server Specification

A list of servers will be taken from a file pointed by an environment variable '''$DISTCC_HOSTS''' or '''$DISTCC_DIR/hosts'''. In the file each host can be given in any of these forms:

{| class="wikitable"
! style="text-align:left;"| Host Address / Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| localhost || Run in place.
|- style="vertical-align: top;"
| <host> || TCP connection to a specified host's port 3632.
|- style="vertical-align: top;"
| <host>:<port> || TCP connection to a specified host's port number <port>.
|- style="vertical-align: top;"
| --randomize || Randomize the server list before execution.
|}
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: DISTCC [--help] [--version] [--show-hosts] [-j] [<compiler>] [<compiler options>]

; Template
: --help --version --show-hosts -j <compiler> <compiler options>

; Location
: SDK:C

; Tutorials
* [https://www.solie.ca/articles/distcc/distcc.html Distributed Compile on AmigaOS]

; See also
* [[SDK_Developer_Tools#DistCCD|DistCCD]]
* [[SDK_Developer_Tools#GCC|GCC]]
* [[SDK_Developer_Tools#Make_and_GMake|Make]]

The options are:

{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| --help || Explain DistCC usage and exit.
|- style="vertical-align: top; white-space: nowrap;"
| --version || Show DistCC version and exit.
|- style="vertical-align: top; white-space: nowrap;"
| --show-hosts || Show host list and exit.
|- style="vertical-align: top; white-space: nowrap;"
| -j || Calculate the concurrency level from the host list.
|-
| <compiler> || Compiler to use. Defaults to '''cc'''.
|- style="vertical-align: top; white-space: nowrap;"
| <compiler options> || Compiler options. As a minimum, you should supply a list of source files to be compiled.
|}

== ARexx Interface ==

DistCC has no ARexx interface.

= DistCCD =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Building

DistCCD is the server for the [[SDK_Developer_Tools#DistCC|DistCC]] distributed compiler. It accepts and runs compilation jobs for network clients. DistCCD will listen for network connections and fork several child processes to serve them.

; Environment Variables

DistCCD uses the following environment variables:

{| class="wikitable"
! style="text-align:left;"| Variable
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| DISTCC_CMDLIST || If the environment variable DISTCC_CMDLIST is set, load a list of supported commands from the file named by DISTCC_CMDLIST, and refuse to serve any command whose last DISTCC_CMDLIST_MATCHWORDS last words do not match those of a command in that list.
|- style="vertical-align: top;"
| DISTCC_CMDLIST_NUMWORDS || The number of words, from the end of the command, to match. The default is 1.
|- style="vertical-align: top;"
| DISTCCD_PATH || When starting distccd, if this value is set it will be used unaltered for the command-execution path. The code that normally tries to remove masquerade directories from the path is skipped.
|- style="vertical-align: top;"
| DISTCC_SAVE_TEMPS || If set to 1, temporary files are not deleted after use.
|- style="vertical-align: top;"
| DISTCC_TCP_DEFER_ACCEPT || Turn on the TCP_DEFER_ACCEPT socket option. Defaults to on.
|- style="vertical-align: top;"
| TMPDIR || Directory for temporary files such as preprocessor output.
|}
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: DISTCCD [--help] [--version] [-P=--pid-file <file>] [-N=--nice <level>] [--user <user>] [-j=--jobs <limit>] [--job-lifetime <seconds>]
:: [-p=--port <port>] [--listen <address>] -a=--allow <ip/bits> [--stats] [--stats-port <port>]
:: [--log-level <level>] [--verbose] [--no-detach] [--log-file <file>] [--log-stderr] [--wizard]
:: [--inetd] [--daemon]

; Template
: --help --version -P=--pid-file <file> -N=--nice <level> --user <user> -j=--jobs <limit> --job-lifetime <seconds>
: -p=--port <port> --listen <address> -a=--allow <ip/bits> --stats --stats-port <port>
: --log-level <level> --verbose --no-detach --log-file <file> --log-stderr --wizard
: --inetd --daemon

; Location
: SDK:C

; Tutorials
* [https://www.solie.ca/articles/distcc/distcc.html Distributed Compile on AmigaOS]

; See also
* [[SDK_Developer_Tools#DistCC|DistCC]]

The options are:

{| class="wikitable"
! style="text-align:left; white-space: nowrap; width: 180px;" | Option
! style="text-align:left; white-space: nowrap; width: 120px;" | Type
! style="text-align:left;" | Description
|- style="vertical-align: top;"
| --help || General || Display usage information and exit.
|- style="vertical-align: top;"
| --version || General || Show version and exit.
|- style="vertical-align: top;"
| -P <file> or --pid-file <file> || General || Save DistCCD process id to file <file>.
|- style="vertical-align: top;"
| -N <niceness> or --nice <level> || General || Makes the DistCCD more nice about giving up the CPU to other tasks on the machine. <niceness> is an increment to the current priority of the process. The range of priorities depends on the operating system but is typically 0 to 20. By default the niceness is increased by 5.
|- style="vertical-align: top;"
| --user <user> || General || Change user to <user>.
|- style="vertical-align: top;"
| -j <limit> or --jobs <limit> || General || Sets a limit on the number of jobs that can be accepted at any time. By default this is set to two greater than the number of CPUs on the machine, to allow for some processes being blocked on network IO.
|- style="vertical-align: top;"
| --job-lifetime <seconds> || General || Kills a DistCCD job if it runs for more than <seconds> seconds. This prevents denial of service from clients that don't properly disconnect and compilers that fail to terminate. By default this is turned off.
|- style="vertical-align: top;"
| -p <port> or --port <port> || Networking || Set the TCP port to listen on, rather than the default of 3632.
|- style="vertical-align: top;"
| --listen <address> || Networking || Instructs DistCCD to listen on the IP address <address>. This can be useful for access control on dual-homed hosts.
|- style="vertical-align: top;"
| -a <ipaddr>[/<mask>] or --allow <ip/bits> || Networking || Instructs DistCCD to accept connections from the IP address <ipaddr>. A CIDR mask length can be supplied optionally after a trailing slash, e.g. 192.168.0.0/24, in which case addresses that match in the most significant <mask> bits will be allowed. This is a mandatory parameter.
|- style="vertical-align: top;"
| --stats || Networking || Turn on the statistics HTTP server. By default it is off.
|- style="vertical-align: top;"
| --stats-port <port> || Networking || Set the TCP port to listen on for HTTP requests, rather than the default of 3633.
|- style="vertical-align: top;"
| --log-level <level> || Debugging || Set the minimum severity of error that will be included in the log file. Useful if you only want to see error messages rather than an entry for each connection. <level> can be '''critical''', '''error''', '''warning''', '''notice''', '''info''', or '''debug'''.
|- style="vertical-align: top;"
| --verbose || Debugging || Include debug messages in log. Equivalent to '''--log-level=debug'''.
|- style="vertical-align: top;"
| --no-detach || Debugging || Do not detach from the shell that started DistCCD.
|- style="vertical-align: top;"
| --log-file <file> || Debugging || Send messages to file <file>.
|- style="vertical-align: top;"
| --log-stderr || Debugging || Send log messages to stderr. This is mainly intended for use in debugging.
|- style="vertical-align: top;"
| --wizard || Debugging || Turn on all options appropriate for starting DistCCD under GNU debugger GDB.
|- style="vertical-align: top;"
| --inetd || Operation Mode || Serve a client connected to stdin/stdout. Note: this option has been disabled.
|- style="vertical-align: top;"
| --daemon || Operation Mode || Run DistCCD in the background.
|}

; Example
Start the server, allow connections from an IP address 192.168.1.100, and suppress all other messages except error messages.
1> DistCCD --allow 192.168.1.100 --log-level=error
Pressing <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">C</kbd> stops the server.

== ARexx Interface ==

DistCCD has no ARexx interface.

= DistCCMon-Amiga =
[[File:Icon-DistCCMon-Amiga.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Building

Displays the statuses of the current distributed compilation jobs graphically.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: DISTCCMON-AMIGA

; Template
: (none)

; Location
: SDK:C

; Tutorials
* [https://www.solie.ca/articles/distcc/distcc.html Distributed Compile on AmigaOS]

; See Also
* [[SDK_Developer_Tools#DistCC|DistCC]]
* [[SDK_Developer_Tools#DistCCD|DistCCD]]
* [[SDK_Developer_Tools#DistCCMon-Text|DistCCMon-Text]]

== ARexx Interface ==

DistCCMon-Amiga has no ARexx interface.

= DistCCMon-Text =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Building

Displays the statuses of the current distributed compilation jobs.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: DISTCCMON-TEXT [<delay>]

; Template
: <delay>

; Location
: SDK:C

; Tutorials
* [https://www.solie.ca/articles/distcc/distcc.html Distributed Compile on AmigaOS]

; See Also
* [[SDK_Developer_Tools#DistCC|DistCC]]
* [[SDK_Developer_Tools#DistCCD|DistCCD]]
* [[SDK_Developer_Tools#DistCCMon-Amiga|DistCCMon-Amiga]]

When run without parameters, DistCCMon-Text lists the current jobs and exits. If you want to continuously monitor the compilation jobs, supply a job polling delay. For example, to list the jobs in every 3 seconds type
1> DistCCMon-Text 3
When you press Enter, DistCCMon-Text keeps listing the jobs until you interrupt it by pressing <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">C</kbd>.

== ARexx Interface ==

DistCCMon-Text has no ARexx interface.

= Expunge =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Debugging

Expunge is meant as a software developer tool to force shared libraries and devices to expunge themselves. The ramlib process is responsible for expunging libraries when the corresponding disk file has changed so there should be little need for this command in practice. The caching of system libraries and devices is normal and users should not be using this command.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: EXPUNGE [{<library or device>}] [PATTERN <pattern>] [ALL]

; Template
: NAME/M,PAT=PATTERN/K,ALL/S

; Location
: SDK:C

Expunge with no arguments displays the list of devices and libraries along with their open count and flags. This is useful to find out the names of the objects to expunge.

Expunge will attempt to expunge the named shared libraries and/or devices. Since it is not possible to determine whether an expunge succeeds or fails Expunge will always state an object was expunged if it was found.

If PATTERN is specified only libraries and devices matching this pattern will be attempted to be expunged. This pattern may be an arbitrary DOS style pattern.

If the ALL switch is present Expunge will attempt to expunge all the shared libraries and devices with a usage count of zero. Any names specified will be ignored in this case.

If Expunge succeeded, the return code will be set to 0. If Expunge cannot find one or more specified names, it will continue and the return code will be 5. If Expunge fails completely, the return code will be 20. The secondary return code will be set appropriately.

; Example 1
Display the current device and library lists.
1> Expunge

; Example 2
Expunge keyboard.device and graphics.library. Since the use count of these objects is greater than 0 nothing will happen but the command will still succeed. This is because there is no return code on the Expunge vector.
1> Expunge keyboard.device graphics.library

; Example 3
Expunge all the devices and libraries it can find.
1> Expunge ALL

; Example 4
Expunge all the unused catalogs and replace the obsolete Avail FLUSH technique.
1> Expunge locale.library

; Example 5
Expunge all libraries whose name is starting with "amiga" (i.e. amigaguide.library or amigaguide.datatype).
1> Expunge PATTERN amiga#?

== ARexx Interface ==

Expunge has no ARexx interface

= FDTrans =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Code Generation <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Conversion

FDTrans is a small utility for legacy SFD files. It offers two functions:
<div style="clear: both"></div>
# Convert an SFD file into an XML file for processing with the [[SDK_Developer_Tools#IDLTool|IDLTool]]
# Generate '''68k-to-PPC''' or '''PPC-to-68k''' cross call stubs. These are required to use a 68k Library from PPC code (automatically; implicit emulator calling works too but needs special attention) and to make a PPC library callable for (legacy) 68k programs.

FDTrans requires an SFD file as input. If you only have an FD file, you need to revert it to an SFD file using a tool like FD2Pragma.

{{Note|text=SFD file is a file which contains lines describing a library's entry points.}}

Note that for some SFD files it might be required to do some manual correction. Most notably, there is great commotion about the way that vararg functions are specified. The following format is used throughout because it is the most commonly used format:

<syntaxhighlight lang="c">
VOID someFunc(ULONG someparam, ULONG Tag1, ...) (D0,A0)
</syntaxhighlight>

Although this prototype doesn't really make sense (vararg functions are not supposed to list the first vararg argument), this is the way that FDTrans expects the functions in the SFD file. If you have a function like

<syntaxhighlight lang="c">
VOID printf(char *format, ...) (A0,A1)
</syntaxhighlight>

you need to manually add a dummy argument like

: VOID printf(char *format, ULONG dummy, ...) (A0,A1)

For more information on FDTrans, see the developer documentation on migrating old programs and libraries.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: FDTRANS <sfd file> [-o=--output <outfile>] [-i=--struct <structname>] [-l=--library <libname>]
:: [-x=--xml] [-s=--stubs] [-c=--c68k] [-cold] [-a=--all] [-6=--68k] [-4=--inline4] [-v=--verbose]

; Template
: <sfd file> -o=--output <outfile> -i=--struct <structname> -l=--library <libname> -x=--xml
: -s=--stubs -c=--c68k -cold -a=--all -6=--68k -4=--inline4 -v=--verbose

; Location
: SDK:C

; Tutorials
* [[How_to_Build_Stubs_for_68k_Libraries|How to Build Stubs for 68k Libraries]]

; See Also
* [[SDK_Developer_Tools#IDLTool|IDLTool]]

The options are:

{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| <sfd file> || An SFD file to process.
|- style="vertical-align: top; white-space: nowrap;"
| -o <outfile> or --output <outfile> || Use <outfile> as base for output files.
|- style="vertical-align: top; white-space: nowrap;"
| -i <structname> or --struct <structname> || Use <structname> as interface name. Guess name by default.
|- style="vertical-align: top; white-space: nowrap;"
| -l <libname> or --library <libname> || Use <libname> for OpenLibrary. Guess name by default.
|- style="vertical-align: top; white-space: nowrap;"
| -s=--stubs || Generate the PPC-to-M68k cross-call stubs in C.
|- style="vertical-align: top; white-space: nowrap;"
| -c=--c68k || Generate the M68k-to-PPC cross-call stubs in C.
|- style="vertical-align: top; white-space: nowrap;"
| -cold || Generate the M68k-to-PPC cross-call stubs in C but without TRAPTYPENR.
|- style="vertical-align: top; white-space: nowrap;"
| -a=--all || Generate the PPC-to-M68k and M68k-to-PPC cross-call stubs in C.
|- style="vertical-align: top; white-space: nowrap;"
| -6=--68k || Generate M68k-to-PPC cross-call stubs in Assembler.
|- style="vertical-align: top; white-space: nowrap;"
| -4=--inline4 || Generate special inline4 for using M68k libraries without a PPC interface (interface pointer can be NULL).
|- style="vertical-align: top; white-space: nowrap;"
| -v=--verbose || Be verbose.
|}

== ARexx Interface ==

FDTrans has no ARexx interface.

= FSTest =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Debugging

FSTest is a tool that checks for problems with a mounted file system on your computer. When executed without parameters, FSTest displays a complete list of the available tests:
<div style="clear: both"></div>
{| class="wikitable"
! style="text-align:left;"| Test Number
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| 1 || Add a notification.
|- style="vertical-align: top;"
| 2 || Change the current mode of a lock.
|- style="vertical-align: top;"
| 3 || Change the file mode.
|- style="vertical-align: top;"
| 4 || Change the current file position.
|- style="vertical-align: top;"
| 5 || Change the size of a file.
|- style="vertical-align: top;"
| 6 || Close an open file.
|- style="vertical-align: top;"
| 7 || Create a directory.
|- style="vertical-align: top;"
| 8 || Create a hard link.
|- style="vertical-align: top;"
| 9 || Create a soft link.
|- style="vertical-align: top;"
| 10 || Delete a file, directory, or symbolic link.
|- style="vertical-align: top;"
| 11 || Get information on a device.
|- style="vertical-align: top;"
| 12 || Duplicate an existing lock.
|- style="vertical-align: top;"
| 13 || Get a lock on an open file.
|- style="vertical-align: top;"
| 14 || Reserved for a ExamineDir() test.
|- style="vertical-align: top;"
| 15 || Examine a file.
|- style="vertical-align: top;"
| 16 || Examine a locked file system object.
|- style="vertical-align: top;"
| 17 || Reserved for FileSystemAttr() test.
|- style="vertical-align: top;"
| 18 || Reserved for Flush() test.
|- style="vertical-align: top;"
| 19 || Reserved for Format() test.
|- style="vertical-align: top;"
| 20 || Reserved for GetFilePosition() test.
|- style="vertical-align: top;"
| 21 || Obtain the size of a file.
|- style="vertical-align: top;"
| 22 || Inhibit access to a filesystem.
|- style="vertical-align: top;"
| 23 || Lock a directory or a file.
|- style="vertical-align: top;"
| 24 || Lock a record (a portion of a file).
|- style="vertical-align: top;"
| 25 || Open a file.
|- style="vertical-align: top;"
| 26 || Open a file you have a lock on.
|- style="vertical-align: top;"
| 27 || Obtain the parent directory for a directory or file lock.
|- style="vertical-align: top;"
| 28 || Get a shared lock on the parent directory of a file.
|- style="vertical-align: top;"
| 29 || Read data from a file.
|- style="vertical-align: top;"
| 30 || Read the target object string for a filesystem soft link.
|- style="vertical-align: top;"
| 31 || Change the volume name.
|- style="vertical-align: top;"
| 32 || Remove notify.
|- style="vertical-align: top;"
| 33 || Rename a file, directory, or symbolic link.
|- style="vertical-align: top;"
| 34 || Reserved for SameFile() test.
|- style="vertical-align: top;"
| 35 || Reserved for SameLock() test.
|- style="vertical-align: top;"
| 36 || Reserved for Serialize() test.
|- style="vertical-align: top;"
| 37 || Change a comment string on a filesystem object.
|- style="vertical-align: top;"
| 38 || Set the modification date for a file or directory.
|- style="vertical-align: top;"
| 39 || Set group for a file or directory.
|- style="vertical-align: top;"
| 40 || Set owner for a file or directory.
|- style="vertical-align: top;"
| 41 || Set protection for a file or directory.
|- style="vertical-align: top;"
| 42 || Unlock a file or directory.
|- style="vertical-align: top;"
| 43 || Unlock a locked record.
|- style="vertical-align: top;"
| 44 || Reserved for VolumeInfoData() test.
|- style="vertical-align: top;"
| 45 || Write data to a file.
|- style="vertical-align: top;"
| 46 || Set a write protection status of a volume.
|}

== Tool Types ==

(none)

== Shell Usage ==

; Format
: FSTEST <device> [NOINFOMESSAGES] [NOWARNMESSAGES] [NOROOTMESSAGES] [ABORTONERR]
:: [FIRSTTESTNUMBER <test number>] [LASTTESTNUMBER <test number>] [TESTNUMBER <test number>]

; Template
: DEVICE/A,NOINFOMESSAGES=NI/S,NOWARNMESSAGES=NW/S,NOROOTMESSAGES=NR/S,
: ABORTONERR=AOE/S,FIRSTTESTNUMBER=FTN/K/N,LASTTESTNUMBER=LTN/K/N,TESTNUMBER=TN/K/N

; Location
: SDK:C

The options are:

{| class="wikitable"
| DEVICE || Device to test.
|-
| NOINFOMESSAGES or NI || Do not show additional information on tests.
|-
| NOWARNMESSAGES or NW || Do not show warnings.
|-
| NOROOTMESSAGES or NR || Missing description.
|-
| ABORTONERR or AOE || Stop the execution of the test batch on first error.
|-
| FIRSTTESTNUMBER or FTN || First test to perform. The valid test number is between 1 and 45.
|-
| LASTTESTNUMBER or LTN || Last test to perform. The valid test number is between 1 and 45.
|-
| TESTNUMBER or TN || Perform a single test. The valid test number is between 1 and 45.
|}

== ARexx Interface ==

FSTest has no ARexx interface.

= FSVPTool =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Code Generation

FSVPTool is a tool that generates C source files for a skeleton handler. It generates all the basic stub files required for filesystems to communicate with the version 53 (or newer) DOS library FileSystem Vector-Port interface.

<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: FSVPTOOL

; Template
: (none)

; Location
: SDK:C

; Example
Generate a skeleton vector-port filesystem C source files.
1.RAM Disk:> FSVPTool
Finished, vector port interface files can be found in; RAM:FSVP_Files

== ARexx Interface ==

FSVPTool has no ARexx interface.

= GCC =
[[File:LibDrawerIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Archiving <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Building <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Debugging <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Optimizing <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Testing

The '''SDK:gcc/bin''' directory contains essential tools from the '''GNU Compiler Collection''' and the '''GNU Binutils Binary Tools Collection'''. The command line tools included from the collections are:
<div style="clear: both"></div>

* '''addr2line''' – Converts addresses to filenames and line numbers.
* '''ar''' – A utility for creating and modifying archives, and extracting from archives.
* '''as''' – The GNU assembler.
* '''c++''' – The GNU C++ compiler.
* '''c++filt''' – Decodes mangled (low-level) function names into human readable form.
* '''cpp''' – The GNU C/C++ preprocessor.
* '''g++''' – The GNU C++ compiler, '''c++''' alias.
* '''gcc''' – The GNU C compiler.
* '''gccbug''' – A utility for filing a bug report.
* '''gcov''' – The GNU test coverage program.
* '''gprof''' – The GNU profiler.
* '''ld''' – The GNU linker.
* '''nm''' – Lists symbols from object files.
* '''objcopy''' – Copies and translates object files.
* '''objdump''' – Displays information about object files.
* '''ranlib''' – Generates an index to the contents of an archive and stores it in the archive.
* '''readelf''' – Displays information about any ELF format object file.
* '''size''' – Lists the section sizes of an object or archive file.
* '''strings''' – Lists printable strings from files.
* '''strip''' – Discards symbols.

The full documentation of the listed tools can be found from the [http://gcc.gnu.org/ GCC] and [https://www.gnu.org/software/binutils/ GNU] web sites.

= GDB =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Debugging

GDB is a debugging tool which purpose is to help developers to locate programming errors from their C/C++ programs. With GDB the developer can run and halt their program at will, to monitor and modify the values of the program's internal variables, and even call functions independently of the program's normal behavior.

In order to be able to debug a program, it has to contain a debugging symbol table. The symbol table maps the machine language instructions to the variables, functions, and lines appearing in the program's source code. The debugging table should be embedded in the program at compilation. For example, when using a [[SDK_Developer_Tools#GCC|GCC]] compiler, option '''-g''' generates and embeds the debug information needed.

; GDB Commands

Break and Watch
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| awatch || Set a watchpoint for an expression.
|- style="vertical-align: top;"
| break || Set breakpoint at specified line or function.
|- style="vertical-align: top;"
| catch || Set catchpoints to catch events.
|- style="vertical-align: top;"
| clear || Clear breakpoint at specified line or function.
|- style="vertical-align: top;"
| commands || Set commands to be executed when a breakpoint is hit.
|- style="vertical-align: top;"
| condition || Specify breakpoint to break only if a condition is true.
|- style="vertical-align: top;"
| delete || Delete some breakpoints or auto-display expressions.
|- style="vertical-align: top;"
| disable || Disable some breakpoints.
|- style="vertical-align: top;"
| enable || Enable some breakpoints.
|- style="vertical-align: top;"
| hbreak || Set a hardware assisted breakpoint.
|- style="vertical-align: top;"
| ignore || Set ignore-count of a breakpoint.
|- style="vertical-align: top;"
| rbreak || Set a breakpoint for all functions matching a regular expression.
|- style="vertical-align: top;"
| rwatch || Set a read watchpoint for an expression.
|- style="vertical-align: top;"
| tbreak || Set a temporary breakpoint.
|- style="vertical-align: top;"
| tcatch || Set temporary catchpoints to catch events.
|- style="vertical-align: top;"
| thbreak || Set a temporary hardware assisted breakpoint.
|- style="vertical-align: top;"
| watch || Set a watchpoint for an expression.
|}

Examine Data
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| append || Append code or data to a file.
|- style="vertical-align: top;"
| call || Call a function in the program.
|- style="vertical-align: top;"
| delete display || Cancel some expressions to be displayed when the program stops.
|- style="vertical-align: top;"
| delete mem || Delete a memory region.
|- style="vertical-align: top;"
| disable display || Disable some expressions to be displayed when the program stops.
|- style="vertical-align: top;"
| disable mem || Disable a memory region.
|- style="vertical-align: top;"
| disassemble || Disassemble a specified memory section.
|- style="vertical-align: top;"
| display || Print value of an expression each time the program stops.
|- style="vertical-align: top;"
| dump || Dump code or data to a file.
|- style="vertical-align: top;"
| enable display || Enable some expressions to be displayed when the program stops.
|- style="vertical-align: top;"
| enable mem || Enable a memory region.
|- style="vertical-align: top;"
| inspect || Alias to '''print'''.
|- style="vertical-align: top;"
| mem || Define attributes for a memory region.
|- style="vertical-align: top;"
| output || Like '''print''' but do not put value in the value history and do not print newline.
|- style="vertical-align: top;"
| print || Print expression's value.
|- style="vertical-align: top;"
| print-object || Ask an Objective-C to print itself.
|- style="vertical-align: top;"
| printf || Print a formatted string.
|- style="vertical-align: top;"
| ptype || Print definition of a type.
|- style="vertical-align: top;"
| restore || Restore the contents of a file to a memory.
|- style="vertical-align: top;"
| set || Evaluate an expression and assign the result to a variable.
|- style="vertical-align: top;"
| set variable || Evaluate an expression and assign the result to a variable.
|- style="vertical-align: top;"
| undisplay || Cancel some expressions to be displayed when program stops.
|- style="vertical-align: top;"
| whatis || Print data type of an expression.
|- style="vertical-align: top;"
| x || Examine memory.
|}

Examine Files
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| add-shared-symbol-files || Load the symbols from shared object's in the dynamic linker's link map.
|- style="vertical-align: top;"
| add-symbol-file || Add a symbol file.
|- style="vertical-align: top;"
| cd || Change the working directory.
|- style="vertical-align: top;"
| core-file || Select a core dump file for examining the memory and registers.
|- style="vertical-align: top;"
| directory || Add new directory to the beginning of the search path for source files.
|- style="vertical-align: top;"
| edit || Edit file or function.
|- style="vertical-align: top;"
| exec-file || Select program file for getting the contents of a pure memory.
|- style="vertical-align: top;"
| file || Select program file to be debugged.
|- style="vertical-align: top;"
| forward-search || Search for regular expression from the last line listed.
|- style="vertical-align: top;"
| list || List a function or a line.
|- style="vertical-align: top;"
| load || Dynamically load a file into the running program.
|- style="vertical-align: top;"
| path || Add new directory to the beginning of the search path for object files.
|- style="vertical-align: top;"
| pwd || Print the working directory.
|- style="vertical-align: top;"
| reverse-search || Search backward for regular expression from the last line listed.
|- style="vertical-align: top;"
| search || Search regular expression from the last line listed.
|- style="vertical-align: top;"
| section || Change the base address of a section of a file.
|- style="vertical-align: top;"
| set extension-language || Set mapping between file name extension and source language.
|- style="vertical-align: top;"
| set gnutarget || Set the current BFD target.
|- style="vertical-align: top;"
| show gnutarget || Show the current BFD target.
|- style="vertical-align: top;"
| symbol-file || Load a symbol table from an executable file.
|}

Maintenance
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| flushregs || Force GDB to flush its register cache (maintainer command).
|- style="vertical-align: top;"
| maintenance || Commands for use by GDB maintainers.
|- style="vertical-align: top;"
| maintenance agent || Translate an expression into remote agent bytecode.
|- style="vertical-align: top;"
| maintenance check-symtabs || Check consistency of psymtabs and symtabs.
|- style="vertical-align: top;"
| maintenance cplus || C++ maintenance commands.
|- style="vertical-align: top;"
| maintenance cplus first_component || Print the first class/namespace component of NAME.
|- style="vertical-align: top;"
| maintenance cplus namespace || Print the list of possible C++ namespaces.
|- style="vertical-align: top;"
| maintenance demangle || Demangle a C++/ObjC mangled name.
|- style="vertical-align: top;"
| maintenance deprecate || Deprecate a command.
|- style="vertical-align: top;"
| maintenance dump-me || Get fatal error; make debugger dump its core.
|- style="vertical-align: top;"
| maintenance info || Commands for showing internal info about the program being debugged.
|- style="vertical-align: top;"
| maintenance info breakpoints || Status of all breakpoints.
|- style="vertical-align: top;"
| maintenance info psymtabs || List the partial symbol tables for all object files.
|- style="vertical-align: top;"
| maintenance info sections || List the BFD sections of the exec and core files.
|- style="vertical-align: top;"
| maintenance info symtabs || List the full symbol tables for all object files.
|- style="vertical-align: top;"
| maintenance internal-error || Give GDB an internal error.
|- style="vertical-align: top;"
| maintenance internal-warning || Give GDB an internal warning.
|- style="vertical-align: top;"
| maintenance packet || Send an arbitrary packet to a remote target.
|- style="vertical-align: top;"
| maintenance print || Maintenance command for printing GDB internal state.
|- style="vertical-align: top;"
| maintenance print architecture || Print the internal architecture configuration.
|- style="vertical-align: top;"
| maintenance print cooked-registers || Print the internal register configuration including cooked values.
|- style="vertical-align: top;"
| maintenance print dummy-frames || Print the contents of the internal dummy-frame stack.
|- style="vertical-align: top;"
| maintenance print msymbols || Print dump of current minimal symbol definitions.
|- style="vertical-align: top;"
| maintenance print objfiles || Print dump of current object file definitions.
|- style="vertical-align: top;"
| maintenance print psymbols || Print dump of current partial symbol definitions.
|- style="vertical-align: top;"
| maintenance print raw-registers || Print the internal register configuration including raw values.
|- style="vertical-align: top;"
| maintenance print reggroups || Print the internal register group names.
|- style="vertical-align: top;"
| maintenance print register-groups || Print the internal register configuration including each register's group.
|- style="vertical-align: top;"
| maintenance print registers || Print the internal register configuration.
|- style="vertical-align: top;"
| maintenance print statistics || Print statistics about internal gdb state.
|- style="vertical-align: top;"
| maintenance print symbols || Print dump of current symbol definitions.
|- style="vertical-align: top;"
| maintenance print type || Print a type chain for a given symbol.
|- style="vertical-align: top;"
| maintenance set || Set GDB internal variables used by the GDB maintainer.
|- style="vertical-align: top;"
| maintenance set dwarf2 || Set DWARF 2 specific variables.
|- style="vertical-align: top;"
| maintenance set profile || Set internal profiling.
|- style="vertical-align: top;"
| maintenance show || Show GDB internal variables used by the GDB maintainer.
|- style="vertical-align: top;"
| maintenance show dwarf2 || Show DWARF 2 specific variables.
|- style="vertical-align: top;"
| maintenance show profile || Show internal profiling.
|- style="vertical-align: top;"
| maintenance space || Set the display of space usage.
|- style="vertical-align: top;"
| maintenance time || Set the display of time usage.
|- style="vertical-align: top;"
| maintenance translate-address || Translate a section name and address to a symbol.
|- style="vertical-align: top;"
| maintenance undeprecate || Undeprecate a command.
|- style="vertical-align: top;"
| set archdebug || Set architecture debugging.
|- style="vertical-align: top;"
| set backtrace || Set backtrace specific variables.
|- style="vertical-align: top;"
| set breakpoint || Breakpoint specific settings.
|- style="vertical-align: top;"
| set debug arch || Set architecture debugging.
|- style="vertical-align: top;"
| set debug event || Set event debugging.
|- style="vertical-align: top;"
| set debug expression || Set expression debugging.
|- style="vertical-align: top;"
| set debug frame || Set frame debugging.
|- style="vertical-align: top;"
| set debug observer || Set observer debugging.
|- style="vertical-align: top;"
| set debug serial || Set serial debugging.
|- style="vertical-align: top;"
| set debug target || Set target debugging.
|- style="vertical-align: top;"
| set debugvarobj || Set varobj debugging.
|- style="vertical-align: top;"
| set eventdebug || Set event debugging.
|- style="vertical-align: top;"
| set remote || Remote protocol specific variables.
|- style="vertical-align: top;"
| set serial || Set default serial/parallel port configuration.
|- style="vertical-align: top;"
| set watchdog || Set watchdog timer.
|- style="vertical-align: top;"
| show archdebug || Show architecture debugging.
|- style="vertical-align: top;"
| show backtrace || Show backtrace specific variables.
|- style="vertical-align: top;"
| show breakpoint || Breakpoint specific settings.
|- style="vertical-align: top;"
| show debug arch || Show architecture debugging.
|- style="vertical-align: top;"
| show debug event || Show event debugging.
|- style="vertical-align: top;"
| show debug expression || Show expression debugging.
|- style="vertical-align: top;"
| show debug frame || Show frame debugging.
|- style="vertical-align: top;"
| show debug observer || Show observer debugging.
|- style="vertical-align: top;"
| show debug serial || Show serial debugging.
|- style="vertical-align: top;"
| show debug target || Show target debugging.
|- style="vertical-align: top;"
| show debugvarobj || Show varobj debugging.
|- style="vertical-align: top;"
| show eventdebug || Show event debugging.
|- style="vertical-align: top;"
| show remote || Show the remote protocol specific variables.
|- style="vertical-align: top;"
| show serial || Show the default serial/parallel port configuration.
|- style="vertical-align: top;"
| show watchdog || Show a watchdog timer.
|}

Obscure Features
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| compare-sections || Compare section data on target to the exec file.
|- style="vertical-align: top;"
| complete || List the completions for the rest of the line as a command.
|- style="vertical-align: top;"
| maintenance set dwarf2 max-cache-age || Set the upper bound on the age of cached dwarf2 compilation units.
|- style="vertical-align: top;"
| maintenance show dwarf2 max-cache-age || Show the upper bound on the age of cached dwarf2 compilation units.
|- style="vertical-align: top;"
| monitor || Send a command to the remote monitor (remote targets only).
|- style="vertical-align: top;"
| remote <command> || Send a command to the remote monitor.
|- style="vertical-align: top;"
| set annotate || Set annotation_level.
|- style="vertical-align: top;"
| set backtrace limit || Set an upper bound on the number of backtrace levels.
|- style="vertical-align: top;"
| set backtrace past-main || Set whether backtraces should continue past "main".
|- style="vertical-align: top;"
| set coerce-float-to-double || Set coercion of floats to doubles when calling functions.
|- style="vertical-align: top;"
| set cp-abi || Set the ABI used for inspecting C++ objects.
|- style="vertical-align: top;"
| set download-write-size || Set the write size used when downloading a program.
|- style="vertical-align: top;"
| set remote P-packet || Set use of remote protocol '''P''' (set-register) packet.
|- style="vertical-align: top;"
| set remote X-packet || Set use of remote protocol '''X''' (binary-download) packet.
|- style="vertical-align: top;"
| set remote Z-packet || Set use of remote protocol '''Z''' packets.
|- style="vertical-align: top;"
| set remote access-watchpoint-packet || Set use of remote protocol '''Z4''' (access-watchpoint) packet.
|- style="vertical-align: top;"
| set remote binary-download-packet || Set use of remote protocol '''X''' (binary-download) packet.
|- style="vertical-align: top;"
| set remote fetch-register-packet || Set use of remote protocol '''p''' (fetch-register) packet.
|- style="vertical-align: top;"
| set remote hardware-breakpoint-packet || Set use of remote protocol '''Z1''' (hardware-breakpoint) packet.
|- style="vertical-align: top;"
| set remote p-packet || Set use of remote protocol '''p''' (fetch-register) packet.
|- style="vertical-align: top;"
| set remote read-aux-vector-packet || Set use of remote protocol '''qPart_auxv''' (read-aux-vector) packet.
|- style="vertical-align: top;"
| set remote read-watchpoint-packet || Set use of remote protocol '''Z3''' (read-watchpoint) packet.
|- style="vertical-align: top;"
| set remote set-register-packet || Set use of remote protocol '''P''' (set-register) packet.
|- style="vertical-align: top;"
| set remote software-breakpoint-packet || Set use of remote protocol '''Z0''' (software-breakpoint) packet.
|- style="vertical-align: top;"
| set remote symbol-lookup-packet || Set use of remote protocol '''qSymbol''' (symbol-lookup) packet.
|- style="vertical-align: top;"
| set remote verbose-resume-packet || Set use of remote protocol '''vCont''' (verbose-resume) packet.
|- style="vertical-align: top;"
| set remote write-watchpoint-packet || Set use of remote protocol '''Z2''' (write-watchpoint) packet.
|- style="vertical-align: top;"
| set remoteaddresssize || Set the maximum size of the address (in bits) in a memory packet.
|- style="vertical-align: top;"
| show annotate || Show annotation_level.
|- style="vertical-align: top;"
| show backtrace limit || Show the upper bound on the number of backtrace levels.
|- style="vertical-align: top;"
| show backtrace past-main || Show whether backtraces should continue past "main".
|- style="vertical-align: top;"
| show coerce-float-to-double || Show coercion of floats to doubles when calling functions.
|- style="vertical-align: top;"
| show cp-abi || Show the ABI used for inspecting C++ objects.
|- style="vertical-align: top;"
| show download-write-size || Show the write size used when downloading a program.
|- style="vertical-align: top;"
| show remote P-packet || Show current use of remote protocol '''P''' (set-register) packet.
|- style="vertical-align: top;"
| show remote X-packet || Show current use of remote protocol '''X''' (binary-download) packet.
|- style="vertical-align: top;"
| show remote Z-packet || Show use of remote protocol '''Z''' packets.
|- style="vertical-align: top;"
| show remote access-watchpoint-packet || Show current use of remote protocol '''Z4''' (access-watchpoint) packet.
|- style="vertical-align: top;"
| show remote binary-download-packet || Show current use of remote protocol '''X''' (binary-download) packet.
|- style="vertical-align: top;"
| show remote fetch-register-packet || Show current use of remote protocol '''p''' (fetch-register) packet.
|- style="vertical-align: top;"
| show remote hardware-breakpoint-packet || Show current use of remote protocol '''Z1''' (hardware-breakpoint) packet.
|- style="vertical-align: top;"
| show remote p-packet || Show current use of remote protocol `p' (fetch-register) packet.
|- style="vertical-align: top;"
| show remote read-aux-vector-packet || Show current use of remote protocol '''qPart_auxv''' (read-aux-vector) packet.
|- style="vertical-align: top;"
| show remote read-watchpoint-packet || Show current use of remote protocol '''Z3''' (read-watchpoint) packet.
|- style="vertical-align: top;"
| show remote set-register-packet || Show current use of remote protocol '''P''' (set-register) packet.
|- style="vertical-align: top;"
| show remote software-breakpoint-packet || Show current use of remote protocol '''Z0''' (software-breakpoint) packet.
|- style="vertical-align: top;"
| show remote symbol-lookup-packet || Show current use of remote protocol '''qSymbol''' (symbol-lookup) packet.
|- style="vertical-align: top;"
| show remote verbose-resume-packet || Show current use of remote protocol '''vCont''' (verbose-resume) packet.
|- style="vertical-align: top;"
| show remote write-watchpoint-packet || Show current use of remote protocol '''Z2''' (write-watchpoint) packet.
|- style="vertical-align: top;"
| show remoteaddresssize || Show the maximum size of the address (in bits) in a memory packet.
|- style="vertical-align: top;"
| stop || There is no '''stop''' command.
|}

Running the Program
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| advance || Continue the program up to the given location (same form as args for break command).
|- style="vertical-align: top;"
| attach || Attach to a process or file outside of GDB.
|- style="vertical-align: top;"
| continue || Continue program being debugged.
|- style="vertical-align: top;"
| detach || Detach a process or file previously attached.
|- style="vertical-align: top;"
| disconnect || Disconnect from a target.
|- style="vertical-align: top;"
| finish || Execute until selected stack frame returns.
|- style="vertical-align: top;"
| handle || Specify how to handle a signal.
|- style="vertical-align: top;"
| info handle || What debugger does when program gets various signals.
|- style="vertical-align: top;"
| interrupt || Interrupt the execution of the debugged program.
|- style="vertical-align: top;"
| jump || Continue program being debugged at specified line or address.
|- style="vertical-align: top;"
| kill || Kill execution of program being debugged.
|- style="vertical-align: top;"
| next || Step program.
|- style="vertical-align: top;"
| nexti || Step one instruction.
|- style="vertical-align: top;"
| run || Start debugged program.
|- style="vertical-align: top;"
| set args || Set argument list to give program being debugged when it is started.
|- style="vertical-align: top;"
| set environment || Set environment variable value to give the program.
|- style="vertical-align: top;"
| set follow-fork-mode || Set debugger response to a program call of fork or vfork.
|- style="vertical-align: top;"
| set scheduler-locking || Set mode for locking scheduler during execution.
|- style="vertical-align: top;"
| set step-mode || Set mode of the step operation.
|- style="vertical-align: top;"
| show args || Show argument list to give program being debugged when it is started.
|- style="vertical-align: top;"
| show follow-fork-mode || Show debugger response to a program call of fork or vfork.
|- style="vertical-align: top;"
| show scheduler-locking || Show mode for locking scheduler during execution.
|- style="vertical-align: top;"
| show step-mode || Show mode of the step operation.
|- style="vertical-align: top;"
| signal || Continue program giving it signal specified by the argument.
|- style="vertical-align: top;"
| start || Run the debugged program until the beginning of the main procedure.
|- style="vertical-align: top;"
| step || Step program until it reaches a different source line.
|- style="vertical-align: top;"
| stepi || Step one instruction exactly.
|- style="vertical-align: top;"
| target || Connect to a target machine or process.
|- style="vertical-align: top;"
| thread || Use this command to switch between threads.
|- style="vertical-align: top;"
| thread apply || Apply a command to a list of threads.
|- style="vertical-align: top;"
| apply all || Apply a command to all threads.
|- style="vertical-align: top;"
| tty || Set terminal for future runs of program being debugged.
|- style="vertical-align: top;"
| unset environment || Cancel environment variable VAR for the program.
|- style="vertical-align: top;"
| until || Execute until the program reaches a source line greater than the current.
|}

Examine Stack
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| backtrace || Print backtrace of all stack frames.
|- style="vertical-align: top;"
| bt || Alias to '''backtrace'''.
|- style="vertical-align: top;"
| down || Select and print stack frame called by this one.
|- style="vertical-align: top;"
| frame || Select and print a stack frame.
|- style="vertical-align: top;"
| return || Make selected stack frame return to its caller.
|- style="vertical-align: top;"
| select-frame || Slect a stack frame without printing anything.
|- style="vertical-align: top;"
| up || Select and print a stack frame that called this one.
|}

Status Inquiries
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| info || Generic command for showing things about the program being debugged.
|- style="vertical-align: top;"
| info powerpc || Verious PowerPC info specific commands.
|- style="vertical-align: top;"
| macro || Prefix for commands dealing with C preprocessor macros.
|- style="vertical-align: top;"
| show || Generic command for showing things about the debugger.
|}

Support Facilities
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| apropos || Search for commands matching a REGEXP.
|- style="vertical-align: top;"
| define || Define a new command name.
|- style="vertical-align: top;"
| document || Document a user-defined command.
|- style="vertical-align: top;"
| dont-repeat || Don't repeat this command.
|- style="vertical-align: top;"
| down-silently || Same as the '''down''' command.
|- style="vertical-align: top;"
| echo || Print a constant string.
|- style="vertical-align: top;"
| help || Print list of commands.
|- style="vertical-align: top;"
| if || Execute nested commands once IF the conditional expression is non zero.
|- style="vertical-align: top;"
| interpreter-exec || Execute a command in an interpreter.
|- style="vertical-align: top;"
| make || Run the '''Make''' program using the rest of the line as arguments
|- style="vertical-align: top;"
| overlay || Commands for debugging overlays.
|- style="vertical-align: top;"
| overlay auto || Enable automatic overlay debugging.
|- style="vertical-align: top;"
| overlay list-overlays || List mappings of overlay sections.
|- style="vertical-align: top;"
| overlay load-target || Read the overlay mapping state from the target.
|- style="vertical-align: top;"
| overlay manual || Enable overlay debugging.
|- style="vertical-align: top;"
| overlay map-overlay || Assert that an overlay section is mapped.
|- style="vertical-align: top;"
| overlay off || Disable overlay debugging.
|- style="vertical-align: top;"
| overlay unmap-overlay || Assert that an overlay section is unmapped.
|- style="vertical-align: top;"
| quit || Exit GDB.
|- style="vertical-align: top;"
| set architecture || Set architecture of target.
|- style="vertical-align: top;"
| set can-use-hw-watchpoints || Set debugger's willingness to use watchpoint hardware.
|- style="vertical-align: top;"
| set case-sensitive || Set case sensitivity in name search.
|- style="vertical-align: top;"
| set charset || Set the host and target character sets.
|- style="vertical-align: top;"
| set check range || Set range checking.
|- style="vertical-align: top;"
| set check type || Set type checking.
|- style="vertical-align: top;"
| set complaints || Set max number of complaints about incorrect symbols.
|- style="vertical-align: top;"
| set confirm || Set whether to confirm potentially dangerous operations.
|- style="vertical-align: top;"
| set debug-file-directory || Set the directory where separate debug symbols are searched for.
|- style="vertical-align: top;"
| set demangle-style || Set the current C++ demangling style.
|- style="vertical-align: top;"
| set editing || Set editing of command lines as they are typed.
|- style="vertical-align: top;"
| set endian || Set endianness of target.
|- style="vertical-align: top;"
| set exec-done-display || Set notification of completion for asynchronous execution commands.
|- style="vertical-align: top;"
| set height || Set number of lines gdb thinks are in a page.
|- style="vertical-align: top;"
| set history || Generic command for setting command history parameters.
|- style="vertical-align: top;"
| set host-charset || Set the host character set.
|- style="vertical-align: top;"
| set input-radix || Set default input radix for entering numbers.
|- style="vertical-align: top;"
| set language || Set the current source language.
|- style="vertical-align: top;"
| set listsize || Set number of source lines gdb will list by default.
|- style="vertical-align: top;"
| set logging || Set logging options.
|- style="vertical-align: top;"
| set logging file || Set the current logfile.
|- style="vertical-align: top;"
| set logging off || Disable logging.
|- style="vertical-align: top;"
| set logging on || Enable logging.
|- style="vertical-align: top;"
| set logging overwrite || Set whether logging overwrites or appends to the log file.
|- style="vertical-align: top;"
| set logging redirect || Set the logging output mode.
|- style="vertical-align: top;"
| set opaque-type-resolution || Set resolution of opaque struct/class/union types (if set before loading symbols).
|- style="vertical-align: top;"
| set osabi || Set OS ABI of target.
|- style="vertical-align: top;"
| set output-radix || Set default output radix for printing of values.
|- style="vertical-align: top;"
| set overload-resolution || Set overload resolution in evaluating C++ functions.
|- style="vertical-align: top;"
| set pagination || Set state of pagination.
|- style="vertical-align: top;"
| set print address || Set printing of addresses.
|- style="vertical-align: top;"
| set print array || Set prettyprinting of arrays.
|- style="vertical-align: top;"
| set print asm-demangle || Set demangling of C++/ObjC names in disassembly listings.
|- style="vertical-align: top;"
| set print demangle || Set demangling of encoded C++/ObjC names when displaying symbols.
|- style="vertical-align: top;"
| set print object || Set printing of object's derived type based on vtable info.
|- style="vertical-align: top;"
| set print pascal_static-members || Set printing of pascal static members.
|- style="vertical-align: top;"
| set print pretty || Set prettyprinting of structures.
|- style="vertical-align: top;"
| set print sevenbit-strings || Set printing of 8-bit characters in strings as \nnn.
|- style="vertical-align: top;"
| set print static-members || Set printing of C++ static members.
|- style="vertical-align: top;"
| set print union || Set printing of unions interior to structures.
|- style="vertical-align: top;"
| set print vtbl || Set printing of C++ virtual function tables.
|- style="vertical-align: top;"
| set prompt || Set GDB's prompt.
|- style="vertical-align: top;"
| set radix || Set default input and output number radices.
|- style="vertical-align: top;"
| set remotecache || Set cache use for remote targets.
|- style="vertical-align: top;"
| set stop-on-solib-events || Set stopping for shared library events.
|- style="vertical-align: top;"
| set symbol-reloading || Set dynamic symbol table reloading multiple times in one run.
|- style="vertical-align: top;"
| set target-charset || Set the target character set.
|- style="vertical-align: top;"
| set trust-readonly-sections || Set mode for reading from readonly sections.
|- style="vertical-align: top;"
| set verbose || Set verbosity.
|- style="vertical-align: top;"
| set width || Set number of characters gdb thinks are in a line.
|- style="vertical-align: top;"
| set write || Set writing into executable and core files.
|- style="vertical-align: top;"
| shell || Execute the rest of the line as a shell command.
|- style="vertical-align: top;"
| show architecture || Show the current target architecture.
|- style="vertical-align: top;"
| show can-use-hw-watchpoints || Show debugger's willingness to use watchpoint hardware.
|- style="vertical-align: top;"
| show case-sensitive || Show case sensitivity in name search.
|- style="vertical-align: top;"
| show charset || Show the host and target character sets.
|- style="vertical-align: top;"
| show check range || Show range checking.
|- style="vertical-align: top;"
| show check type || Show type checking.
|- style="vertical-align: top;"
| show complaints || Show max number of complaints about incorrect symbols.
|- style="vertical-align: top;"
| show confirm || Show whether to confirm potentially dangerous operations.
|- style="vertical-align: top;"
| show debug-file-directory || Show the directory where separate debug symbols are searched for.
|- style="vertical-align: top;"
| show demangle-style || Show the current C++ demangling style.
|- style="vertical-align: top;"
| show editing || Show editing of command lines as they are typed.
|- style="vertical-align: top;"
| show endian || Show the current byte-order.
|- style="vertical-align: top;"
| show exec-done-display || Show notification of completion for asynchronous execution commands.
|- style="vertical-align: top;"
| show height || Show number of lines gdb thinks are in a page.
|- style="vertical-align: top;"
| show history || Generic command for showing command history parameters.
|- style="vertical-align: top;"
| show host-charset || Show the host character set.
|- style="vertical-align: top;"
| show input-radix || Show default input radix for entering numbers.
|- style="vertical-align: top;"
| show language || Show the current source language.
|- style="vertical-align: top;"
| show listsize || Show number of source lines gdb will list by default.
|- style="vertical-align: top;"
| show logging || Show logging options.
|- style="vertical-align: top;"
| show logging file || Show the current logfile.
|- style="vertical-align: top;"
| show logging overwrite || Show whether logging overwrites or appends to the log file.
|- style="vertical-align: top;"
| show logging redirect || Show the logging output mode.
|- style="vertical-align: top;"
| show opaque-type-resolution || Show resolution of opaque struct/class/union types (if set before loading symbols).
|- style="vertical-align: top;"
| show osabi || Show OS/ABI of target.
|- style="vertical-align: top;"
| show output-radix || Show default output radix for printing of values.
|- style="vertical-align: top;"
| show overload-resolution || Show overload resolution in evaluating C++ functions.
|- style="vertical-align: top;"
| show pagination || Show state of pagination.
|- style="vertical-align: top;"
| show print address || Show printing of addresses.
|- style="vertical-align: top;"
| show print array || Show prettyprinting of arrays.
|- style="vertical-align: top;"
| show print asm-demangle || Show demangling of C++/ObjC names in disassembly listings.
|- style="vertical-align: top;"
| show print demangle || Show demangling of encoded C++/ObjC names when displaying symbols.
|- style="vertical-align: top;"
| show print object || Show printing of object's derived type based on vtable info.
|- style="vertical-align: top;"
| show print pascal_static-members || Show printing of pascal static members.
|- style="vertical-align: top;"
| show print pretty || Show prettyprinting of structures.
|- style="vertical-align: top;"
| show print sevenbit-strings || Show printing of 8-bit characters in strings as \nnn.
|- style="vertical-align: top;"
| show print static-members || Show printing of C++ static members.
|- style="vertical-align: top;"
| show print union || Show printing of unions interior to structures.
|- style="vertical-align: top;"
| show print vtbl || Show printing of C++ virtual function tables.
|- style="vertical-align: top;"
| show prompt || Show gdb's prompt.
|- style="vertical-align: top;"
| show radix || Show the default input and output number radices.
|- style="vertical-align: top;"
| show remotecache || Show cache use for remote targets.
|- style="vertical-align: top;"
| show stop-on-solib-events || Show stopping for shared library events.
|- style="vertical-align: top;"
| show symbol-reloading || Show dynamic symbol table reloading multiple times in one run.
|- style="vertical-align: top;"
| show target-charset || Show the target character set.
|- style="vertical-align: top;"
| show trust-readonly-sections || Show mode for reading from readonly sections.
|- style="vertical-align: top;"
| show verbose || Show verbosity.
|- style="vertical-align: top;"
| show width || Show number of characters gdb thinks are in a line.
|- style="vertical-align: top;"
| show write || Show writing into executable and core files.
|- style="vertical-align: top;"
| source || Read commands from a file named FILE.
|- style="vertical-align: top;"
| up-silently || Same as the '''up''' command.
|- style="vertical-align: top;"
| while || Execute nested commands WHILE the conditional expression is non zero.
|}

Tracing
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| actions || Specify the actions to be taken at a tracepoint.
|- style="vertical-align: top;"
| collect || Specify one or more data items to be collected at a tracepoint.
|- style="vertical-align: top;"
| delete tracepoints || Delete specified tracepoints.
|- style="vertical-align: top;"
| disable tracepoints || Disable specified tracepoints.
|- style="vertical-align: top;"
| enable tracepoints || Enable specified tracepoints.
|- style="vertical-align: top;"
| end || Ends a list of commands or actions.
|- style="vertical-align: top;"
| passcount || Set the passcount for a tracepoint.
|- style="vertical-align: top;"
| save-tracepoints || Save current tracepoint definitions as a script.
|- style="vertical-align: top;"
| tdump || Print everything collected at the current tracepoint.
|- style="vertical-align: top;"
| tfind || Select a trace frame.
|- style="vertical-align: top;"
| tfind end || Synonym for '''none'''.
|- style="vertical-align: top;"
| tfind line || Select a trace frame by source line.
|- style="vertical-align: top;"
| tfind none || De-select any trace frame and resume 'live' debugging.
|- style="vertical-align: top;"
| tfind outside || Select a trace frame whose PC is outside the given range.
|- style="vertical-align: top;"
| tfind pc || Select a trace frame by PC.
|- style="vertical-align: top;"
| tfind range || Select a trace frame whose PC is in the given range.
|- style="vertical-align: top;"
| tfind start || Select the first trace frame in the trace buffer.
|- style="vertical-align: top;"
| tfind tracepoint || Select a trace frame by tracepoint number.
|- style="vertical-align: top;"
| trace || Set a tracepoint at a specified line or function or address.
|- style="vertical-align: top;"
| tstart || Start trace data collection.
|- style="vertical-align: top;"
| tstatus || Display the status of the current trace data collection.
|- style="vertical-align: top;"
| tstop || Stop trace data collection.
|- style="vertical-align: top;"
| while-stepping || Specify single-stepping behavior at a tracepoint.
|}

<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: Missing description.

; Template
: Missing description.

; Location
: SDK:C

; Tutorials
* [[GDB_for_Beginners|GDB for Beginners]]

The options are:

{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| --args || .
|- style="vertical-align: top;"
| --async || .
|- style="vertical-align: top;"
| --noasync || .
|- style="vertical-align: top;"
| -b <baudrate> || Set serial port baud rate for remote debugging.
|- style="vertical-align: top;"
| --batch || .
|- style="vertical-align: top;"
| --cd <directory> || Change current directory to <directory>.
|- style="vertical-align: top;"
| --command <file> || Execute GDB commands from file <file>.
|- style="vertical-align: top;"
| --core <corefile> || .
|- style="vertical-align: top;"
| --pid <pid> || .
|- style="vertical-align: top;"
| --dbx || DBX compatibility mode.
|- style="vertical-align: top;"
| --directory <directory> || Add directory <directory> to the path to search for source files.
|- style="vertical-align: top;"
| --epoch || Output information for epoch emacs-GDB interface.
|- style="vertical-align: top;"
| --exec <exefile> || Debug file <exefile>.
|- style="vertical-align: top;"
| --fullname || Output information for emacs-GDB interface.
|- style="vertical-align: top;"
| --help || Display this message and exit.
|- style="vertical-align: top;"
| --interpreter <interpreter> || Use the specified interpreter/user interface.
|- style="vertical-align: top;"
| --mapped || Use mapped symbol files.
|- style="vertical-align: top;"
| --nw || Do not use a window interface. See option '''-w'''.
|- style="vertical-align: top;"
| --nx || Do not read ".gdbinit" file.
|- style="vertical-align: top;"
| --quiet || Do not print version number on startup.
|- style="vertical-align: top;"
| --readnow || Read the whole symbol table file on first access.
|- style="vertical-align: top;"
| --se <file> || Use file <file> as a symbol table file and as an executable file.
|- style="vertical-align: top;"
| --symbols <symfile> || Read a symbol table from file <symfile>.
|- style="vertical-align: top;"
| --tty <tty> || .
|- style="vertical-align: top;"
| --version || Print GDB version and exit.
|- style="vertical-align: top;"
| -w || Use a window interface. See option '''--nw'''.
|- style="vertical-align: top;"
| --write || .
|- style="vertical-align: top;"
| --xdb || .
|}

== ARexx Interface ==

GDB has no ARexx interface.

= GUnZip =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Archiving

GUnZip decompresses files created by gzip, zip, compress, compress -H or pack. The detection of the input format is automatic.

<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: GUNZIP [-c=--stdout] [-d=--decompress] [-f=--force] [-h=--help] [-l=--list]
: [-L=--license] [-n=--no-name] [-N=--name] [-r=--recursive] [-S=--suffix <suffix>]
: [-t=--test] [-v=--verbose] [-V=--version] [-1=--fast] [-9=--best] {<file>}

; Template
: -c=--stdout -d=--decompress -f=--force -h=--help -l=--list -L=--license
: -n=--no-name -N=--name -r=--recursive -S=--suffix <suffix> -t=--test
: -v=--verbose -V=--version -1=--fast -9=--best <file>

; Location
: SDK:C

The options are:

{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| -c or --stdout || Write output on standard output; keep original files unchanged. If there are several input files, the output consists of a sequence of independently compressed members. To obtain better compression, concatenate all input files before compressing them.
|- style="vertical-align: top;"
| -d or --decompress || Decompress
|- style="vertical-align: top;"
| -f or --force || Force overwrite of output file and compress links.
|- style="vertical-align: top;"
| -h or --help || Display a help screen and quit.
|- style="vertical-align: top;"
| -l or --list || List compressed file contents.
|- style="vertical-align: top;"
| -L or --license || Display the gzip license and exit.
|- style="vertical-align: top;"
| -n or --no-name || When compressing, do not save the original file name and timestamp by default.
|- style="vertical-align: top;"
| -N or --name || When compressing, always save the original file name and time stamp; this is the default.
|- style="vertical-align: top;"
| -r or --recursive || Travel the directory structure recursively.
|- style="vertical-align: top;"
| -S or --suffix || When compressing, use the given suffix instead of .gz. Any non-empty suffix can be given, but suffixes other than .z and .gz should be avoided to avoid confusion when files are transferred to other systems.
|- style="vertical-align: top;"
| -t or --test || Check the compressed file integrity.
|- style="vertical-align: top;"
| -v or --verbose || Display the name and percentage reduction for each file compressed or decompressed.
|- style="vertical-align: top;"
| -V or --version || Display the version number.
|- style="vertical-align: top;"
| -1 or --fast || Compress faster.
|- style="vertical-align: top;"
| -9=--best || Compress better.
|}

; See also
* [[SDK_Developer_Tools#GZip|GZip]]

; Example 1
Decompress file myfile.gz to the current directory:
1> gunzip myfile.gz

; Example 2
Decompress files myfile.gz, yourfile.gz, and theirfile.gz to the current directory:
1> gunzip myfile.gz yourfile.gz theirfile.gz

; Example 3
List the contents of a myfile.gz archive:
1> gunzip -l myfile.gz

== ARexx Interface ==

GUnZip has no ARexx interface.

= GZip =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Archiving

Compress or decompress files.

GZIP reduces the size of the named files using Lempel-Ziv coding (LZ77). Whenever possible, each file is replaced by one with the extension .gz, while keeping the same file flags and modification times. If no files are specified, the standard input is compressed to the standard output.

Compressed files can be restored to their original form using GZIP's option -d.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: GZIP [-c=--stdout] [-d=--decompress] [-f=--force] [-h=--help] [-l=--list]
: [-L=--license] [-n=--no-name] [-N=--name] [-q=--quiet] [-r=--recursive]
: [-S <suffix>=--suffix <suffix>] [-t=--test] [-v=--verbose] [-V=--version]
: [-1=--fast] [-9=--best] [<file>]

; Template
: -c=--stdout -d=--decompress -f=--force -h=--help -l=--list
: -L=--license -n=--no-name -N=--name -q=--quiet -r=--recursive
: -S <suffix>=--suffix <suffix> -t=--test -v=--verbose -V=--version
: -1=--fast -9=--best {<file>}

; Location
: SDK:C

The options are:
{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| -c or --stdout || Write output on standard output; keep original files unchanged. If there are several input files, the output consists of a sequence of independently compressed members.
|- style="vertical-align: top;"
| -d or --decompress || Decompress
|- style="vertical-align: top;"
| -f or --force || Force compression or decompression.
|- style="vertical-align: top;"
| -h or --help || Display a help and quit.
|- style="vertical-align: top;"
| -l or --list || For each compressed file, list the following fields:
'''Compressed size:''' size of the compressed file 
'''Uncompressed size:''' size of the uncompressed file 
'''Ratio:''' compression ratio (0.0% if unknown) 
'''Uncompressed_name:''' name of the uncompressed file 
|- style="vertical-align: top;"
| -L or --license || Display the GZIP license and quit..
|- style="vertical-align: top;"
| -n or --no-name || When compressing, do not save the original file name and timestamp by default. (The original name is always saved if the name had to be truncated.) When decompressing, do not restore the original file name if present (remove only the GZIP suffix from the compressed file name) and do not restore the original timestamp if present (copy it from the compressed file). This option is the default when decompressing.
|- style="vertical-align: top;"
| -N or --name || When compressing, always save the original file name and timestamp; this is the default. When decompressing, restore the original file name and timestamp if present.
|- style="vertical-align: top;"
| -q or --quiet || Suppress all warnings.
|- style="vertical-align: top;"
| -r or --recursive || Travel the directory structure recursively. If any of the file names specified on the command line are directories, GZIP will descend into the directory and compress or decompress (option -d) all the files it finds there.
|- style="vertical-align: top;"
| -S <suffix> or --suffix <suffix> || When compressing, use suffix <suffix> instead of .gz.
|- style="vertical-align: top;"
| -t or --test || Test. Check the compressed file integrity.
|- style="vertical-align: top;"
| -v or --verbose || Verbose. Display the name and percentage reduction for each file compressed or decompressed.
|- style="vertical-align: top;"
| -V or --version || Version. Display the version number and compilation options then quit.
|- style="vertical-align: top;"
| -1 or --fast || Compress faster.
|- style="vertical-align: top;"
| -9 or --best || Compress better.
|- style="vertical-align: top;"
| {<file>} || List of files to be processed. If not given, use standard input.
|}

; See also
* [[SDK_Developer_Tools#GUnZip|GUnZip]]

; Example 1
Compress file ''myfile'' and create file ''myfile.gz''. The original file ''myfile'' will be deleted.
1> gzip myfile

; Example 2
Compress file ''myfile'' to file ''myfile.gz'' and keep the original file ''myfile'':
1> gzip >myfile.gz -c myfile

; Example 3
List compressed file ''myfile.gz'' contents:
1> gzip -l myfile.gz
compressed uncompr. ratio uncompressed_name
40 13 -15.3% myfile

; Example 4
Decompress compressed file ''myfile.gz''. The original file ''myfile'' will be restored and the compressed file ''myfile.gz'' will be deleted.
1> gzip -d myfile.gz

; Example 5
Decompress file ''myfile.gz'' to file ''myfile'' and keep the ''myfile.gz'' file:
1> gzip >myfile -c myfile.gz

== ARexx Interface ==

GZIP has no ARexx interface.

= IDLTool =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Code Generation <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Conversion

IDLTool is a tool that generates a C source code for a bare-bones skeleton library. It reads an XML file, that contains a library description, and outputs the source code files. It can also convert an XML library description file to SFD files.

Incomplete description.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: Missing description.

; Template
: Missing description.

; Location
: SDK:C

; See Also
* [[SDK_Developer_Tools#FDTrans|FDTrans]]

; Tutorials
* [[How_to_create_an_AmigaOS_4_library|How to create an AmigaOS 4 library]]

== ARexx Interface ==

= ListDynDep =
[[File:LibToolIcon.png|left|80px|top]]

List shared object dependencies.

Incomplete description.
<div style="clear: both"></div>

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

; Location
: SDK:C

== ARexx Interface ==

= Localize =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Localization

Localize is a tool for localizing an application.

Incomplete description.
<div style="clear: both"></div>

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

; Location
: SDK:C

== ARexx Interface ==

= Make and GMake =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Building

Make is a tool that controls the generation of executables and other non source files of a program from the program's source files.

Make uses a file called makefile for instructions on how to build your program. Makefile lists each of the non source files and how to compute them from the project's source files, i.e. which shell commands to call. When you write a program, you should write a makefile for it, so that it is possible to use Make to build and install the program.

Make uses [[AmigaOS_Manual:_AmigaDOS|Amiga Shell]] to execute the shell commands. If you are working on cross-platform projects or porting applications from other platforms, that can be a problem because of the different shell command set and different file path format. For better compatibility, AmigaOS SDK contains a POSIX compliance Make: GMake. GMake is essentially the same tool as Make, except that GMake uses a [https://www.gnu.org/software/bash/ GNU Bash] compatible [[SDK_Developer_Tools#SH|ABC Shell]] to execute commands whereas Make uses Amiga Shell. GMake is ideal for cross-platform projects and porting applications from other platforms since it is Linux/Unix compatible. If you have an Amiga-specific project, use Make instead.

For a complete Make manual, visit the [https://www.gnu.org/software/make/manual/ GNU website].

<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: MAKE [-b=-m] [-B=--always-make] [-C=--directory <directory>] [-d] [--debug <flags>]
:: [-e=--environment-overrides] [-f=--file=--makefile <file>]
:: [-h=--help] [-i=--ignore-errors] [-I=--include-dir <directory>]
:: [-j=--jobs <jobs>] [-k=--keep-going] [-l=--load-average=--max-load <load>]
:: [-L=--check-symlink-times] [-n=--just-print=--dry-run=--recon]
:: [-o=--old-file=--assume-old <file>] [-p=--print-data-base] [-q=--question]
:: [-r=--no-builtin-rules] [-R=--no-builtin-variables] [-s=--silent=--quiet]
:: [-S=--no-keep-going=--stop] [-t=--touch] [-v=--version] [-w=--print-directory]
:: [--no-print-directory] [-W=--what-if=--new-file=--assume-new <file>]
:: [--warn-undefined-variables]

: GMAKE [-b=-m] [-B=--always-make] [-C=--directory <directory>] [-d] [--debug <flags>]
:: [-e=--environment-overrides] [-f=--file=--makefile <file>]
:: [-h=--help] [-i=--ignore-errors] [-I=--include-dir <directory>]
:: [-j=--jobs [<jobs>]] [-k=--keep-going] [-l=--load-average=--max-load <load>]
:: [-L=--check-symlink-times] [-n=--just-print=--dry-run=--recon]
:: [-o=--old-file=--assume-old <file>] [-p=--print-data-base] [-q=--question]
:: [-r=--no-builtin-rules] [-R=--no-builtin-variables] [-s=--silent=--quiet]
:: [-S=--no-keep-going=--stop] [-t=--touch] [-v=--version] [-w=--print-directory]
:: [--no-print-directory] [-W=--what-if=--new-file=--assume-new <file>]
:: [--warn-undefined-variables]

; Template
: -b=-m -B=--always-make -C=--directory <directory> -d --debug <flags>
: -e=--environment-overrides -f=--file=--makefile <file>
: -h=--help -i=--ignore-errors -I=--include-dir <directory>
: -j=--jobs [<jobs>] -k=--keep-going -l=--load-average=--max-load <load>
: -L=--check-symlink-times -n=--just-print=--dry-run=--recon
: -o=--old-file=--assume-old <file> -p=--print-data-base -q=--question
: -r=--no-builtin-rules -R=--no-builtin-variables -s=--silent=--quiet
: -S=--no-keep-going=--stop -t=--touch -v=--version -w=--print-directory
: --no-print-directory -W=--what-if=--new-file=--assume-new <file>
: --warn-undefined-variables

; Location
: SDK:C

; See Also
* [[SDK_Developer_Tools#DistCC|DistCC]]
* [[SDK_Developer_Tools#SH|ABC Shell]]

The options are:
{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| -b or -m || Not used.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -B or --always-make || Consider all targets out-of-date.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -C <directory> or --directory <directory> || Change current working directory to <directory> before reading the makefiles.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -d || Print debugging information in addition to normal processing. The debugging information says which files are being considered for remaking, which file-times are being compared and with what results, which files actually need to be remade, which implicit rules are considered and which are applied—everything interesting about how Make decides what to do. The '''-d''' option is equivalent to '''--debug=a''' (see below).
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| --debug <flags> || Print debugging information in addition to normal processing. Various levels and types of output can be chosen. With no arguments, print the “basic” level of debugging. Possible arguments are below; only the first character is considered, and values must be comma- or space-separated.

{| class="wikitable"
! style="text-align:left;"| Option
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| a (all) || All types of debugging output are enabled. This is equivalent to using '''-d'''.
|- style="vertical-align: top;"
| b (basic) || Basic debugging prints each target that was found to be out-of-date, and whether the build was successful or not.
|- style="vertical-align: top;"
| v (verbose) || A level above '''basic'''; includes messages about which makefiles were parsed, prerequisites that did not need to be rebuilt, etc. This option also enables '''basic''' messages.
|- style="vertical-align: top;"
| i (implicit) || Prints messages describing the implicit rule searches for each target. This option also enables '''basic''' messages.
|- style="vertical-align: top;"
| j (jobs) || Prints messages giving details on the invocation of specific sub-commands.
|- style="vertical-align: top;"
| m (makefile) || By default, the above messages are not enabled while trying to remake the makefiles. This option enables messages while rebuilding makefiles, too. Note that the '''all''' option does enable this option. This option also enables '''basic''' messages.
|- style="vertical-align: top;"
| n (none) || Disable all debugging currently enabled. If additional debugging flags are encountered after this they will still take effect.
|}

|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -e or --environment-overrides || Give variables taken from the environment precedence over variables from makefiles.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -f <file> or --file <file> or --makefile <file> || Read file <file> as a makefile.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -h or --help || Print this message and exit.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -i or --ignore-errors || Ignore command errors.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -I <directory> or --include-dir <directory> || Search directory <directory> for included makefiles.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -j [<jobs>] or --jobs [<jobs>] || Specifies the number of jobs to run simultaneously. With no argument, make runs as many recipes simultaneously as possible.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -k or --keep-going || Continue as much as possible after an error.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -l [<load>] or --load-average [<load>] or --max-load <load> || Do not start multiple jobs unless load is below <load>. With no argument, removes a previous load limit.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -L or --check-symlink-times || This option causes Make to consider the timestamps on any symbolic links in addition to the timestamp on the file referenced by those links. When this option is provided, the most recent timestamp among the file and the symbolic links is taken as the modification time for this target file.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -n or --just-print or --dry-run or --recon || Do not actually run any commands - just print them.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -o <file> or --old-file <file> or --assume-old <file> || Consider file <file> to be very old and do not remake it.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -p or --print-data-base || Print Make's internal database.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -q or --question || "Question mode". Do not run any jobs, or print anything; just return an exit status that is zero if the specified targets are already up to date, one if any remaking is required, or two if an error is encountered.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -r or --no-builtin-rules || Disable the built-in implicit rules.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -R or --no-builtin-variables || Disable the built-in variable settings.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -s or --silent or --quiet || Silent operation.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -S or --no-keep-going or --stop || Cancel the effect of the '''-k''' option.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -t or --touch || Touch files (mark them up to date without really changing them) instead of running their recipes.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -v or --version || Print Make's version number end exit.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -w or --print-directory || Print a message containing the working directory both before and after executing the makefile.
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| --no-print-directory || Do not print current directory, even it was enabled (option '''-w''').
|- style="vertical-align: top; white-space: nowrap;" | style="vertical-align: top;"
| -W <file> or --what-if <file> or --new-file <file> or --assume-new <file> || Pretend that the target file <file> has just been modified.
|- style="vertical-align: top; white-space: nowrap;"
| --warn-undefined-variables || Issue a warning message whenever Make sees a reference to an undefined variable.
|}

== ARexx Interface ==

Make has no ARexx interface.

= MakeAudioMode =
[[File:LibToolIcon.png|left|80px|top]]

MakeAudioMode creates audio mode files for AHI.

Incomplete description.
<div style="clear: both"></div>

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

; Location
: SDK:C

== ARexx Interface ==

= ModList =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Debugging

ModList lists the currently installed resident modules.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: MODLIST [SORT] [DEV]

; Template
: SORT/S,DEV/S

; Location
: SDK:C

The options are:

{| class="wikitable"
| SORT || List modules sorted alphabetically by their IDs.
|- style="vertical-align: top; white-space: nowrap;"
| DEV || List modules in the following order:
# RTF_SINGLETASK modules
# RTF_COLDSTART modules
# RTF_AFTERDOS modules
# The rest of the modules
|}

ModList displays the following information on each module:
* Priority
* Memory location
* Version
* ID
* ROM residency
* Module type
* Nativity
* Initialization

== ARexx Interface ==

ModList has no ARexx interface.

= SH =
[[File:LibToolIcon.png|left|80px|top]]

Amiga Bourne Compatible Shell (ABC Shell).
<div style="clear: both"></div>

; Built-in Commands

{| class="wikitable"
! Command !! Description
|- style="vertical-align: top; white-space: nowrap;"
| . (dot) || Reads a specified file and then executes the commands.
|- style="vertical-align: top; white-space: nowrap;"
| : (colon) || Expands only arguments.
|- style="vertical-align: top; white-space: nowrap;"
| break || Exits from the enclosing for, while, until, or select loop, if one exists.
|- style="vertical-align: top; white-space: nowrap;"
| builtin || Run a shell builtin, passing it '''args''', and return its exit status.
|- style="vertical-align: top; white-space: nowrap;"
| continue || Resumes the next iteration of the enclosing for, while, until, or select loop.
|- style="vertical-align: top; white-space: nowrap;"
| eval || Reads the arguments as input to the shell and executes the resulting command or commands.
|- style="vertical-align: top; white-space: nowrap;"
| exec || Executes the command specified by the '''Argument''' parameter, instead of this shell, without creating a new process.
|- style="vertical-align: top; white-space: nowrap;"
| exit || Exits the shell whose exit status is specified by the '''n''' parameter.
|- style="vertical-align: top; white-space: nowrap;"
| return || Causes a shell to return to the invoking script.
|- style="vertical-align: top; white-space: nowrap;"
| set || Unless options or arguments are specified, writes the names and values of all shell variables in the collation sequence of the current locale.
|- style="vertical-align: top; white-space: nowrap;"
| shift || Renames positional parameters.
|- style="vertical-align: top; white-space: nowrap;"
| times || Prints the accumulated user and system times for both the shell and the processes run from the shell.
|- style="vertical-align: top; white-space: nowrap;"
| trap || Runs a specified command when the shell receives a specified signal or signals.
|- style="vertical-align: top; white-space: nowrap;"
| wait ||
|- style="vertical-align: top; white-space: nowrap;"
| read || Reads a line from the standard input and parses it.
|- style="vertical-align: top; white-space: nowrap;"
| test || Evaluate a conditional expression '''expr''' and return a status of 0 (true) or 1 (false).
|- style="vertical-align: top; white-space: nowrap;"
| umask || Set the shell process’s file creation mask to '''mode'''.
|- style="vertical-align: top; white-space: nowrap;"
| unset || Unsets the values and attributes of the specified parameters.
|}

Incomplete description.
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
:

; Template
:

; Location
: SDK:C

== ARexx Interface ==

SH has no ARexx interface.

= TAR =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Archiving

TAR saves many files together into a single tape or disk archive, and can restore individual files from the archive.

Incomplete description.
<div style="clear: both"></div>

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

; Location
: SDK:C

== ARexx Interface ==

= USBSnoop =
[[File:LibToolIcon.png|left|80px|top]]

'''Tags:''' <span title="Tag" style="display: inline-block; line-height: 1; padding: 7px 10px 7px 10px; border-radius: 6px; outline: 0; margin-left: 1px; margin-right: 1px; margin-top: 7px; margin-bottom: 9px; background: #ff9437; color: #ffffff;">#Debugging

USBSnoop is a tool for spying and debugging USB drivers.

Incomplete description.
<div style="clear: both"></div>

[[File:SDKDeveloperToolsFigUSBSnoop.png|frame|left|USBSnoop Window]]
<div style="clear: both"></div>

== Tool Types ==

(none)

== Shell Usage ==

; Format
: USBSNOOP [ACTIVATE]

; Template
: ACTIVATE/S

; Location
: SDK:C

== ARexx Interface ==

USBSnoop has no ARexx interface.

UI Style Guide Shell

2023-07-18T13:39:43Z

Janne Peräaho: Corrected $VER string template

[[Category:User Interface Style Guide]]
== The Shell ==

One of the best things about the Amiga is its versatility. While the rest of the personal computing community continues to argue about the best type of interface, Amiga users have both - a graphic interface with Workbench and a text-based interface with the Shell.

The Shell (also known as the Command Line Interface or CLI) preserves the best features of operating computers the "old-fashioned way", that is, by typing commands at a console. Although that is in some ways more difficult than clicking on graphics with a mouse, it provides a finer level of control, less overhead and greater power than is possible through a GUI.

Virtually anything that can be done through Workbench can also be done through the Shell. On Workbench, for instance, a user can move into a subdirectory by double-clicking on its drawer icon. The equivalent of this in the Shell is to type

cd <subdirectory name>

The command ''dir'' will then list the contents of the directory.

The same example can be used to illustrate the greater power of the Shell. In addition to ''dir'', which gives a brief listing of files and subdirectories, the user can also use ''list'' which gives a more in-depth listing including the size of each file, information about the file and when it was last updated. Or you could list only a subset of files by using wildcards in the command. For example,

list #?.info

would list only those files ending with ".info".

[[File:SG8-1.png|frame|center|The Shell]]

In addition to being able to do things with finer control than Workbench, the Shell can also do some things that Workbench cannot do at all. For instance, from the Shell you can create a script - a pre-recorded set of commands that helps to automate repetitive tasks.

{{Note|text=Your application should support all three interfaces built into the Amiga: the GUI, the Shell and ARexx.}}

== Parsing Commands ==

You should use the command template method for parsing the command line:

=== Standard Form ===

In general, Shell commands take the form:

COMMAND [redirection-argument] [<argument1>,<argument2>, ...]

where COMMAND is the name of an executable file, [redirection-argument] is a "<", ">", and/or ">>" symbol followed by an AmigaDOS device name, and [<argument1>, <argument2>, ...] is a list of arguments that will be passed to the executable file.

Here's a sample Shell command:

play myanim loops 20

The command is ''play' (an executable program), there is no direction and three arguments are passed to the play program: ''myanim'' (the name of the data file), ''loops'' (a command option) and ''20'' (another command option).

=== Built-in Parsing ===

The Amiga, like UNIX and many other systems, passes command line arguments to your application. The system automatically provides the list of arguments and counts them for the application.

The system also needs to parse these arguments. Parsing refers to the job of examining the arguments to find out what they mean so the appropriate operation can be performed.

When your application is started from the Shell, any arguments should be parsed using the command template method - the same method used to parse all the system-supplied Shell commands. This argument parsing method should also be used by your ARexx or scripting commands.

By far, the greatest benefit of this method is that it allows you to use AmigaDOS routines to handle the chore of parsing the command line. The DOS routines will handle errors and give help messages so both your code and your development time can be shorter. Using standard argument parsing also makes the Shell interface more consistent and more comfortable for the user.

{{Note|text=Using AmigaDOS routines to handle command line parsing can shorten both your code and your development time.}}

=== The Command Template ===

In order for your application to use standard argument parsing, a command template must be constructed to describe the arguments that the command understands.

In the command template, each argument is specified by a keyword (a preset argument that the program understands) followed by a modifier that describes the properties of that argument. Modifiers take the form "/X" where X is one of the characters from the table below. Each keyword can have none or many of the modifiers.

Neither the keywords nor the modifiers are case-dependent. The format shown here corresponds to the way the system displays command templates in the Shell.

{| class="wikitable"
! Modifier
! Description
|-
| ,(comma) - No arguments
| The comma indicates a null argument. It also separates arguments in the command template.
|-
| = - Equivalents
| The equal sign indicates equivalent abbreviations for keywords, e.g. PS=PUBSCREEN/K.
|-
| A - Always required
| The argument must be supplied in order for the command to be accepted.
|-
| F - Final argument
| If this is specified, the entire rest of the line is taken together as a single argument, even if other keywords appear in it.
|-
| K - Keyword required
| This means [that] the actual keyword must be typed on the command line along with its argument in order for the argument to be processed (often the keyword is optional). The argument will not be interpreted unless the keyword appears.
For example, if the template is NAME/K, then unless Name=<string> or Name <string> appears in the command line, the command will be interpreted as having no Name argument at all.
|-
| M - Multiple argument
| There can be a number of instances of this argument. For example, the AmigDOS Join command lets your merge together any number of files into a single file. The template is:
FILE/M,AS=TO/K/A
This allows commands such as:
Join file1 file2 file3 as bigfile
When the /M modifier is the first argument in a template, any number of file names may be specified by the user.

If a command line has any leftover arguments, they will be interpreted as belonging to the /M argument. So only specify one /M per template. For example, in the command ''Join one two as bigfile three'', the word ''three'' is an extra argument. In this case, one, two and three will be merged together to form bigfile; the extra argument is tacked onto the /M arguments.

The /M argument also interacts with the /A argument. If there aren't enough arguments given to fill all the /As, then part of the previous /M argument will be used to fill in the /As.
|-
| N - Number
| This argument is a decimal number. If an invalid number is specified, an error message will be returned to the user. Unless the /N modifier is specified, all arguments are assumed to be strings.
|-
| S - Switch keyword
| This modifier indicates a switch keyword argument. If the keyword is given, the switch is "on". If the keyword isn't given, the switch is "off"
|-
| T - Toggle keyword
| This is similar to /S but, when specified, it causes the switch value to toggle from "on" to "off" or vice-versa.
|}

{| class="wiktiable"
| Use the standard command template described here in your Shell and ARexx commands.
|}

=== Displaying the Command Template ===

When a user types a command name in the Shell followed by a space and a question mark, the command template should be shown to him. This acts as a sort of help message that gives the syntax of the command. For instance, in the above example of ''play myanim loops 20' the command is ''play''. When the user types ''play ?'' in the Shell he should see this:

ANIM/A,LOOPS/K/N

This means the command has two arguments: the Anim argument and the Loops argument. The Anim argument consists of the optional keyword ''ANIM'' followed by an animation file name. The /A modifier means this argument must always be given.

In the Loops part of the argument, the /K means that the keyword ''LOOPS'' is required for the argument to be processed correctly, and the /N means that the ''LOOPS'' keyword should be followed by a decimal number. Notice that since the Loops argument does not have a /A modifier, it could be left out altogether.

Other possible commands a user could come up with include:

play myanimfile loops 20
play myanimfile
play anim myanimfile

These commands, however, would be illegal:

play myanimfile 20 (the required keyword LOOPS is missing)
play anim (no file name is given)
play anim myanimfile loops (the numeric value for LOOPS is missing)

== Standard Arguments ==

The following Shell arguments are standard within the system. Don't use these names for application-specific arguments with purposes different than those given below:

FILES/M List of files to work with as projects
PUBSCREEN/K Name of the public screen to open on
PORTNAME/K Name to assign to the ARexx port
STARTUP/K ARexx script to run at startup time
NOGUI/S Indicates that no GUI is desired
SETTINGS/K Name of preferences file to load at startup

If you need a keyword for your application, try to find an applicable one that is already in use - and use it the same way. If you need to make a new keyword, don't make it the same as a common command name; e.g. "list".

== Pattern Matching ==

When most people think of pattern matching, they think of using wilcards, but pattern matching is actually much more. It's a powerful feature that enables more efficient operations, especially on systems like the Amiga that have a hierarchical file system with few size limits.

Pattern matching is part of the appeal of the Shell. It would be difficult to use icons to perform an operation on 50 files at once - not to mention the problem of fitting all the icons on a 12-inch monitor. Some complex operations are just easier to do with a text interface.

{| class="wikitable"
|+ Standard Available Tokens
! Token
! Description
|-
| ?
| Matches a single character. For instance ''a?'' matches any string with two characters that starts with the letter a.
|-
| #
| Matches a subsequent expression 0 or more times. For instance, the pattern #? will match any string.
|-
| (ab|cd)
| Matches any one of the items separated by |.
|-
| ~
| Negates the following expression. For instance the pattern ~x? will match any two letter string except those starting with x. Another corollary of this is the pattern ''~(x?)'' which will match anything except two-letter strings beginning with x; ie. xaa or ab but not xa.
|-
| [abc]
| Character class; matches any one of the characters in the brackets.
|-
| [a-z]
| Character range (must be within character classes). You can also use [a-e,x-z] style.
|-
| %
| Matches 0 characters always. For example, the pattern (foo|whiskey|%)bar matches foobar, whiskeybar and bar.
|-
| *
| Synonym for #?. Not available by default but it is an option that can be turned on.
|}

Expression in this table means either a single token or character token (such as ''?'' or ''x''), or an alternation (such as ''(ab|cd|ef)''), or a character class (such as ''[a-z,A-Z]'').

=== The Amiga's Wildcard ===

On the Amiga, the wilcard is #? - as opposed to * on other platforms. For example, the command

delete #?.info

would delete all the files in the current directory that end in .info.

=== Within Applications ===

In addition to its usefulness on the filing system, pattern matching is also useful within applications. For example, the Find function within a text editor should be able to find strings according to a pattern.

Your application should support pattern matching from the Shell and from functions within the application itself, through AmigaDOS system routines.

== Embedded Version IDs ==

Follow the standard method for indicating the version of your software.

The Shell command VERSION provides support for version identification, but you have to follow a standard template.

A text sequence that indicates the current version of your application should be embedded within your code. (It should also be put in your ARexx scripts and your configuration files.) The format of this text sequence is:

<pre>$VER: <name> <version>.<revision> (<dd>.<mm>.<yyyy>)</pre>

<nowiki><name></nowiki> The name of your application
<nowiki><version></nowiki> Major version number
<nowiki><revision></nowiki> Minor revision number
<nowiki><dd></nowiki> Day created
<nowiki><mm></nowiki> Numeric month created
<nowiki><yyyy></nowiki> Year created

If you follow this template, the user can find out what version of your software he is using with the Shell command VERSION.

Version Strings

2023-07-18T13:35:16Z

Janne Peräaho: /* Introduction */

= Introduction =

Software versioning is one of the key elements in software development. It supports constant development and improvement while making regular releases. In versioning, each release will get a unique version number that identifies the release. The version number tells the software product's release order (release history), how big changes have been made since the previous release, and when each version was released.

On Amiga, the version number is divided in two sets of numbers separated by a point. The leftmost number is the major version number, and the rightmost number is the revision number that indicates a minor change. For example, the very first version is '''1.1''': the first revision of the first version.

The revision number should be increased when a program gets a minor update, i.e. when the added functionality does not break the program's backward compatibility. When incompatible changes are made, the program has received a major update and its major version number should be increased.

For example, releasing two minor updates bumps the version number up as follows: '''1.1''' → '''1.2''' → '''1.3'''. Making a new edition increases the major version number and resets the revision number. Thus after two minor and one major update, the version history looks like this:
<pre>
1.1 (the first version)
1.2 (1st minor update)
1.3 (2nd minor update)
2.1 (major update)
</pre>
The version information is embedded in a program as a text sequence called a version string. The format of this text sequence is:
<pre>
$VER: <name> <version>.<revision> (<dd>.<mm>.<yyyy>)
</pre>
:;<nowiki><name></nowiki>
::The name of your application
:;<nowiki><version></nowiki>
::Major version number
:;<nowiki><revision></nowiki>
::Minor revision number
:;<nowiki><dd></nowiki>
::Day when the application was created
:;<nowiki><mm></nowiki>
::Numeric month when the application was created
:;<nowiki><yyyy></nowiki>
::Year when the application was created
; Example:
The first version of application MyApplication that was released on 15th of July 2023:
<pre>
$VER: MyApplication 1.1 (15.07.2023)
</pre>
Using version strings is not restricted to applications. They can and should be used in libraries, devices, scripts, data files, etc.

= Hand-Coded Version Strings =

= Automating Version Numbering with BumpRev =

= See Also =

* [[SDK_Developer_Tools#BumpRev|BumpRev tool]]
* [[AmigaOS_Manual:_AmigaDOS_Command_Reference#VERSION|Version command]]

Version Strings

2023-07-18T13:33:30Z

Janne Peräaho: /* Introduction */

= Introduction =

Software versioning is one of the key elements in software development. It supports constant development and improvement while making regular releases. In versioning, each release will get a unique version number that identifies the release. The version number tells the software product's release order (release history), how big changes have been made since the previous release, and when each version was released.

On Amiga, the version number is divided in two sets of numbers separated by a point. The leftmost number is the major version number, and the rightmost number is the revision number that indicates a minor change. For example, the very first version is '''1.1''': the first revision of the first version.

The revision number should be increased when a program gets a minor update, i.e. when the added functionality does not break the program's backward compatibility. When incompatible changes are made, the program has received a major update and its major version number should be increased.

For example, releasing two minor updates bumps the version number up as follows: '''1.1''' -> '''1.2''' -> '''1.3'''. Making a new edition increases the major version number and resets the revision number. Thus after two minor and one major update, the version history looks like this:
<pre>
1.1 (the first version)
1.2 (1st minor update)
1.3 (2nd minor update)
2.1 (major update)
</pre>
The version information is embedded in a program as a text sequence called a version string. The format of this text sequence is:
<pre>
$VER: <name> <version>.<revision> (<dd>.<mm>.<yyyy>)
</pre>
:;<nowiki><name></nowiki>
::The name of your application
:;<nowiki><version></nowiki>
::Major version number
:;<nowiki><revision></nowiki>
::Minor revision number
:;<nowiki><dd></nowiki>
::Day when the application was created
:;<nowiki><mm></nowiki>
::Numeric month when the application was created
:;<nowiki><yyyy></nowiki>
::Year when the application was created
; Example:
The first version of application MyApplication that was released on 15th of July 2023:
<pre>
$VER: MyApplication 1.1 (15.07.2023)
</pre>
Using version strings is not restricted to applications. They can and should be used in libraries, devices, scripts, data files, etc.

= Hand-Coded Version Strings =

= Automating Version Numbering with BumpRev =

= See Also =

* [[SDK_Developer_Tools#BumpRev|BumpRev tool]]
* [[AmigaOS_Manual:_AmigaDOS_Command_Reference#VERSION|Version command]]

Version Strings

2023-07-18T13:25:00Z

Janne Peräaho: Introduction to version strings

= Introduction =

Software versioning is one of the key elements in software development. It supports constant development and improvement while making regular releases. In versioning, each release will get a unique version number that identifies the release. The version number tells the software product's release order (release history), how big changes have been made since the previous release, and when each version was released.

On Amiga, the version number is divided in two sets of numbers separated by a point. The leftmost number is the major version number, and the rightmost number is the revision number that indicates a minor change. For example, the very first version is '''1.1''': the first revision of the first version.

The revision number should be increased when a program gets a minor update, i.e. when the added functionality does not break the program's backward compatibility. When incompatible changes are made, the program has received a major update and its major version number should be increased.

For example, releasing two minor updates bumps the version number up as follows: '''1.1''' -> '''1.2''' -> '''1.3'''. Making a new edition increases the major version number and resets the revision number. Thus after two minor and one major update, the version history looks like this:
<pre>
1.1 (the first version)
1.2 (1st minor update)
1.3 (2nd minor update)
2.1 (major update)
</pre>
The version information is embedded in a program as a text sequence called a version string. The format of this text sequence is:
<pre>
$VER: <name> <version>.<revision> (<dd>.<mm>.<yyyy>)
</pre>
:;<name>
::The name of your application
:;<version>
::Major version number
:;<revision>
::Minor revision number
:;<dd>
::Day when the application was created
:;<mm>
::Numeric month when the application was created
:;<yyyy>
::Year when the application was created
; Example:
The first version of application MyApplication that was released on 15th of July 2023:
<pre>
$VER: MyApplication 1.1 (15.07.2023)
</pre>
Using version strings is not restricted to applications. They can and should be used in libraries, devices, scripts, data files, etc.

= Hand-Coded Version Strings =

= Automating Version Numbering with BumpRev =

= See Also =

* [[SDK_Developer_Tools#BumpRev|BumpRev tool]]
* [[AmigaOS_Manual:_AmigaDOS_Command_Reference#VERSION|Version command]]

AmigaOS Manual: ARexx

2022-12-06T05:54:59Z

Janne Peräaho: Listed the links in two columns

= Welcome =

ARexx, the Amiga counterpart of the IBM REXX programming language, provides the freedom to customize your work environment. It is especially useful as a scripting language which allows you to control and modify applications and to direct how they interact with each other.

This manual introduces you to ARexx, tells you how to create ARexx programs and provides a reference section of ARexx commands.

[[AmigaOS Manual: ARexx Introducing ARexx|Chapter 1. Introducing ARexx]] This chapter gives an overview of ARexx, how it works on the Amiga, and the basic features of the programming language.

[[AmigaOS Manual: ARexx Getting Started|Chapter 2. Getting Started]] This chapter tells you where to store your ARexx programs, how to execute an ARexx program, and provides several programming examples.

[[AmigaOS Manual: ARexx Elements of ARexx|Chapter 3. Elements of ARexx]] This chapter details the rules and concepts that make up the ARexx programming language.

[[AmigaOS Manual: ARexx Instructions|Chapter 4. Instructions]] This chapter contains an alphabetical listing of ARexx instructions, which are language statements that dictate an action.

[[AmigaOS Manual: ARexx Functions|Chapter 5. Functions]] This chapter describes the use of functions, which are program statements used by ARexx, and provides an alphabetical listing of the built-in ARexx functions.

[[AmigaOS Manual: ARexx Debugging|Chapter 6. Debugging]] This chapter focuses on the source-level debugging features used in the development and testing of programs.

[[AmigaOS Manual: ARexx Parsing|Chapter 7. Parsing]] This chapter explains how to extract patterns of information from strings.

[[AmigaOS Manual: ARexx Input and Output|Chapter 8. Input and Output]] This chapter explains the ARexx's input and output model.

[[AmigaOS Manual: Sounds|Chapter 9. Sounds]] This chapter explains how to record and play sounds.

[[AmigaOS Manual: Printing|Chapter 10. Printing]] This chapter explains how to print.

[[AmigaOS Manual: Serial and parallel ports|Chapter 11. Serial and parallel ports]] This chapter explains how to receive and send data through the serial and parallel ports.

[[AmigaOS Manual: Network resources|Chapter 12. Network resources]] This chapter explains how you can connect to a remote server and exchange data with it.

[[AmigaOS Manual: ARexx Error Messages|Appendix A. Error Messages]] This appendix lists the ARexx error messages.

[[AmigaOS Manual: ARexx Command Utilities|Appendix B. Command Utilities]] This appendix lists the ARexx commands that can be run from the Shell.

[[AmigaOS Manual: ARexx Special Variables|Appendix C. Special Variables]] This appendix lists the ARexx special variables.

[[AmigaOS Manual: External Function Libraries|Appendix D. External Function Libraries]] This appendix lists the external ARexx function libraries.

[[AmigaOS Manual: External Function Hosts|Appendix E. External Function Hosts]] This appendix lists the external function hosts.

[[AmigaOS Manual: ARexx Compatible Applications|Appendix F. ARexx Compatible Applications]] This appendix lists the operating system applications which have an ARexx interface.

[[AmigaOS Manual: Control Sequences|Appendix G. Control Sequences]] This appendix lists the control sequences for the text output.

[[AmigaOS Manual: Limits|Appendix H. Limits]] This appendix lists the ARexx implementation limits.

[[AmigaOS Manual: ARexx Glossary|Glossary]] The glossary contains common ARexx terms.

= Document Conventions =

The following conventions are used in this manual:

; KEYWORDS
: Keywords are displayed in all uppercase letters, however, the arguments are case-insensitive.

; | (vertical bar)
: Alternative selections are separated by a vertical bar.

; { } (braces)
: Required alternatives are enclosed by braces.

; [ ] (brackets)
: Optional instruction parts are enclosed in brackets.

; <n>
: Variables are displayed in angle brackets. Do not enter the angle brackets when entering the variable.

; Courier
: Text appearing in the Courier font represents output from your ARexx programs or other information that displays on your screen.

; Key1 + Key2
: Key combinations displayed with a plus sign (+) connecting them indicates pressing the keys simultaneously.

; Key1, Key2
: Key combinations displayed with a comma sign (,) separating them indicates pressing the keys in sequence.

; Amiga keys
: Two keys on the Amiga keyboard used for special functions. The left Amiga key is to the left of the space bar and is marked with a large solid A. The right Amiga key is to the right of the space bar and is an outlined A.

= Sources of Additional Information =

Further information on learning and using ARexx can be found in:

<div style="column-count: 2; font-size: 95%;">
* [[Special:BookSources/978-0135973295|Modern Programming Using REXX]], by R.P. O'Hara and D.G. Gomberg, Prentice-Hall, 1985.
* [[Special:BookSources/978-0137806515|The REXX Language: A Practical Approach to Programming]], by M.F. Cowlishaw, Prentice-Hall, 1985.
* [[Special:BookSources/978-0070153059|Programming in REXX]], J. Ranade IBM Series, by Charles Daney, McGraw-Hill Companies, 1990.
* [[Special:BookSources/978-1557551146|Using ARexx on the Amiga]], by Chris Zamara and Nick Sullivan, Abacus, 1991.
* [[Libraries|Libraries]]
</div>

Communities

<div style="column-count: 2; font-size: 95%;">
* [http://www.rexxla.org/ The Rexx Language Association]
</div>

AmigaOS Manual: AmigaDOS

2022-12-06T05:54:03Z

Janne Peräaho: Added link to the Python manual and listed the documentation in two columns

{{WIP}}
= Welcome =

The Amiga line of personal computers offers a unique combination of versatility, computing power, and usability. The fast, multitasking Amiga operating system allows users at any level of experience to take advantage of their system's resources.

AmigaDOS its the Amiga Disk Operating System. A disk operating system is software that manages data manipulation and control on the computer, such as:

* Providing a filing system that organizes the data that programs use and produce
* Handling information storage and retrieval from floppy disks, hard, disks, and other storage media

Providing an interface to peripheral devices, such as printers and modems

AmigaDOS provides a Command Line Interface (CLI), which means that you work with it through typed commands. Some of these commands parallel familiar Workbench operations, such as Copy, Rename, and Format Disk. There are also advanced commands that allow you to create scripts for performing repetitive tasks, to monitor the use of memory, and to perform other tasks unavailable through the Workbench. The commands are entered through a special window, known as a Shell window. Shell windows open on the Workbench screen and are similar to other Workbench windows, except that Shell windows only display text.

Together AmigaDOS and the Amiga Shell offer you a powerful and flexible operating environment with these features.

= Operating System Features =

* Complete control over all aspects of Amiga operation
* Hierarchical file system
* Filenames up to 256 characters, upper/lower case preserved without case-sensitivity
* Configurable command search path
* Pattern matching
* Background command processing
* Many commands internal, others can be made memory resident
* Shared libraries
* Multiple file systems supported, including CrossDOS (MS-DOS file system)

= Shell Features =

* Multiple, independent Shell windows
* Shell windows sizable, draggable, depth-adjustable
* Configurable prompt, font, and text color and style
* Command history and command line editing
* Fast character-mapped display
* Aliases
* Local and global environment variables
* Scripting
* Command input and output redirection
* Multiple directory assignment
* Copy and paste text among console windows
* ARexx support

= Using this Manual =

This manual, which should be used in conjunction with the Workbench User's Guide, describes the AmigaDOS software, its components, and how to use it. It assumes that you are familiar with Workbench, but have never worked with AmigaDOS. If this is the case, we recommend that you read through the entire manual to learn the concepts associated with the Amiga operating system before beginning to use it. After you have familiarized yourself with AmigaDOS, use this manual as a reference tool when executing commands or writing programs or scripts.

The following is a brief description of each chapter and appendix:

[[AmigaOS Manual: AmigaDOS Selecting an Interface|Chapter 1. Selecting an Interface]] This chapter gives information to help you determine when to use AmigaDOS rather than Workbench.

[[AmigaOS Manual: AmigaDOS Understanding the Shell|Chapter 2. Understanding the AmigaDOS Shell]] This chapter describes the AmigaDOS Shell in detail.

[[AmigaOS Manual: AmigaDOS Working With AmigaDOS|Chapter 3. Working with AmigaDOS]] This chapter describes the file management system, types of commands, and components of AmigaDOS commands.

[[AmigaOS Manual: AmigaDOS Using the Editors|Chapter 4. Using the Editors]] This chapter provides a full explanation for using the ED text editor and command listings for the MEmacs and EDIT text editors.

[[AmigaOS Manual: AmigaDOS Using Scripts|Chapter 5. Using Scripts]] This chapter describes AmigaDOS scripts and how to create them.

[[AmigaOS Manual: AmigaDOS Command Reference|Chapter 6. AmigaDOS Command Reference]] This chapter describes each AmigaDOS command in detail.

[[AmigaOS Manual: AmigaDOS Workbench-Related Command Reference|Chapter 7. Workbench-Related Command Reference]] This chapter describes the Workbench-related commands usable from AmigaDOS.

[[AmigaOS Manual: AmigaDOS Command Examples|Chapter 8. Command Examples]] This chapter provides examples of how to perform common tasks with AmigaDOS commands.

[[AmigaOS Manual: AmigaDOS Error Messages|Appendix A. Error Messages]] This chapter contains a list of possible program problems and suggested solutions.

[[AmigaOS Manual: AmigaDOS Additional Amiga Directories|Appendix B. Additional Amiga Directories]] This chapter describes S:, DEVS:, L:, FONTS:, and other directories.

Appendix C: Using Floppy-Only-Systems: This chapter tells you how to make the most of your system if you only have one floppy drive and no hard drive. '''Obsolete and not available'''

[[AmigaOS Manual: AmigaDOS Advanced Features|Appendix D. Advanced AmigaDOS Features]] This chapter provides information on customizing AmigaDOS for advanced Amiga users.

[[AmigaOS Manual: AmigaDOS Environment Variables|Appendix E. AmigaDOS Environment Variables]] This appendix lists the environment variables set by the Shell.

[[AmigaOS Manual: AmigaDOS Escape Sequences|Appendix F. AmigaDOS Escape Sequences]] This appendix lists the AmigaDOS escape sequences.

[[AmigaOS Manual: AmigaDOS Glossary|AmigaDOS Glossary]]

= Documentation Conventions =

The following conventions are used in this manual:

; COMMANDS, ASSIGNS, DEVICES and NAMES
: Commands, their keywords, device names, and assigned directories are displayed in all upper case letters. File and directory names are displayed in initial caps. However, they do not need to be entered this way. The Amiga ignores case differences in commands and arguments.

; <n>
: Angle brackets enclose variable information that you must supply. In place of <n>, substitute the value, text, or option desired. Do not enter the angle brackets when entering the variable.

; Courier
: Text appearing in the Courier font represents information that you type in or text displayed in a window in response to a command.

; Key1 + Key2
: Key combinations displayed with a + (plus) sign connecting them indicate pressing the keys simultaneously. For example, <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">C</kbd> indicates that you hold down the <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> key and, while holding it down, press <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">C</kbd>.

; Key1, Key2
: Key combinations displayed with a comma separating them indicate pressing the keys in sequence. For example, <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Esc</kbd>,<kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">O</kbd> indicates that you press and release the Esc key, followed by the <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">O</kbd> key.

; Return
: Directions to press the Return key indicate that you press the large odd shaped key on the right side of the keyboard above the right shift key.

; Enter
: Directions to "enter" something indicate that you type in the indicated information and press Return.

; command line indentation
: On command lines that are long enough to wrap to the next line, this manual shows the wrapped lines as indented for documentation purposes only. In practice, the wrapped lines align with the first character of the Shell prompt.

= Related Documentation =

<div style="column-count: 2; font-size: 95%;">
* AmigaDOS Quick Reference
* [[AmigaOS_Manual:_Workbench|Workbench User's Guide]]
* [[AmigaOS_Manual:_ARexx|ARexx User's Guide]]
* [[AmigaOS_Manual:_Python|Python User's Guide]]
* [[DeveloperDoc:Main|AmigaOS Developer Documentation]]
</div>

AmigaOS Manual: ARexx

2022-12-06T05:44:30Z

Janne Peräaho: /* Sources of Additional Information */

= Welcome =

ARexx, the Amiga counterpart of the IBM REXX programming language, provides the freedom to customize your work environment. It is especially useful as a scripting language which allows you to control and modify applications and to direct how they interact with each other.

This manual introduces you to ARexx, tells you how to create ARexx programs and provides a reference section of ARexx commands.

[[AmigaOS Manual: ARexx Introducing ARexx|Chapter 1. Introducing ARexx]] This chapter gives an overview of ARexx, how it works on the Amiga, and the basic features of the programming language.

[[AmigaOS Manual: ARexx Getting Started|Chapter 2. Getting Started]] This chapter tells you where to store your ARexx programs, how to execute an ARexx program, and provides several programming examples.

[[AmigaOS Manual: ARexx Elements of ARexx|Chapter 3. Elements of ARexx]] This chapter details the rules and concepts that make up the ARexx programming language.

[[AmigaOS Manual: ARexx Instructions|Chapter 4. Instructions]] This chapter contains an alphabetical listing of ARexx instructions, which are language statements that dictate an action.

[[AmigaOS Manual: ARexx Functions|Chapter 5. Functions]] This chapter describes the use of functions, which are program statements used by ARexx, and provides an alphabetical listing of the built-in ARexx functions.

[[AmigaOS Manual: ARexx Debugging|Chapter 6. Debugging]] This chapter focuses on the source-level debugging features used in the development and testing of programs.

[[AmigaOS Manual: ARexx Parsing|Chapter 7. Parsing]] This chapter explains how to extract patterns of information from strings.

[[AmigaOS Manual: ARexx Input and Output|Chapter 8. Input and Output]] This chapter explains the ARexx's input and output model.

[[AmigaOS Manual: Sounds|Chapter 9. Sounds]] This chapter explains how to record and play sounds.

[[AmigaOS Manual: Printing|Chapter 10. Printing]] This chapter explains how to print.

[[AmigaOS Manual: Serial and parallel ports|Chapter 11. Serial and parallel ports]] This chapter explains how to receive and send data through the serial and parallel ports.

[[AmigaOS Manual: Network resources|Chapter 12. Network resources]] This chapter explains how you can connect to a remote server and exchange data with it.

[[AmigaOS Manual: ARexx Error Messages|Appendix A. Error Messages]] This appendix lists the ARexx error messages.

[[AmigaOS Manual: ARexx Command Utilities|Appendix B. Command Utilities]] This appendix lists the ARexx commands that can be run from the Shell.

[[AmigaOS Manual: ARexx Special Variables|Appendix C. Special Variables]] This appendix lists the ARexx special variables.

[[AmigaOS Manual: External Function Libraries|Appendix D. External Function Libraries]] This appendix lists the external ARexx function libraries.

[[AmigaOS Manual: External Function Hosts|Appendix E. External Function Hosts]] This appendix lists the external function hosts.

[[AmigaOS Manual: ARexx Compatible Applications|Appendix F. ARexx Compatible Applications]] This appendix lists the operating system applications which have an ARexx interface.

[[AmigaOS Manual: Control Sequences|Appendix G. Control Sequences]] This appendix lists the control sequences for the text output.

[[AmigaOS Manual: Limits|Appendix H. Limits]] This appendix lists the ARexx implementation limits.

[[AmigaOS Manual: ARexx Glossary|Glossary]] The glossary contains common ARexx terms.

= Document Conventions =

The following conventions are used in this manual:

; KEYWORDS
: Keywords are displayed in all uppercase letters, however, the arguments are case-insensitive.

; | (vertical bar)
: Alternative selections are separated by a vertical bar.

; { } (braces)
: Required alternatives are enclosed by braces.

; [ ] (brackets)
: Optional instruction parts are enclosed in brackets.

; <n>
: Variables are displayed in angle brackets. Do not enter the angle brackets when entering the variable.

; Courier
: Text appearing in the Courier font represents output from your ARexx programs or other information that displays on your screen.

; Key1 + Key2
: Key combinations displayed with a plus sign (+) connecting them indicates pressing the keys simultaneously.

; Key1, Key2
: Key combinations displayed with a comma sign (,) separating them indicates pressing the keys in sequence.

; Amiga keys
: Two keys on the Amiga keyboard used for special functions. The left Amiga key is to the left of the space bar and is marked with a large solid A. The right Amiga key is to the right of the space bar and is an outlined A.

= Sources of Additional Information =

Further information on learning and using ARexx can be found in:

<div style="column-count: 2; font-size: 95%;">
# [[Special:BookSources/978-0135973295|Modern Programming Using REXX]], by R.P. O'Hara and D.G. Gomberg, Prentice-Hall, 1985.
# [[Special:BookSources/978-0137806515|The REXX Language: A Practical Approach to Programming]], by M.F. Cowlishaw, Prentice-Hall, 1985.
# [[Special:BookSources/978-0070153059|Programming in REXX]], J. Ranade IBM Series, by Charles Daney, McGraw-Hill Companies, 1990.
# [[Special:BookSources/978-1557551146|Using ARexx on the Amiga]], by Chris Zamara and Nick Sullivan, Abacus, 1991.
# [[Libraries|Libraries]]
</div>

Communities

<div style="column-count: 2; font-size: 95%;">
# [http://www.rexxla.org/ The Rexx Language Association]
</div>

AmigaOS Manual: Built-in Constants

2022-12-05T12:47:23Z

Janne Peräaho:

The following constants exist in the built-in namespace:
{| class="wikitable"
! style="text-align:left;" | Constant
! style="text-align:left;" | Description
|-
| False || The false value of the bool type.
|-
| True || The true value of the bool type.
|-
| None || The sole value of the type NoneType.
|-
| NotImplemented || Special value which should be returned by the binary special methods to indicate that the operation is not implemented. Its truth value is true.
|-
| Ellipsis || Special value used mostly in conjunction with extended slicing syntax for user-defined container data types. Same as "...".
|-
| __debug__ || This constant is true if Python was not started with an -O option.
|-
| quit([<nowiki><code></nowiki>]) || Object. Contains the quit help text. When called, quits the Python interpreter and returns <nowiki><code></nowiki> to the caller, if supplied. [[#CONSTANT|[1]]]
|-
| exit([<nowiki><code></nowiki>]) || Object containg the exit help text. When called, exits the Python interpreter and returns <nowiki><code></nowiki> to the caller, if supplied. [[#CONSTANT|[1]]]
|-
| copyright || Object containing the copyright text. [[#CONSTANT|[1]]]
|-
| credits || Object containing the credits text. [[#CONSTANT|[1]]]
|-
| license || Object containing the license text. [[#CONSTANT|[1]]]
|}

{{anchor|CONSTANT}}
[1] Constant added by the '''site''' module. If Python is executed without the option -s, '''site''' module is imported automatically.

AmigaOS Manual: Reserved Python Words

2022-12-05T12:14:57Z

Janne Peräaho:

Python has 34 keywords that have a predefined meaning and thus they cannot be used as a variable name. The keywords are:

{| class="wikitable"
! style="text-align:left;" | Keyword
! style="text-align:left;" | Description
|-
| and || A logical operator
|-
| as || Creates an alias
|-
| assert || Used for debugging. Raises an AssertionError exception with a specified error message if the supplied condition is False.
|-
| break || Exits loop
|-
| class || Defines a class
|-
| continue || Terminates the current loop iteration and begins the next one
|-
| def || Defines a function
|-
| del || Deletes an object
|-
| elif || A short for "else if"
|-
| else || Defines actions that are executed when if condition is False. See if. When used with exception handler, defines actions that are executed when there there was no error. See try.
|-
| except || Defines an error handler for an exception handler. See try.
|-
| exec || Executes the supplied Python code
|-
| False || A boolean value
|-
| finally || Defines actions for exception handler that are executed always. See try.
|-
| for || Creates a for loop
|-
| from || Imports a part of a module
|-
| global || Declares a global variable
|-
| if || Defines actions that are executed when if condition is True.
|-
| import || Imports a module
|-
| in || Checks if a value is present in an array
|-
| is || Tests if two values are equal
|-
| lambda || Defines an anonymous function
|-
| None || Defines a null value
|-
| not || A logical operator
|-
| or || A logical operator
|-
| pass || Does nothing, a null statement
|-
| print || Prints a message to the screen
|-
| raise || Raises an exception
|-
| return || Exits a function and returns a value
|-
| True || A boolean value
|-
| try || Defines an exception handler (tests a block of code for errors). See except, finally, and else.
|-
| while || Creates a while loop
|-
| with || Manages external resources
|-
| yield || Exits a generator function and returns a value
|}

All the keywords except '''False''', '''None''', and '''True''' are in lowercase and they must be written as they are.

AmigaOS Manual: Python Elements of Python

2022-12-05T12:06:14Z

Janne Peräaho: /* Bitwise Operations on Integer Types */

= Data types =

== Numbers ==

== Strings ==

== Arrays ==

Python has four types of arrays (data collections) with different properties:
* '''Lists''': duplicate members are allowed, lists are ordered and indexed, and their content can be changed.
* '''Tuples''': duplicate members are allowed, tuples are ordered and indexed, and their content cannot be changed.
* '''Sets''': duplicate members are not allowed, sets are unordered and unindexed, and their content cannot be changed.
* '''Dictionaries''': duplicate members are not allowed, dictionaries are unordered but indexed, and their content can be changed.

=== Lists ===

Python has the following functions for the lists
{| class="wikitable"
! style="text-align:left;" | Function
! style="text-align:left;" | Explanation
|-
| '''cmp''' ( <firstList>, <secondList> ) || Compare lists <firstList> and <secondList>.
|-
| '''len''' ( <list> ) || Get the number of elements on the list <list>. See [[AmigaOS_Manual:_Python_Functions#len.28.29|len()]] for more information.
|-
| '''max''' ( <list> ) || Get the maximum valued element on the list <list>. See [[AmigaOS_Manual:_Python_Functions#max.28.29|max()]] for more information.
|-
| '''min''' ( <list> ) || Get the minimum valued element on the list <list>. See [[AmigaOS_Manual:_Python_Functions#min.28.29|min()]] for more information.
|-
| '''list''' ( <tuple> ) || Convert the tuple <tuple> into a list. See [[AmigaOS_Manual:_Python_Functions#list.28.29|list()]] for more information.
|}

and the following methods for the list objects
{| class="wikitable"
! style="text-align:left;" | Method
! style="text-align:left;" | Explanation
|-
| <list>.'''append''' ( <object> ) || Append an object <object> to the list <list>.
|-
| <list>.'''count''' ( <object> ) || Count how many times object <object> appears on the list <list>.
|-
| <list>.'''extend''' ( <secondList> ) || Append list <secondList> into the list <list>.
|-
| <list>.'''index''' ( <object> ) || Find the first appearance of the object <object> on the list.
|-
| <list>.'''insert''' ( <index>, <object> ) || Insert object <object> into the list <list> at offset <index>.
|-
| <list>.'''pop''' ( [<index>] ) || Remove and return the last object from the list <list> or an object at the supplied offset.
|-
| <list>.'''remove''' ( <object> ) || Remove object <object> from the list <list>.
|-
| <list>.'''reverse''' () || Reverses the list <list> order.
|-
| <list>.'''sort''' ( [<function>] ) || Sort the list <list>. Uses the optional compare function <function>, if given.
|}

=== Tuples ===

=== Sets ===

=== Dictionaries ===

== Files ==

= Objects =

= Operators =

== Arithmetic operators ==
{| class="wikitable"
! Operator !! Name !! Explanation
|-
| + || Plus || Adds the two objects.
|-
| - || Minus || Either gives a negative number or gives the subtraction of one number from the other.
|-
| * || Multiply || Gives the multiplication of the two numbers or returns the string repeated that many times.
|-
| ** || Power || Returns x to the power of y.
|-
| / || Divide || Divide x by y.
|-
| // || Floor Division || Returns the floor of the quotient.
|-
| % || Modulo || Returns the remainder of the division.
|}

== Comparison operators ==
{| class="wikitable"
! Operator !! Name !! Explanation
|-
| < || Less Than || Returns whether x is less than y. All comparison operators return 1 for true and 0 for false. This is equivalent to the special variables '''True''' and '''False''' respectively. Note the capitalization of these variables' names.
|-
| > || Greater Than || Returns whether x is greater than y.
|-
| <= || Less Than or Equal To || Returns whether x is less than or equal to y.
|-
| >= || Greater Than or Equal To || Returns whether x is greater than or equal to y.
|-
| == || Equal To || Compares if the objects are equal.
|-
| != || Not Equal To || Compares if the objects are not equal.
|}

== Assignment Operators ==
{| class="wikitable"
! Operator !! Name !! Explanation
|-
| = || Assignment || Assigns values from right side operands to left side operand.
|-
| += || Addition and assignment || Adds right operand to the left operand and assigns the result to left operand.
|-
| -= || Subtraction and assignment || Subtracts right operand from the left operand and assigns the result to left operand.
|-
| *= || Multiplication and assignment || Multiplies right operand with the left operand and assigns the result to left operand.
|-
| /= || Division and assignment || Divides left operand with the right operand and assigns the result to left operand.
|-
| %= || Modulo and assignment || Takes modulus using two operands and assigns the result to left operand.
|-
| **= || Power of and assignment || Performs exponential (power) calculation on operators and assigns value to the left operand.
|-
| //= || Floor division and assignment || Performs floor division on operators and assigns value to the left operand.
|}

== Logical Operators ==
{| class="wikitable"
! Operator !! Name !! Explanation
|-
| not || Boolean NOT || If x is '''True''', it returns '''False'''. If x is '''False''', it returns '''True'''.
|-
| and || Boolean AND || x and y returns '''False''' if x is '''False''', else it returns evaluation of y.
|-
| or || Boolean OR || If x is '''True''', it returns '''True''', else it returns evaluation of y.
|}

== Bitwise Operations on Integer Types ==
{| class="wikitable"
! Operator !! Name !! Explanation
|-
| << || Left Shift || Shifts the bits of the number to the left by the number of bits specified.
|-
| >> || Right Shift || Shifts the bits of the number to the right by the number of bits specified.
|-
| & || Bitwise AND || Bitwise AND of the numbers.
|-
| <nowiki>|</nowiki> || Bitwise OR || Bitwise OR of the numbers.
|-
| ^ || Bitwise XOR || Bitwise XOR of the numbers.
|-
| ~ || Bitwise Invert || The bitwise inversion of x.
|}

== Membership Operators ==
== Identity Operators ==

= Comments =

= Indentation =

AmigaOS Manual: Built-in Constants

2022-12-05T09:05:03Z

Janne Peräaho:

The following constants exist in the built-in namespace:
{| class="wikitable"
! style="text-align:left;" | Constant
! style="text-align:left;" | Description
|-
| False || The false value of the bool type.
|-
| True || The true value of the bool type.
|-
| None || The sole value of the type NoneType.
|-
| NotImplemented || Special value which should be returned by the binary special methods to indicate that the operation is not implemented. Its truth value is true.
|-
| Ellipsis || Special value used mostly in conjunction with extended slicing syntax for user-defined container data types. Same as "...".
|-
| __debug__ || This constant is true if Python was not started with an -O option.
|-
| quit([<nowiki><code></nowiki>]) || Object. Contains the quit help text. When called, quits the Python interpreter and returns <nowiki><code></nowiki> to the caller, if supplied. (*)
|-
| exit([<nowiki><code></nowiki>]) || Object containg the exit help text. When called, exits the Python interpreter and returns <nowiki><code></nowiki> to the caller, if supplied. (*)
|-
| copyright || Object containing the copyright text. (*)
|-
| credits || Object containing the credits text. (*)
|-
| license || Object containing the license text. (*)
|}

(*) = constant added by the '''site''' module. If Python is executed without the option -s, '''site''' module is imported automatically.

AmigaOS Manual: Utilities

2022-12-05T08:58:25Z

Janne Peräaho: Corrected format

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the [[AmigaOS_Manual:_Workbench_Preferences#Printer_Editor|Printer]], [[AmigaOS_Manual:_Workbench_Preferences#PrinterPS_Editor|PrinterPS]], and [[AmigaOS_Manual:_Workbench_Preferences#PrinterGfx_Editor|PrinterGfx Preferences]] editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the [[AmigaOS_Manual:_Workbench_Preferences#PrinterGfx_Editor|PrinterGfx]] editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports the following tool types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SIZE= TINY or SMALL or MEDIUM or LARGE or <width>:<height> || The valid printout sizes are: TINY, SMALL, MEDIUM, LARGE, and absolute printout dimensions in dots. TINY makes the resulting printout about 1/4 the total width allowed by the printer. The height is such that the screen's original aspecct ratio is maintained. SMALL makes the width of the resulting printout about 1/2 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. MEDIUM makes the width of the resulting printout about 3/4 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE makes the width of the resulting printout be the full width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE is the default setting. The absolute printout dimension format is <width>:<height> where <width> is the printout's width in dots and <height> is the printout's height in dots.
|- style="vertical-align: top;"
| DELAY=<seconds> || Number of seconds to wait before printing starts. The default delay is 10 seconds. To start printing right away, set DELAY to 0.
|- style="vertical-align: top;"
| UNIT=<unit number> || Printer device's unit number. The default unit is 0.
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
: GRAPHICDUMP [SIZE {TINY|SMALL|MEDIUM|LARGE|<width>:<height>}] [TINY] [SMALL] [MEDIUM] [LARGE] [DELAY <seconds>] [UNIT <printer device unit>] [<width> <height>]

; Template
: SIZE/K,TINY/S,SMALL/S,MEDIUM/S,LARGE/S,DELAY/N/K,UNIT/N/K,DOTS

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T08:53:34Z

Janne Peräaho: Added links to Printer, PrinterPS, and PrinterGfx preferences editors.

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the [[AmigaOS_Manual:_Workbench_Preferences#Printer_Editor|Printer]], [[AmigaOS_Manual:_Workbench_Preferences#PrinterPS_Editor|PrinterPS]], and [[AmigaOS_Manual:_Workbench_Preferences#PrinterGfx_Editor|PrinterGfx Preferences]] editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the [[AmigaOS_Manual:_Workbench_Preferences#PrinterGfx_Editor|PrinterGfx]] editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports the following tool types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SIZE= TINY or SMALL or MEDIUM or LARGE or <width>:<height> || The valid printout sizes are: TINY, SMALL, MEDIUM, LARGE, and absolute printout dimensions in dots. TINY makes the resulting printout about 1/4 the total width allowed by the printer. The height is such that the screen's original aspecct ratio is maintained. SMALL makes the width of the resulting printout about 1/2 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. MEDIUM makes the width of the resulting printout about 3/4 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE makes the width of the resulting printout be the full width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE is the default setting. The absolute printout dimension format is <width>:<height> where <width> is the printout's width in dots and <height> is the printout's height in dots.
|- style="vertical-align: top;"
| DELAY=<seconds> || Number of seconds to wait before printing starts. The default delay is 10 seconds. To start printing right away, set DELAY to 0.
|- style="vertical-align: top;"
| UNIT=<unit number> || Printer device's unit number. The default unit is 0.
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
: GRAPHICDUMP [SIZE <printing size>] [TINY] [SMALL] [MEDIUM] [LARGE] [DELAY <seconds>] [UNIT <printer device unit>] [<width>:<height>]

; Template
: SIZE/K,TINY/S,SMALL/S,MEDIUM/S,LARGE/S,DELAY/N/K,UNIT/N/K,DOTS

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T08:45:33Z

Janne Peräaho: /* Tool Types */

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports the following tool types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SIZE= TINY or SMALL or MEDIUM or LARGE or <width>:<height> || The valid printout sizes are: TINY, SMALL, MEDIUM, LARGE, and absolute printout dimensions in dots. TINY makes the resulting printout about 1/4 the total width allowed by the printer. The height is such that the screen's original aspecct ratio is maintained. SMALL makes the width of the resulting printout about 1/2 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. MEDIUM makes the width of the resulting printout about 3/4 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE makes the width of the resulting printout be the full width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE is the default setting. The absolute printout dimension format is <width>:<height> where <width> is the printout's width in dots and <height> is the printout's height in dots.
|- style="vertical-align: top;"
| DELAY=<seconds> || Number of seconds to wait before printing starts. The default delay is 10 seconds. To start printing right away, set DELAY to 0.
|- style="vertical-align: top;"
| UNIT=<unit number> || Printer device's unit number. The default unit is 0.
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
: GRAPHICDUMP [SIZE <printing size>] [TINY] [SMALL] [MEDIUM] [LARGE] [DELAY <seconds>] [UNIT <printer device unit>] [<width>:<height>]

; Template
: SIZE/K,TINY/S,SMALL/S,MEDIUM/S,LARGE/S,DELAY/N/K,UNIT/N/K,DOTS

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T08:44:16Z

Janne Peräaho: /* Tool Types */

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports the following tool types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SIZE= TINY or SMALL or MEDIUM or LARGE or <width>:<height> || The valid printout sizes are: TINY, SMALL, MEDIUM, LARGE, and absolute printout dimensions in dots. TINY makes the resulting printout about 1/4 the total width allowed by the printer. The height is such that the screen's original aspecct ratio is maintained. SMALL makes the width of the resulting printout about 1/2 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. MEDIUM makes the width of the resulting printout about 3/4 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE makes the width of the resulting printout be the full width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. (LARGE is the default setting.). The absolute printout dimension format is <width>:<height> where <width> is the printout's width in dots and <height> is the printout's height in dots.
|- style="vertical-align: top;"
| DELAY=<seconds> || Number of seconds to wait before printing starts. The default delay is 10 seconds. To start printing right away, set DELAY to 0.
|- style="vertical-align: top;"
| UNIT=<unit number> || Printer device's unit number. The default unit is 0.
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
: GRAPHICDUMP [SIZE <printing size>] [TINY] [SMALL] [MEDIUM] [LARGE] [DELAY <seconds>] [UNIT <printer device unit>] [<width>:<height>]

; Template
: SIZE/K,TINY/S,SMALL/S,MEDIUM/S,LARGE/S,DELAY/N/K,UNIT/N/K,DOTS

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T08:43:08Z

Janne Peräaho: Added the missing tool types and updated the SIZE tool type description

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports the following tool types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SIZE= TINY or SMALL or MEDIUM or LARGE or <width>:<height> || The valid printout sizes are: TINY, SMALL, MEDIUM, LARGE, and absolute printout dimensions in dots. TINY makes the resulting printout about 1/4 the total width allowed by the printer. The height is such that the screen's original aspecct ratio is maintained. SMALL makes the width of the resulting printout about 1/2 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. MEDIUM makes the width of the resulting printout about 3/4 the total width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. LARGE makes the width of the resulting printout be the full width allowed by the printer. The height is such that the screen's original aspect ratio is maintained. (LARGE is the default setting.). The absolute printout dimension format is <width>:<height> where <width> is the printout's width in dots and <height> is the printout's height in dots.
|- style="vertical-align: top;"
| DELAY=<seconds> || Number of seconds to wait before printing starts. The default delay is 10 seconds. To start printing right away, set DELAY to 0.
|- style="vertical-align: top;"
| UNIT=<unit number> || Printer device's unit number. The default unit is 0.
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
: GRAPHICDUMP [SIZE <printing size>] [TINY] [SMALL] [MEDIUM] [LARGE] [DELAY <seconds>] [UNIT <printer device unit>] [<width>:<height>]

; Template
: SIZE/K,TINY/S,SMALL/S,MEDIUM/S,LARGE/S,DELAY/N/K,UNIT/N/K,DOTS

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T08:03:35Z

Janne Peräaho: Added command format and template

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
: GRAPHICDUMP [SIZE <printing size>] [TINY] [SMALL] [MEDIUM] [LARGE] [DELAY <seconds>] [UNIT <printer device unit>] [<width>:<height>]

; Template
: SIZE/K,TINY/S,SMALL/S,MEDIUM/S,LARGE/S,DELAY/N/K,UNIT/N/K,DOTS

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T07:51:25Z

Janne Peräaho: Moved section "Tool Types" after the "Stopping the program"

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T07:48:23Z

Janne Peräaho: "Starting the program" renamed to "Tool Types"

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== Tool Types ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T07:46:36Z

Janne Peräaho: /* Tool Types */

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== Starting the program ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T07:44:05Z

Janne Peräaho: Added the default subtitles

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== Starting the program ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T07:43:17Z

Janne Peräaho: Added default subtitles

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== Starting the program ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Utilities

2022-12-05T07:42:18Z

Janne Peräaho: Added default subtitles

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

== Tool Types ==

Missing description.

== Shell Usage ==

Missing description.

== ARexx Interface ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== Starting the program ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: ARexx Compatible Applications

2022-12-05T07:34:30Z

Janne Peräaho: Corrected AmiDock, Multiview, and RexxMast links

The following AmigaOS programs have an ARexx interface for inter-process-communication. To get a list of supported commands, send command '''HELP''' to a program's ARexx port or click the '''Supported commands''' link displayed on the table below for detailed information.
{| class="wikitable"
! style="text-align:left;" | Application
! style="text-align:left;" | Description
! style="text-align:left;" | ARexx Port
! style="text-align:left;" | ARexx Interface
|-
| AmiDock || Application launcher || AMIDOCK || [[AmigaOS_Manual:_Utilities#ARexx_Interface_18|Supported commands]]
|-
| AmiGS || PS, EPS, and PDF document viewer and printing utility || AMIGS.x || [[AmigaOS_Manual:_Utilities#ARexx_Interface|Supported commands]]
|-
| AmiPDF || PDF document viewer || AMIPDF.x || [[AmigaOS_Manual:_Utilities#ARexx_Interface_2|Supported commands]]
|-
| ED || Text editor || Ed, Ed_x || [[AmigaOS_Manual:_AmigaDOS_Using_the_Editors#ARexx_Support|Supported commands]]
|-
| Mixer || Sound mixer || MIXER || Supported commands
|-
| Multiview || File viewer || MULTIVIEW.x || [[AmigaOS_Manual:_Utilities#ARexx_Interface_12|Supported commands]]
|-
| RexxMast || ARexx interpreter || REXX || [[AmigaOS_Manual:_System_Tools#ARexx_Interface_12|Supported commands]]
|-
| SGrab || Screen and window grabber || SGRAB || Supported commands
|-
| Workbench || AmigaOS's graphical user interface || WORKBENCH || [[AmigaOS_Manual:_Workbench_Using#ARexx_Interface|Supported commands]]
|}

If an application is capable of opening several windows, its ARexx port name contains a slot number (x). Slot number tells which of the currently open windows is the target window. Slot number 1 refers to the first window, 2 to the second window, and so on.

AmigaOS Manual: Utilities

2022-12-05T07:31:09Z

Janne Peräaho: /* Tool Types */

The Utilities drawer contains programs that are helpful, but not necessary for working with your Amiga.

= AmiGS =
AmiGS is a viewing and printing utility for postscript, EPS, and PDF documents.

== Tool Types ==

AmiGS supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiGS window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiGS will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIGS [FILE <file name>] [PAGE <page number>] [PAGENAME <page name>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN]

; Template
: FILE,PAGE/N,PAGENAME/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S

== ARexx Interface ==
AmiGS has an ARexx interface which allows other programs to control AmiGS while it is running. AmiGS's ARexx port name is '''AMIGS.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiGS running, its ARexx port is '''AMIGS.1'''. The other instance of AmiGS has a port named '''AMIGS.2''', the third instance '''AMIGS.3''' and so on.

AmiGS upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiGS creates a unique ID number for each opened document. The first opened document will get this ID number. AmiGS generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<file name>] || Opens the named file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open document using the AmiGS's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= AmiPDF =
AmiPDF is a PDF document viewer. It can also be used for converting PDF documents to text files and PostScript files.

== Tool Types ==

AmiPDF supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| WINDOWBOX=<left>/<top>/<width>/<height> || This tool type allows you to define AmiPDF window position and dimensions.
|-
| PUBSCREEN=<public screen> || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this tool type.
|}

== Shell Usage ==

; Format
: AMIPDF [FILE <filename>] [PAGE <page number>] [PAGENAME <page name>] [OWNERPASS <password>] [USERPASS <password>] [ZOOM <zoom factor>] [PUBSCREEN <public screen name>] [FULLSCREEN] [PAPERSIZE <paper size>] [PAPERWIDTH <paper width>] [PAPERHEIGHT <paper height>] [PSLEVEL1] [TEXTENCODING <encoding> ] [QUIET]

; Template
: FILE,PAGE/N,PAGENAME/K,OWNERPASS/K,USERPASS/K,ZOOM/K,PUBSCREEN/K,FULLSCREEN/S,PAPERSIZE=PS/K,PAPERWIDTH=PW/K,PAPERHEIGHT=PH/K,PSLEVEL1/S,TEXTENCODING=TE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FILE || Name of the PDF file to open.
|- style="vertical-align: top;"
| PAGE || Page number. Open the PDF document from the specified page.
|- style="vertical-align: top;"
| PAGENAME || Like PAGE except you can use page names instead of page numbers.
|- style="vertical-align: top;"
| OWNERPASS || Document's owner password. Providing this will bypass all security restrictions.
|- style="vertical-align: top;"
| USERPASS || Document's user password. As a minimum this will unlock the read protection.
|- style="vertical-align: top;"
| ZOOM || Initial zoom factor. Percentage value.
|- style="vertical-align: top;"
| PUBSCREEN || Name of the public screen. AmiPDF will open its window on the public screen which name has been supplied with this argument.
|- style="vertical-align: top;"
| FULLSCREEN || Display the PDF document using the full-screen mode.
|- style="vertical-align: top;"
| PAPERSIZE || Paper size: '''LETTER''', '''LEGAL''', '''A4''', or '''A3'''.
|- style="vertical-align: top;"
| PAPERWIDTH || Set the paper width in points.
|- style="vertical-align: top;"
| PAPERHEIGHT || Set the paper height in points.
|- style="vertical-align: top;"
| PSLEVEL1 || Generates Level 1 PostScript. The resulting PostScript file will be significantly larger (if it contains images), but will print on Level 1 printers. This also converts all images to black and white.
By default AmiPDF generates Level 2 PostScript.
|- style="vertical-align: top;"
| TEXTENCODING || Sets the encoding to use for text output.
|- style="vertical-align: top;"
| QUIET || Don't print any messages or errors.
|}

== ARexx Interface ==
AmiPDF has an ARexx interface which allows other programs to control AmiPDF while it is running. AmiPDF's ARexx port name is '''AMIPDF.<slot #>''', where '''<slot #>''' is the ARexx port slot. When you have one AmiPDF running, its ARexx port is '''AMIPDF.1'''. The other instance of AmiPDF has a port named '''AMIPDF.2''', the third instance '''AMIPDF.3''' and so on.

AmiPDF supports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| GETDEFAULTID || Returns the default document ID in the ARexx variable '''RESULT'''.
AmiPDF creates a unique ID number for each opened document. The first opened PDF document will get this ID number. AmiPDF generates a new document ID by adding 1 to the last used ID number. Thus the second document's ID number will be 2, third's 3, and so on. When you close a document, its ID number won't be reused.
|-
| QUIT || Quits the application.
|-
| OPEN [<pdf file>] || Opens the named PDF file in a new window or if the file name is not supplied, displays a file requester for selecting a file.
|-
| CLOSE <document id> || Closes an open PDF document using the AmiPDF's internal document ID number.
|-
| FIRSTPAGE <document id> || Displays the first page of the document which ID number is <document id>.
|-
| LASTPAGE <document id> || Displays the last page of the document which ID number is <document id>.
|-
| PREVPAGE <document id> || Displays the previous page of the document which ID number is <document id>.
|-
| NEXTPAGE <document id> || Displays the next page of the document which ID number is <document id>.
|-
| GOTOPAGE <document id> <page number> || Displays the requested page of the document which ID number is <document id>.
|}

= BRU =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Calculator =

The Calculator is a standard four-function calculator for adding, subtracting, multiplying, and dividing. Opening the Calculator icon activates it.

The calculator works like any standard calculator. The buttons on the calculator are gadgets. The numbered gadgets represent the digits 0 through 9. The non-numerical gadgets represent:

{| class="wikitable"
| CA || Clear all previous entries. Resets the calculator to 0.
|-
| CE || Clear the current entry.
|-
| X || Multiply.
|-
| / || Divide.
|-
| + || Add.
|-
| - || Subtract.
|-
| . || Decimal point.
|-
| « || Delete the last digit entered.
|-
| ± || Change the sign of the current entry. Positive numbers become negative; negative numbers become positive.
|-
| = || Display the result of the operation.
|}

To press a button, select the gadget with the mouse or press the corresponding key on the keyboard. You can use either the keyboard or numeric keypad keys. Return and the keypad Enter key are equivalent to the equals (=) button. The left arrow key is equivalent to the («) button.

The calculator displays a message for Overflow and Divide By Zero errors.

Select the close gadget to exit the Calculator.

== Calculator menus ==

The calculator has three menus: the Project menu, the Edit menu, and the Windows menu.

On the Project menu:
{| class="wikitable"
| Clear Entry || Clears the current entry only.
|-
| Clear All || Clears all entries and resets the display to zero.
|-
| Quit || Closes off the calculator.
|}

On the Edit menu:
{| class="wikitable"
| Cut || Copies and clears the current entry to the Clipboard.
|-
| Copy || Copies the current entry to the Clipboard without clearing the area.
|-
| Paste || Place the current Clipboard contents into the calculator.
|}

Show Tape is the only Window menu option. It displays a window showing the calculator entries and results. Show Tape can also be copied, but since it does not have a menu, use drag-select and Amiga+C to copy its contents to the Clipboard.

== Tool Types ==

Calculator supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN=<public screen name> || Name of the public screen. Calculator will open its window on the public screen which name has been supplied with this tool type.
|-
| TAPE=<window specification> || Defines a custom tape window.
|-
| GUIMODE=SIMPLE<nowiki>|</nowiki>EXTENDED || Selects which user interface mode Calculator will use. SIMPLE opens a basic calculator while EXTENDED opens a scientific calculator.
|}

== Shell Usage ==

; Format
: CALCULATOR [PUBSCREEN <public screen name>] [GUIMODE SIMPLE<nowiki>|</nowiki>EXTENDED] [TAPE <window specification>] [COMPUTE <expression>]

; Template
: PUBSCREEN,GUIMODE/K,TAPE/K,COMPUTE/K/F

== ARexx Interface ==

Calculator has no ARexx interface.

= Clock =

Clock displays the time and date on your Workbench screen. It can also be used as an alarm clock to signal you at a specified time.

When you open the Clock icon, a window with a round (analog) clock face appears. If the time Shown is incorrect, use the Time editor in the Prefs drawer, described in Chapter 5, to set the correct time.

== Clock Menus ==

Clock has two menus for changing the display and settings: Project and Settings.

The Project menu contains the following items:

{| class="wikitable"
| Analog || Displays the round Clock face. Analog is the default; its window size can be changed.
|-
| Digital || Displays a digital (numeric) clock the height of the title bar using your screen font.
|-
| Quit || Closes the Clock.
|}

The Settings menu contains the following items:

{| class="wikitable"
| Date || Displays the date beneath the analog clock. The date and time are alternately displayed on the digital clock. Date off is the default.
|-
| Seconds || Displays the time with a sweep second hand on the analog clock. The default setting shows no seconds. The Display Seconds item is overridden by the Digital Format setting when using the digital clock.
|-
| Digital Format || Displays the time in a 12 or 24 hour format, with or without seconds, for the digital clock only.
|-
| Alarm || Allows you to turn the alarm on or off. A checkmark indicates that the alarm is on.
|-
| Set Alarm || Allows you to set the time for the alarm to signal you. Because the signal is a short audible tone, you must have audio output on your Amiga to use this feature.
|-
| Save Settings || Saves your Clock settings. Each time you run the Clock program it opens with these settings until you change them.
|}

To set the alarm:

# Choose the Set Alarm menu item.
# Change the time setting by dragging the hour and minute sliders to the right to increase the value or the left to decrease the value until the correct time is displayed.
# When the requester displays the desired alarm time, select the Use gadget. This automatically turns the alarm on, as indicated by the checkmark next to the Alarm menu item. Select the Cancel gadget to restore the previous alarm setting and exit.

The alarm remains on and beeps at the same time each day until you deselect Alarm or close the Clock. The Clock must be running for the alarm to work. The next time you open the Clock, the alarm must be reset.

== Tool Types ==

Tool Types in the Clock icon's Information window allow you to save the menu, size, and position settings on the Clock. The Clock's Tool Types are the same as its keywords in AmigaDOS.

== Shell Usage ==

; Format
: CLOCK [DIGITAL] [<left>] [<top>] [<width>] [<height>] [24HOUR] [SECONDS] [DATE] [<format>] [<public screen>]

; Template
: DIGITAL/S,LEFT/N,TOP/N,WIDTH/N,HEIGHT/N,24HOUR/S,SECONDS/S,DATE/S,FORMAT/N,PUBSCREEN/K

== ARexx Interface ==

Clock has no ARexx interface.

= More =

More displays ASCII text filers on the Workbench screen. More does not have an icon, although it resides in the Utilities drawer. More has been superseded by the [[AmigaOS_Manual:_Workbench_Using#MultiView|MultiView]] program, but is retained for compatibility with files that use More as their Default Tool.

The following key sequences can be used to move through the More display and to get help for using More:

{| class="wikitable"
| Space bar or down arrow || Displays the next page.
|-
| Backspace or up arrow || Displays the previous page.
|-
| H || Help (displays a list similar to this one).
|}

When the last page of the display is reached, an End of File message is displayed at the bottom of the screen. Press the space bar at this point or click the close gadget at any time to exit More.

=== Tool Types ===

(none)

=== Shell Usage ===

; Format
: MORE <file>

; Template
: FILE

=== ARexx Interface ===

More has no ARexx interface.

= GraphicDump =

GraphicDump prints (or dumps) entire screens, including menus and icons, just as they appear on your monitor. Your printer must be capable of printing graphic images. (Most printers can print GraphicDump output.)

Before using GraphicDump, make sure the settings in the Printer, PrinterPS, and PrinterGfx Preferences editors are appropriate for your printer. You can specify the dimensions of the printout with the Limits setting in the PrinterGfx editor. Otherwise, the printout is the full width allowed by the printer.

To use GraphicDump, double-click on its icon. After a ten second delay the front-most screen image is sent to the printer. The mouse pointer is not printed.

== Tool Types ==

GraphicDump supports a SIZE Tool Type. The acceptable arguments for SIZE and the resulting size of the printout are:

{| class="wikitable"
| SIZE=tiny || 1/4 the total width allowed by the printer.
|-
| SIZE=small || 1/2 the total width allowed by the printer.
|-
| SIZE=medium || 3/4 the total width allowed by the printer.
|-
| SIZE=large || Full width allowed by the printer (default).
|}

The height of the printout maintains the perspective of the screen. The Limits Type gadget in the PrinterGfx editor must be set to Ignore for GraphicDump, or else the size of the printout is determined by the Limits setting.

To set specific dimensions in a Tool Type, use:

SIZE=<xdots>:<ydots>

Substitute the width, in number of printer dots, for the <xdots> argument and the height for the <ydots> argument.

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

GraphicDump has no ARexx interface.

= IconEdit =

IconEdit personalizes your Workbench by changing the appearance of existing icons and creating new ones.

The window shown in Figure 10-2 appears when you open the IconEdit icon.

[[File:WorkbenchFig10-2.png|frame|none|IconEdit Window]]

Draw and edit icons in the magnified view box of the IconEdit window. The Normal and Selected view boxes show the icon images at actual size. Several gadgets in the window draw squares, circles, and straight lines, giving you more control over your drawing.

There are three subwindows in IconEdit: the Normal and Selected view boxes and the Magnified View Box, which fills most of the window. Each of these is an AppWindow into which you can drag an icon to load it, rather than using menus. (AppWindows are described in Chapter 3.) Clicking in the Normal view box displays the selected image of the icon as long as you hold down the selection button.

== Color Selection Gadget ==

The Color Selection gadget lets you select a color for drawing. In addition to the standard method for selecting a color by pointing to it and clicking the selection button, this gadget allows you to choose two-color patterns. The patterns are used with the Fill, filled Circle, and filled Box gadgets.

In order to use fill patterns you need to select the first color by left-clicking on it. After that keep the Shift key depressed and select the second color. The gadget bar with the different fill patterns will change its appearance accordingly, giving a simple preview on the two-color patterns.

Below the color selection gadget there is the Transparent gadget. Selecting a color from the palette and clicking on Transparent" afterward will make this color invisible" when the icon is saved to disk. Clicking on the Transparent gadget a second time using the same color will deactivate transparency.

== Magnified View Box ==

Use the mouse to draw your icon in this box. Click the selection button to display a pixel of the selected color. Hold down the selection button to draw while moving the mouse.

The pointer turns into cross hairs when it is in the magnified view box. The new pixels appear a the center of the cross hairs. Pixel coordinates (relative to the upper left corner) appear in the middle of the IconEdit window below the title bar to show the position of the crosshair.

To load an existing icon into IconEdit, drag the icon into the magnified view box.

== Fill pattern Gadgets ==

These gadgets allow you to select the fill pattern to be used with filled rectangles, filled circles and the flood fill tool.

== Freehand Gadget ==

The Freehand gadget lets you quickly draw unstructured shapes. If you select this gadget and then draw in the magnified view box, the pixels fill in as the mouse passes over them. However, you may not get a continuous line and some pixels may not be filled in. Use this gadget to sketch an icon that you intend to fill in the details on later.

== Continuous Freehand Gadget ==

The Continuous Freehand gadget is similar to the freehand gadget, except that it produces a continuous line. When drawing continuous lines, there is a delay before the display catches up with your movement.

== Circle Gadget ==

To draw a circle or oval:

# Select the circle gadget.
# Point inside the magnified box at the point where you want the center of the circle, hold down the selection button, and move the mouse.
# Release the selection button when you reach the correct size and shape.

If you keep the Shift key depressed while drawing the circle, a true circle, rather than an ellipse, will be drawn.

== Filled Circle Gadget ==

Follow the steps for drawing normal circles to draw a filled circle or ellipse, using the current fill pattern.

== Box Gadget ==

To draw a box:

# Select the box gadget.
# Point inside the magnified boy at the point where you want a corner of the box, hold down the selection button, and move the mouse.
# Release the selection button when the box is the correct size and shape.

If you keep the Shift key depressed while drawing the box, a true square will be drawn instead.

To draw a three-dimensional box, similar in appearance to the Workbench gadgets, hold down an Alt key while drawing a box outline. The left and top border of the box will then be drawn using the current color while the right and bottom borders will be drawn using the color currently selected as the second color for fill patterns.

== Filled Box Gadget ==

Follow the steps for drawing a normal box in order to draw a filled box or square using the current fill pattern.

== Line Gadget ==

To draw a straight line:

# Select the line gadget.
# Position the mouse where you want the line to start.
# Hold down the selection button.
# Move the mouse to the line ending position.
# Release the selection button.

== Fill Gadget ==

Use the fill gadget to fill an area of the magnified view box with the selected color. Select the fill gadget, then click within the area you want to change to the same color as the dot under the crosshair.

{{Note|The fill gadget does not fill a patterned area. However, solid areas can be filled with one of the fill patterns, if selected.}}

== Undo ==

Select Undo to cancel the last mouse action performed in the magnified view box. Undo acts as a toggle switch; selecting it again undoes the Undo.

== Redo ==

Select Redo to cancel the last undo action, effectively restoring the state the magnified view box was in before calling undo.

== Clear ==

Select the Clear gadget to erase the contents of the magnified view box. The magnified view box fills with the currently selected color.

== Normal/Selected Radio Buttons ==

The Normal and Selected radio buttons switch between unselected and selected images for an icon. The normal image is how an unselected icon looks. The selected image is how a dual-image icon looks after you have clicked on it.

When the Normal radio button is selected, any image drawn in the magnified view box appears in the normal view box at the top of the window.

When the Selected radio button is used, you can create the image that appears when the icon is selected. You can only use this radio button when the Image menu item is chosen from the Highlight menu. Any image created appears in the selected view box.

== Arrows ==

The arrows let you shift your image. Clicking on an arrow moves the image in the magnified view in the direction of the arrow. Use these arrows to control the placement of your image within the box surrounding the finished icon.

{{Note|Any part of the image that is moved off the edge of the magnified view box is lost.}}

Keyboard shortcut: Press the corresponding arrow key to move the image.

== Project Menu ==

The items in the Project menu let you open and save icon files.

{| class="wikitable"
| New || Loads the default icon for the currently chosen type of icon. (The type of icon is determined by the Type menu.) Any changes in the window that have not been saved produce a requester asking if you want to save them.
|-
| Open || Opens an existing icon file. A requester appears for entering the name of the file. Only the names of drawers and .info files appear in the IconEdit Open file requester.
|-
| Revert || Restores the icon to the state it was in when it was last saved to disk, removing all changes that had been made since then. If the icon has not been previously saved, this menu item will be ghosted.
|-
| Save || Saves an existing icon file, overwriting any file with the same name. In this case the previous icon is lost.
|-
| Save As || Allows you to specify a file name for saving the current image. A requester lets you enter the destination for the edited icon. Use Save As to prevent overwriting an existing icon file.
|-
| Save As Default Icon || Saves the current image as the default icon for the currently selected icon type. This image is used for any new icon or pseudo-icon of that type created, including those made with the New menu item in the IconEdit Project menu. For example, if you create a drawer icon and then choose Save As Default Icon, that icon is used to represent drawers when you choose the Show All Files menu item.
|-
| Quit || Exits the IconEdit program. If you have not saved the current image, a requester asks if you want to save the image before exiting IconEdit.
|}

== Edit Menu ==

The items in the Edit menu allow you to use the Amiga`s Clipboard to import IFF ILBM clips that were created with other programs.

{| class="wikitable"
| Cut || Deletes the image in the magnified view box and copies it to the Clipboard.
|-
| Copy || Copies the image in the magnified view box to the Clipboard.
|-
| Paste || Copies any image in the Clipboard to the magnified view box, replacing the current contents.
|-
| Erase || Erases any image in the magnified view box. You can erase everything or save before erasing.
|-
| Undo || Has the same function as the corresponding gadget.
|-
| Redo || Has the same function as the corresponding gadget.
|-
| Open Clip || Copies an existing IFF file into the Clipboard. A requester asks for the name of the file to open. You can then Paste the file into IconEdit.
|-
| Save Clip As || Saves the current contents in the Clipboard to a specified file.
|-
| Show Clip || Displays the current contents in the Clipboard using the MultiView program. If the MultiView program is unavailable, Show Clip cannot work.
|}

== Type Menu ==

The items in the Type menu let you specify the type of icon changed or created.

{| class="wikitable"
| Disk || Represents the disk icons appearing in the Workbench window.
|-
| Drawer || Represents the drawer icons appearing in a disk window, such as the Utilities or Tools drawer.
|-
| Tool || Represents a tool, such as the Calculator, Clock, or IconEdit program.
|-
| Project || Represents a project, a file that has been created by a tool, such as any of the icons in the drawers of the Storage directory.
|-
| Garbage || Represents the Trashcan drawer.
|}

== Highlight Menu ==

The items in the Highlight menu let you determine how an icon appears when it is selected.

{| class="wikitable"
| Complement || Highlights the entire icon, including the background of the box surrounding the icon. For example, if you are using the default Workbench colors and the icon is surrounding by a field of grey, the grey becomes blue when the icon is selected. This option is only available in old icons" mode.
|-
| Backfill || Highlights the icon, but not the background of the box. For example, if you are using the default Workbench colors and the icon is surrounded by a field of grey, the grey remains the same when the icon is selected. This option is also only available in old icon" mode.
|-
| Image || Allows an entirely different image for the selected icon (a dual image icon). For example, the drawer icons on the Workbench are dual image. When you select a drawer, a new image of an open drawer appears.
|}

== Images Menu ==

The items in the Images menu let you manipulate the images in the normal and selected view boxes and import IFF images created with other graphics programs.

{| class="wikitable"
| Exchange || Swaps the images that appear in the normal view and the selected view.
|-
| Copy || Copy is dependent on the selected radio button. If Normal is used, the image in the normal view is copied to the selected view. If Selected is used, the image in the selected view is copied to the normal view.
|-
| Use Template || Loads a template icon into the magnified view box on which you can use as the foundation for creating a new icon.
|-
| Darken || The icon's colors will be darkened.
|-
| Load || Loads previously saved images, without changing the name of the icon being edited. When you point to the Load menu item, a submenu (described below) appears.
|-
| Save Image || Saves an image as a standard IFF ILBM brush, rather than an icon.
|-
| Restore || Returns the IconEdit window to its state prior to opening the window or selecting New or Open.
|}

The available Load submenu items are:

{| class="wikitable"
| Image || Allows you to load an image data type file created by another program as either the normal or selected view, depending on which radio button is selected. When you choose an item from the submenu, a requester asks you to specify the file to be loaded. You must specify the correct drawer and file name.
|-
| Normal Image || Loads the unselected image of the specified icon into the normal or selected view box, depending on which radio button is selected. (This is equivalent to dragging an icon into one of the boxes.)
|-
| Selected Image || Loads the selected image of the specified icon into the normal or selected view box, depending on which radio button is selected.
|-
| Both Images || Loads both the normal and selected images of the specified icon into the appropriate view boxes.
|}

== Extras Menu ==

The items in the Extras menu control additional convenience features of IconEdit.

{| class="wikitable"
| Larger Sketchboard || Increases the drawing area IconEdit provides. Any existing elemens will retain their distance to the top and left edges of the sketchboard.
|-
| Smaller Sketchboard || Decreases the drawing area IconEdit provides, removing space from the bottom and the left of the sketchboard. If this would result in the image being truncated, IconEdit will ask for confirmation before cropping the image.
|-
| Minimal Sketchboard || Decreases the drawing area IconEdit provides, to the effect that all blank space to the right and bottom of the current image will be removed.
|-
| Auto TopLeft || Moves the image to the upper left corner of the magnified view box.
|-
| Add Glow || Automatically adds a glow effect to the icons, just like the standard OS3.5 icons have.
|-
| Borderless || If this menu item is active, the icon will be saved and displayed without a border, regardless of the global border settings from the Workbench preferences.
|}

== Settings Menu ==

The items in the Settings menu allow you to save various IconEdit options.

{| class="wikitable"
| Use Grid? || Use Grid? Displays each pixel in the magnified view box distinctly, with the background color surrounding it. When Use Grid? Is not chosen, the pixels blend together smoothly. The default is for the grid to be on.
|-
| Save Optimized? || Choosing this option will cause the transparency color to be assigned the color number zero (if possible) and remove all colors from the icon`s palette that are not actually used.
|-
| Create Icons? || Create Icons? Saves an icon for the IFF brush file created by the Save Image menu option. If Create Icons? Is not chosen, no icon is saved. The default is for icons to be saved.
|-
| Slider Color Model || This submenu controls whether the RGB or HSB color model will be used for the color sliders.
|-
| Save Settings || Save Settings saves all of the current IconEdit settings, including the size and position of the IconEdit window, the file requesters, and all of the menu item settings.
|}

== Tool Types ==

IconEdit supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| PUBSCREEN || Names the public screen on which IconEdit is supposed to open its window.
|-
| TEMPLATE || Path to the icons to be loaded when calling the Use Template" menu item.
|-
| HSB || Use the HSB color model for the color sliders.
|-
| OPTIMIZE || Optimize the icon palette when saving icons.
|-
| CLIPUNIT=<n> || Specifies the Clipboard unit to use. The default is 0.
|-
| XMAG=<n> || Enlarges the width of the magnified view box. XMAG accepts a number from 4 to 16. The default is 4.
|-
| YMAG=<n> || Enlarges the height of the magnified view box. YMAG accepts a number from 4 to 16. The default is 4.
|-
| LEFTEDGE=<n> || Specifies where to place the left edge of the editor window.
|-
| TOPEDGE=<n> || Specifies where to place the top edge of the editor window.
|-
| SHOWCLIP=<path> || Specifies the complete path to the utility used to display the Clipboard. The default is SYS:Utilities/MultiView.
|-
| NOICONS || Disable the ability to create icons when saving support files, such as when saving a file as an IFF brush.
|-
| NOGRID || Disables the use of the grid in the magnified view box.
|-
| ICONDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open and Save As menu items in the Project menu are chosen.
|-
| ILBMDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load and Save menu items in the Images menu are chosen.
|-
| CLIPDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Open Clip and Save As Clip menu items in the Edit menu are chosen.
|-
| ALTDRAWER=<path> || Specifies the default drawer used by the file requesters that appear when the Load menu item in the Images menu is chosen.
|}

= InitPrinter =

InitPrinter sends the printer options specified in the Printer Preferences and PrinterGfx Preferences editors to the printer. It initializes your printer and loads it with the new or changed specifications when you turn on the printer and double-click on the InitPrinter icon.

Your printer resets automatically when it receives and processes initialization information on first access during a session. If you turn the printer off, you might need to use InitPrinter to reinitialize it.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: INITPRINTER

; Template
: (none)

== ARexx Interface ==

InitPrinter has no ARexx interface.

= Installation Utility =

Missing description.

== Tool Types ==

== Shell Usage ==

== ARexx Interface ==

= Installer =

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
: INSTALLER <script> [<app name>] [<min user>] [<def user>] [<log file>] [<language>] [NOPRETEND] [NOLOG] [NOPRINT]

; Template
: SCRIPT/A,APPNAME,MINUSER,DEFUSER,LOGFILE,LANGUAGE,NOPRETEND/S,NOLOG/S,NOPRINT/S

== ARexx Interface ==

= KeyShow =

The KeyShow program shows the current keyboard type layout on your Amiga. Opening the KeyShow icon displays the keyboard layout as selected in the Input Preferences editor. The default American keyboard layout is illustrated in the figure below.

[[File:WorkbenchFig10-3.png|frame|left|Default KeyShow Window]]
<div style="clear: both"></div>

The initial display shows the characters that appear when a single key is pressed. For example, the Q key shows a lower case q. However, when you press a qualifier key with a character key, you can get different output. For KeyShow the acceptable qualifier keys are Ctrl, Shift and both Alt keys.

To see the characters that are output when a qualifier key is pressed simultaneously with a character key:

# Select any of the qualifier keys that appear in the KeyShow window. That qualifier key is highlighted.
# The KeyShow display changes to indicate the output that you get if you press the selected qualifier key along with a character key. You can select any combination of qualifiers and the display changes accordingly.
# Select the qualifier key again to return it to its unpressed state.

Keyboard shortcut: Instead of pointing to the qualifier key in the display, you can press the corresponding key on the keyboard. The following list is a guide to interpreting the KeyShow display:

* Qualifier keys not currently pressed are shown in the Workbench background color (normally grey). For example, when you first open the KeyShow window, Ctrl, Shift, and Alt appear in grey. This is because KeyShow is not using those keys in the initial display.
* Dead keys are shown in the Workbench highlight color (normally blue). A dead key is one that, in combination with an Alt key, modifies the output of the key pressed immediately afterward. For example, on the USA keyboard, the Alt+G combination is a dead key representing the grave accent. If you press Alt+G, then press E, you superimpose the accent symbol over the e (è).
* Bold-italics indicate that a key can be used in conjunction with a dead key. In the previous example, E can be modified by a dead key. However, not all bold-italic keys are affected by all dead keys. For example, n responds only to the Alt+J dead key. The final character must exist in the Amiga character set to be available through a dead key.
* $$ indicates that it takes more than one character to define the key.
* If a character is preceded by a tilde (~) or a caret (^), it is a control character.
* Blank keys are undefined for the currently selected qualifiers.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: KEYSHOW

; Template
: (none)

== ARexx Interface ==

KeyShow has no ARexx interface.

= MEmacs =

MEmacs (MicroEmacs) is a screen-oriented text editor. A text editor works the same as a word processor, but it does not support style formatting options. MEmacs is described in detail in the AmigaDOS User's Guide .

= MultiView =

MultiView lets you view files, including picture files, text files, AmigaGuide help files, sound files, and animated graphics files. It can display any type of file for which there is a data type file in DEVS:DataTypes. For more information on the data types used by MultiView, see page 4-28.

MultiView uses a standard file requester for loading files. You can load files into MultiView using the file requester provided or, because the MultiView window is an AppWindow, you can drag icons onto MultiView to load them.

When you loaded a standard Amiga sampled sound file into MultiView, clicking on the file's icon plays the sampled sound if your Amiga or monitor has speakers.

When you load an animated file into MultiView, the window or screen on which the animation is displayed has a control panel for manipulating the display. The control panel gadgets allow you to start and stop the animation and move forward or backward through it. This screen is illustrated in the figure below.

[[File:WorkbenchFig4-6.png|frame|left|MultiView with Animation Control Panel]]
<div style="clear: both"></div>

MultiView has four menus: Project, Edit, Windows, and Settings.

== Project Menu ==

{| class="wikitable"
| Open || Brings up a file requester to allow you to choose another file to display.
|-
| Save As || Saves object as ILBM or text files.
|-
| Print || Prints selected blocks or files.
|-
| About || Shows the MultiView release information and the type of document being viewed.
|-
| Quit || Quits MultiView.
|}

== Edit Menu ==

{| class="wikitable"
| Mark || Turns on the block selection cursor and lets you select a block. (This is only available for picture files.)
|-
| Copy || Copies selected block to the Clipboard and deselects the block. If no block is selected, copies the whole file.
|-
| Select All || Selects the whole file.
|-
| Clear Selected || Clears the selected block or file without copying or printing.
|}

== Windows Menu ==

{| class="wikitable"
| Use Separate Screen || Toggles between displaying the file on its own screen and in a window on the Workbench screen.
|-
| Minimize || Make the window as small as it can be.
|-
| Normal || Sizes the window to the contents size.
|-
| Maximize || Makes the window the same size as the screen.
|}

== Settings Menu ==

{| class="wikitable"
| Save As Defaults || Saves the size, position, and location of the window for future use.
|}

== Tool Types ==

MultiView supports the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| CLIPBOARD || View The Clipboard instead of the file.
|-
| CLIPUNIT=<number> || Specify the Clipboard unit to use when using the CLIPBOARD keyword. The range is 0 to 255; the default is 0.
|-
| SCREEN || Indicate that you want the object to appear on its own screen, using the environment specified by the object. For example, if an ILBM was Low Res, then the screen would match.
|-
| PUBSCREEN=<name> || Indicate that you want the window to open on the named public screen.
|-
| FONTNAME=<name> || Font to use when viewing text objects. Note that the .font extension must be left off.
|-
| FONTSIZE=<number> || Font size to use when viewing text objects.
|-
| BOOKMARK || Go to the object and position specified by the bookmark.
|-
| BACKDROP || Indicate that the window should be a backdrop window.
|-
| WINDOW || Open the MultiView window on the Workbench screen without an object so that items can be dragged into it.
|-
| PORTNAME=<ARexx port name> || Allows you to specify an ARexx port name when you run MultiView. This name allows you to refer to a particular MultiView display from within an ARexx script. If no name is specified, each MultiView invocation is given a default name.
|}

For more information on using MultiView with ARexx, see the [[AmigaOS_Manual:_AmigaDOS|AmigaDOS User's Guide]].

== ARexx Interface ==

Missing description.

= NotePad =

Missing description.

== NotePad Menus ==

Missing description.

= PartitionWizard =

Missing description.

== PartitionWizard Menus ==

Missing description.

= PlayCD =

PlayCD acts as a user interface for the audio CD playback functionality offered by a CD-ROM drive. The CD-ROM drive in question must comply to the SCSI-2 standard and thus support at least a subset of the audio control commands defined for CD-ROM drives.

== Starting the program ==

When the program is launched, it will attempt to configure itself. This involves figuring out which device driver and which device unit to use for audio playback. This information is usually stored in the program's icon, but it can also provided on the command line. The names of the command line options and the tool types are the same. The following options are supported:

; DOSDEV
: If there already is a filing system mounted on the CD-ROM drive to use for audio playback, the easiest way to tell PlayCD which device it should use is to provide that filing system's name. PlayCD will try to figure out which device and unit that filing system is bound to and use the resulting information.
: Example:
PlayCD CD0:
PlayCD dosdev CD2:

{{Note|That this type of configuration may not work with all CD-ROM filing systems.}}

; DEVICE
: Use this option to provide the name of the device driver the CD-ROM drive to use for playback responds to.

: Example:
PlayCD device=scsi.device

: Default for this option is "scsi.device" .

; UNIT
: This option works in conjunction with the "DEVICE" parameter. Both the device name and the unit number specified define the interface the PlayCD program should use to address the CD-ROM drive.

: Example:
PlayCD unit=5

: Default for this option is "2".

; SKIP
: The PlayCD user interface sports a slider which controls and displays the current play index. Attached to this slider are two buttons which perform fast forward" and rewind" functionality. Pressign any of these two buttons will cause playback to skip a few seconds. The SKIP" option is for configuring the number of seconds to skip.

: Example:
PlayCD skip=2

: Default for this option is 1", i.e. clicking on the buttons will skip one second each.

; PEEKTIME
: PlayCD queries the CD-ROM drive in regular intervals to find out whether the CD was changed or how far playback has progressed. The length of these intervals is configured with the PEEKTIME" option. The peek time is specified in microseconds, i.e. one millionth part of a second.

: Example:
PlayCD peektime=500000

: Default for this option is 200000", i.e. one fifth of a second.

; PUBSCREEN
: PlayCD can be made to open its display on a named public screen. If the named screen does not exist, it will fall back to opening its display on the default public screen, such as the Workbench screen.

: Example:
PlayCD pubscreen=my.public.screen

: There is no default for this option. Default behaviour for PlayCD is to open its display on the default public screen which in most cases will be the Workbench screen.

; BUFMEMTYPE
: PlayCD depends upon the controller hardware the CD-ROM drive is attached to to deliver its commands properly. This may sometimes require that the command data structures are passed in a particular type of memory which the controller hardware has easy access to. In most cases you will not need to change this option, but if the CD-ROM drive is correctly configured, does support the SCSI-2 command set and still does not react to PlayCD`s commands, then it might be necessary to specify a different buffer memory type.

: Example:
PlayCD bufmemtype=2
PlayCD bufmemtype=512

: Default for this option is 0", which specifies no particular type of memory to use for interacting with the controller hardware.

== The user interface ==

If properly configured, PlayCD will open a window which contains the following controls (left to right):

{| class="wikitable"
| Track display || Here you will find information about the current audio track and the playback status. The first line displays the track information, the second line indicates how much time has passed with regard to length of the current track and the entire CD.
|-
| Track position (below the track display) || This slider displays the current track position. It can also be used to change the current track position.
| [Shift]+[Cursor left] and [Shift]+[Cursor right] keys
|-
| Track selection || This is a set of 32 buttons, each one corresponding to one of the tracks of the audio CD. Click a button to make the corresponding audio track the current track. If playback is currently in progress, playback will proceed with the selected track.
| Any number entered, e.g. entering the two digits 1 and 2 in quick succession will pick track 12.
|-
| Volume
| This is a vertical slider whose current setting corresponds to the sound playback volume. At the top position, playback volume is loudest.
| + and - keys
|-
| Eject (below the Track position slider)
| Press this button to eject/load the CD in the drive. For technical reasons, you may need to press this button more than once to load a CD.
| [F1] and [Backspace] keys
|-
| Stop
| Press this button to stop playback.
| [F2] and [Cursor up] keys.
|-
| Pause
| Press this button to suspend/resume playback.
| [F3] and [Space] keys
|-
| Previous track
| Press this button to skip back to the beginning of the previous track.
| [F4] and [Cursor left] keys
|-
| Play
| Press this button to begin playback.
| [F5] and [Cursor down] keys
|-
| Next track
| Press this button to skip forward to the beginning of the next track.
| [F6] and [Cursor right] keys
|-
| Shuffle
| Press this button to set up a play list which contains all CD titles in random order. Playback will step through this list, playing each title once. To return to the regular play list which plays each title in the order the tracks were recorded in, press the Stop" button.
| [F7] key
|-
| Playback mode
| This button selects a playback mode; it can be one of the following:
{| class="wikitable"
| Continue
| This is the default playback mode. If you pick a track to play, it will be played along with all tracks to follow it until the last track on the CD is played. Clicking one of the track buttons in the track selection table will make the respective track the current track".
|-
| Program
| In this mode every track number entered or clicked on will cause a new entry to be added to the play list. To play back the list, click the Play" button.
|-
| Track
| In this mode playback will be restricted to the currently selected track. This means, for example, that if a track has been played to the end, playback will stop instead of proceeding to the next track.
| [F8] key
|-
| Repeat
| This switch controls whether playback will stop when the end of the play list has been reached or whether playback will restart with the first list entry.
| [F9] key
|}
|-
| Message list (below the Eject button)
| This is where helpful progress reports and error messages are displayed. For example, if you picked a track by entering its number, you will see a notice confirming your input.
|}

== Stopping the program ==

Once the PlayCD program is running, you can stop it by clicking on the window close gadget or by one of the keyboard equivalents [Esc] or [Ctrl]+\.

= PrefsObjectsEditor =

Missing description.

== PrefsObjectsEditor Menus ==

Missing description.

= PrintFiles =

PrintFiles sends text files to your printer. It can accept multiple files selected with drag selection or extended selection. If PrintFiles cannot find or open one of the files, it skips it and goes to the next one. The files are printed using the settings specified in the Printer or PrinterPS Preferences editor.

To use PrintFiles:

# Select the icon of the first file to be printed, hold down Shift and select the icons of any additional files to print. You can also use drag selection to select the icons.
# Hold down Shift and double-click on the PrintFiles icon.

== Tool Types ==

No tool types.

== Shell Usage ==

; Format
: PRINTFILES <file> [[<file>] [<file>] ...]

; Template
: FILES/A/M

== ARexx Interface ==

PrintFiles has no ARexx interface.

= RawDisk =

RawDisk reads or writes a given number of cylinders or blocks to or from a disk, transferring the data to or from a named file. The data is read or written in raw format, i.e. the disk filesystem (if any) is ignored and data is addressed absolutely.

[[File:WorkbenchUtilitiesFigRawDisk.png|frame|left|RawDisk Window]]
<div style="clear: both"></div>

The utility can be used on any disk present in the DOS List, i.e. mounted. It can be run from Workbench by clicking the icon or from a Shell.

Disk data can be addressed by cylinders or blocks, as start + number. When reading from disk to a file, the file can be written as pure binary, hexadecimal longwords, or hexadecimal bytes. When writing from file to disk, only binary input is supported.

== Tool Types ==

(none)

== Shell Usage ==

; Format
: RAWDISK FROM <source> TO <target> [STARTCYLS <first cylinder>] [NUMCYLS <cylinders>]
:: [STARTBLOCK <first block>] [NUMBLOCKS <blocks>] [MODE <output mode>] [QUIET]

; Template
: FROM/K/A,TO/K/A,SC=STARTCYL/N,NC=NUMCYLS/N,SB=STARTBLOCK/N,NB=NUMBLOCKS/N,MODE/K,QUIET/S

{| class="wikitable"
! style="text-align:left;"| Parameter
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| FROM || The source device or filename. This parameter is required.
|- style="vertical-align: top;"
| TO || The destination disk or filename. This parameter os required.
|- style="vertical-align: top;"
| SC or STARTCYL || The first cylinder on the disk to be read or write. If omitted, the first cylinder on the disk will be used. If the disk has space reserved for boot blocks and filesystems, or has multiple partitions, this value might not be zero.
|- style="vertical-align: top;"
| NC or NUMCYLS || The number of cylinders to transfer. If omitted, a number of cylinders reaching from the start cylinder to the and of the disk will be assumed. If writing to disk and the input file is too small, the transfer will be zero-filled. If writing to disk and the file is too big, only part of its contents will be written to the disk.
|- style="vertical-align: top;"
| SB or STARTBLOCK || The first block to be transferred. This is simply a means of specifying a start address with smaller granularity than whole cylinders. See STARTCYL.
|- style="vertical-align: top;"
| NB or NUMBLOCKS || The number of blocks to be transferred. This is simply a means of specifying a data length with smaller granularity than whole cylinders.
|- style="vertical-align: top;"
| MODE || This specifies the mode of output file (if used). The options are BIN, HEXB, and HEXL. Option BIN (binary) is the default. Option HEXB writes the data in human-readable form, as strings of hexadecimal bytes followed by the printed string (if printable). Option HEXL prints the data as strings of longwords followed by the printed string.
|- style="vertical-align: top;"
| QUIET || Suppresses warning messages to Shell.
|}
== ARexx Interface ==

RawDisk has no ARexx interface.

= Say =

With Say, Amiga can speak words typed on the screen. If the Say icon is not present, you do not have speech synthesis on your system. When you open Say, two windows appear.

[[File:WorkbenchUtilitiesFigSay.png|frame|left|Say Windows]]
<div style="clear: both"></div>

The top window is the '''Phoneme window''', and the bottom window is the '''Input window'''. You enter text in the '''Input window''', and the text is displayed phonetically in the '''Phoneme window''' and spoken through Amiga's audio system.

; To use Say

: 1. Select the '''Input window''' and type a word, phrase, or sentence.

: 2. After you have entered your text, press '''Return'''. Amiga will then literally say the sentence, while at the same time the text will appear in the '''Phoneme window'''. This is the phonetic interpretation of your input.

In some cases, it may help to spell a word phonetically (as it sounds) to get Amiga to repeat it correctly. You can change the voice, pitch, and speed of your Amiga's speech by choosing any of the different options shown in the '''Phoneme window'''.

: 3. Select the '''Input window'''.

: 4. Type the letter, or letters, necessary to make your changes.
:: Your choices for voice and inflection are:
::: '''-m''' male voice
::: '''-f''' female voice
::: '''-r''' robot inflection
::: '''-n''' natural inflection
::
:: When you change the voice, you can also change the pitch so the change in the new voice is noticeable.
::
:: Type '''-p''' followed by a number from 65 through 320. The higher the number, the higher the voice's pitch. Do not put a space between the p and the number.
::
:: To change the speed of the voice, type '''-s''' followed by a number from 40 through 400. The higher the number, the faster the voice speaks. Do not put a space between the s and the number.

: 5. Press '''Return'''.

For example, to use a deep male voice with natural inflection that speaks at a moderate pace, select the '''Input window''' and type:

: -mn -s125 -p65

Then press '''Return'''. Remember that the hyphen must be typed before the alphabetical option. Next, enter some text. When you press '''Return''', the Say program will speak your text using the new options.

To exit the Say program, select the '''Input window''''s close gadget. You can also select the '''Input window''' and press '''Return''' without entering any text. Either of these actions will close both the '''Input''' and '''Phoneme windows'''.

== Tool Types ==

Say supports Tool Types for all the voice, pitch, and speed options. Instead of entering the options in the '''Input window''', you can add them in the Say's Information window. This saves your selections so that they do not have to be re-entered each time you open Say. The Tool Types are:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| -m || Select a male voice
|-
| -f || Select a female voice
|-
| -r || Use robot inflection
|-
| -n || Use natural inflection
|-
| -p<pitch> || Set the pitch. A valid pitch range is between 65 and 320. The highest pitch is 320.
|-
| -s<speed> || Set the speed. A valid speed range is between 40 and 400. The fastest speed is 400.
|}

When you run Say, the options entered as Tool Types will be used, unless you specify other options in the Input window.

== Shell Usage ==

; Format
: SAY [-m] [-f] [-r] [-n] [-s <speed>] [-p <pitch>] [-x <filename>] [<phrase>]

; Template
: [-m] [-f] [-r] [-n] [-s speed] [-p pitch] [-x filename] [phrase]

== ARexx Interface ==

Say has no ARexx interface.

= ShowConfig =

ShowConfig displays system configuration information, including processor information, custom chips, software versions, RAM information, and any plug-in boards. Double-click on the ShowConfig icon to display the information for your system. use this information when requesting hardware/software technical support.

[[File:WorkbenchFig10-5.png|frame|left|ShowConfig Window]]
<div style="clear: both"></div>

== Tool Types ==

ShowConfig has no Tool Types.

== Shell Usage ==

; Format
: SHOWCONFIG [DEBUG]

; Template
: DEBUG/S

== ARexx Interface ==

ShowConfig has no ARexx interface.

= UnArc =

Missing description.

== UnArc Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

UnArc has no ARexx interface.

= USBInspector =

Missing description.

== USBInspector Menus ==

Missing description.

== Tool Types ==

== Shell Usage ==

; Format
:

; Template
:

== ARexx Interface ==

USBInspector has no ARexx interface.

= Blankers Drawer =

Missing description.

== BoingBall.blanker ==

Missing description.

== Flower.blanker ==

Missing description.

== Forest.blanker ==

Missing description.

== Moire.blanker ==

Missing description.

== Pipe.blanker ==

Missing description.

== Spiral.blanker ==

Missing description.

= Commodities Drawer =

The Commodities drawer is in the Tools drawer and contains the Commodities Exchange programs. These programs monitor your keyboard and mouse input to the Amiga.

[[File:WorkbenchFig10-6.png|frame|left|Commodities Window]]
<div style="clear: both"></div>

{| class="wikitable"
| AmiDock || A toolbar-like application launcher.
|-
| AsyncWB || Replaces Workbench's file execution window.
|-
| AutoBorderSize || Allows you to size windows at any border.
|-
| AutoInfo || Displays information about the icon under the pointer.
|-
| AutoPoint || Automatically activates the window under the pointer.
|-
| ClickToFront || Lets you bring a window to the front of the screen by double-clicking in it.
|-
| ContextMenus || Adds context menus to Workbench.
|-
| CrossDOS || Controls text options for CrossDOS drives. See Chapter 11 for more information.
|-
| DefIcons || Adds default icon functionality to Workbench.
|-
| DepthToFront ||
|-
| Exchange || Monitors and controls all the other Commodities programs.
|-
| FKey || Assigns special functions to keys.
|-
| MouseBlanker || Causes the mouse pointer to go blank when you are typing.
|-
| NoCapsLock || Temporarily disables the Caps Lock key.
|-
| RAWBInfo || Replaces Workbench's icon information window.
|-
| ScreenBlankerEngine || Controls screen blanker.
|}

== Using Commodities Tool Types ==

All of the Commodities programs share a common Tool Type:

; CX_PRIORITY=<n>
: Assigns priorities to the Commodities Exchange programs.

All the programs are set to a default priority of 0. If you enter a Tool Type that changes the priority to a higher value, that program has priority over any other Commodities Exchange program of lower priority.

For example, you can have two commodities that allow you to assign operations to functions keys. If both programs have an operation assigned to F1, the program with the higher priority intercepts the key, making it unavailable to any other Commodities programs.

There are two Tool Types that apply only to programs that open a window:

; CX_POPUP
: When set to NO, prevents the program window from opening when the icon is opened. The program activates when you double-click on its icon, but its window remains closed. The default is CX_POPUP=YES.

; CX_POPKEY
: Determines the hot key for a commodity. When the hot key or key combination is pressed, the program's window is automatically brought to the front of the screen. If the window is hidden, it is opened. Hot keys do not start commodities that are not already running. The syntax for specifying hot keys is CX_POPUP=<key>.

When specifying key combinations, leave a space between the two keys. For example:

CX_POPKEY=F9
CX_POPKEY=Shift F4
CX_POPKEY=LShift LAlt LAmiga X

== Acceptable Key Combinations ==

When specifying key combinations for a Commodities Exchange program, you can use any of the function keys (F1 through F10) and any of the keys in the typewriter area of the keyboard (numbers, letter, symbols, and so forth). Keys from the typewriter area must be preceded by a qualifier. The allowable qualifiers are:

{| class="wikitable"
! Qualifier !! Key
|-
| Alt || Either Alt key
|-
| Ralt || Right Alt only
|-
| LAlt || Left Alt only
|-
| Shift || Either Shift key
|-
| Rshift || Right Shift only
|-
| LShift || Left Shift only
|-
| LAmiga || Left Amiga
|-
| RAmiga || Right Amiga
|-
| CTRL || Ctrl
|-
| Numericpad || Specifies a key on the numeric keypad
|-
| Rightbutton || Hold down the menu button
|-
| Leftbutton || Hold down the selection button
|-
| Middlebutton || Hold down the middle button of a three-button mouse
|}

Qualifiers can also be used before function keys, but are not mandatory. You can use any combination of qualifiers; however, they must be followed by a standard key or function key. A qualifier is only recognized once in a combination:

LAlt RAmiga LAlt F10

is the same as

LAlt RAmiga F10

The following are acceptable combinations:

Alt F6
LAmiga 8
Ctrl LShift Y
Leftbutton Ctrl CapsLock*
Numericpad 8**

* Hold down the selection button, then press Ctrl+Caps Lock

** Use the 8 in the numeric keypad. The 8 in the normal area does not satisfy the combination.

== AmiDock ==

Missing description.

=== AmiDock Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===
AmiDock upports the following ARexx commands:
{| class="wikitable"
! style="text-align:left;"| Command
! style="text-align:left;"| Description
|- style="vertical-align: top;"
|- style="vertical-align:top;"
| '''ADDOBJECT''' FILE/A,NAME/K,ICON/K,DOCKNAME/K|| This command adds a new object to an AmiDock dock. Optionally the displayed name and icon can be specified and also the name of an existant dock or subdock. The object will '''always''' be added to the main category of the given dock.

FILE specifies a path to the object which shall be added, NAME is the display name of the object, ICON is a path to the icon which shall be used for the object, and DOCKNAME tells the name of the dock to which the object shall be added. If the DOCKNAME is omitted, the object will be added to the main dock.

In case of an error, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text. On success RC is set to 0.
|- style="vertical-align:top;"
| '''ADDSUBDOCK''' NAME/A,ICON/K|| Adds a SubDock.docky with a given name and an optional icon to the main category of the main dock. NAME is the name of the new subdock which will be displayed on the dock. ICON is a path to the icon which shall be used for the new dock.

If the command is successful, variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. Otherwise [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''FAULT''' NUMBER/A/N|| Gives the user the text message assigned to a given error number.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0 and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the requested error message. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the following string: ERROR_OBJECT_NOT_FOUND
|- style="vertical-align:top;"
| '''HELP''' COMMAND/K|| Returns the command template of the named command. If the COMMAND parameter is not supplied, HELP lists all the supported commands.

On success variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to 0. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''OPEN''' FILE || Loads the given AmiDock XML preferences file. Beware that loading a faulty settings may lead to a bunch of error requesters of AmiDock, like not found icons. If you omit the file name, AmiDock will load its default preferences from '''ENVARC:'''.

On success command returns 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]]. In case of an error, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and variable [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.

Note that if the user has turned on the 'autosaving' feature, the opened configuration may automatically get saved as default. Therefore it would be wise to reload the default settings at the end of your script, as long as the user did not specifically tell to save the settings as default.
|- style="vertical-align:top;"
| '''QUIT''' || Tells AmiDock to quit.

Note that there is '''no''' guarantee that AmiDock will really exit after receiving the QUIT command due to a lot other things which may prevent this. Likewise AmiDock might need some time until it finally quits. So make sure you check for the (non-)existence of its ARexx port instead of simply assuming the QUIT command was successful.
|- style="vertical-align:top;"
| '''RX''' CONSOLE/S,ASYNC/S,COMMAND/F|| Allows the user to start an ARexx macro through the AmiDock ARexx port. The CONSOLE switch indicates that a console for a default I/O is needed, ASYNC instructs AmiDock to run the RX command asynchronously, and the COMMAND parameter should contain the macro commands to be executed.

If the command was successful, [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] variable contains 0. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|- style="vertical-align:top;"
| '''SAVE''' || Sets the current preferences as AmiDock's default preferences.
|- style="vertical-align:top;"
| '''SAVEAS''' NAME/A || Saves the current preferences to a specified file. NAME should contain the name and the path where the current AmiDock configuration will be saved.

The SAVEAS command will return 0 in variable [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] on success. On error [[AmigaOS_Manual:_ARexx_Special_Variables|RC]] is set to non-zero and the [[AmigaOS_Manual:_ARexx_Special_Variables|RESULT]] variable contains the corresponding DOS error code. The FAULT command may be used to gather a descriptive error text.
|}

== AsyncWB ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AsyncWB has no ARexx interface.

== AutoBorderSize ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoBorderSize has no ARexx interface.

== AutoInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoInfo has no ARexx interface.

== AutoPoint ==

AutoPoint lets you select windows without clocking the selection button. To start AutoPoint, double-click on ist icon. AutoPoint does not open a window.

AutoPoint automatically activates the window that is underneath the pointer, eliminating the need to click the selection button.

To disable AutoPoint, double-click on its icon a second time or open the Exchange window, select AutoPoint from the scroll gadget, and the select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

AutoPoint has no ARexx interface.

== Blanker ==

This commodity is obsolete!

When the Blanker program is running, the screen automatically goes blank if no input has been received during a specified period of time.

The Blanker window allows you to specify the amount of time (in seconds) before the screen goes blank. The default time is 60 seconds. If you do not press a key or move the mouse during a 60 second period, the screen goes blank. To change this value, enter an alternative in the text gadget after Seconds.

Blanker can also cycle through a series of colors if you check the Cycle Colors gadget box. Checking the Animation gadget displays a random spline display.

To disable Blanker, open the Exchange window, then select Blanker, select Remove, or pick the Quit item from the Blanker window's Project menu. The hot key for Blanker is Ctrl+Alt+B.

=== Tool Types ===

Blanker has the following Tool Types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| SECONDS=<seconds> || The number of seconds of keyboard/mouse activity before the screen is blanked. Default is 60.
|-
| ANIMATION=YES<nowiki>|</nowiki>NO || Whether Blanker screen displays animation. Default is yes.
|-
| CYCLECOLORS=YES<nowiki>|</nowiki>NO || Whether colors on the blanker screen are cycled. Default is yes.
|}

== ClickToFront ==

ClickToFront lets you bring a window to the front of the screen without selecting the window's depth gadget. To bring a window to the front with ClickToFront, hold down left Alt and double-click anywhere in the window. (The use of left Alt can be changed with Tool Types.)

To start ClickToFront, double-click on its icon. ClickToFront does not open a window.

To disable ClickToFront, open the Exchange window, select ClickToFront from the scroll gadget, then select Remove or double-click on its icon again.

=== Tool Types ===

ClickToFront supports a QUALIFIER Tool Type, allowing you to specify a qualifier key that must be pressed while double-clicking in the window you want to bring to the front of the screen. The four acceptable key arguments are:

{| class="wikitable"
| Lalt || Left Alt (Default)
|-
| Left_Alt || Left Alt
|-
| Ralt || Right Alt
|-
| Right_Alt || Right Alt
|-
| CTRL || Ctrl
|-
| CONTROL || Ctrl
|-
| None || No qualifier necessary
|}

For example, if you have specified QUALIFIER=CTRL and ClickToFront is activated, hold down Crtl and double-click in the window you want frontmost.

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ClickToFront has no ARexx interface.

== ContextMenus ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ContextMenus has no ARexx interface.

== CrossDOS ==

The CrossDOS commodity controls text options for active CrossDOS drives. The CrossDOS commodity window shows the available drives and allows you to set Text Filtering or Text Translation separately for each Hot key: Ctrl+Alt+C. For more information on the CrossDOS commodity, see Chapter 11.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

CrossDOS has no ARexx interface.

== DefIcons ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DefIcons has no ARexx interface.

== DepthToFront ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

DepthToFront has no ARexx interface.

== Exchange ==

Exchange manages the background utilities contained in the Commodities drawer. The hot key for Exchange is Ctrl+Alt+Help.

[[File:WorkbenchFig10-7.png|frame|left|Exchange Window]]
<div style="clear: both"></div>

The Exchange window lists the commodities that are running and displays information about each one as it is selected.

{| class="wikitable"
| Remove || Turns off commodities.
|-
| Show Interface || Displays the commodity window, allowing you to interact with it as if you pressed the commodity's hot key.
|-
| Hide Interface || Closes the commodity window without turning the commodity off.
|}

=== Exchange Menus ===

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

Exchange has no ARexx interface.

== FKey ==

FKey allows you to assign functions to keys, eliminating the need for repetitive typing.

When you double-click on the FKey icon, the following window appears:

[[File:WorkbenchFig10-8.png|frame|left|FKey Window]]
<div style="clear: both"></div>

FKey lets you assign any of eight commands to any key sequence that you can enter.

The Defined Keys scrolling list shows all the currently defined key sequences.

The New Key and Delete Key gadgets let you add and remove key sequences.

The Command cycle gadget lets you pick a command for the current key sequence. The possible commands are:

{| class="wikitable"
| Cycle Windows || Brings the rearmost application window on the Workbench screen to the front of the display and selects it.
|-
| Cycle Screens || Brings the rearmost screen to the front of the display.
|-
| Enlarge Window || Enlarges the selected window to its maximum size, taking into account the edges of the screen.
|-
| Shrink Window || Shrinks the selected window to its minimum size.
|-
| Toggle Window Size || Zooms the selected window as if you had selected its zoom gadget. It also works on windows that only have a zoom gadget and no sizing gadgets.
|-
| Insert Text || When the key sequence is entered, the specified string is inserted in a console window or text gadget. It has no effect if something that accepts keyboard input is not selected. The string to insert is specified in the Command Parameters gadget.
|-
| Run Program || Lets you run a program by entering any key sequence. The program name and its arguments are specified in the Command Parameters gadget.
|-
| Run ARexx Script || Lets you run an ARexx script by entering any key sequence. The script name and its arguments are specified in the Command Parameters gadget. Putting quotes around the script name turns it into an ARexx string file.
|}

The Command Parameters text gadget lets you specify arguments for three of the commands.

For example, to designate Alt F1 as the key sequence to start MultiView, follow these steps:

# Select the New Key gadget.
# Enter the key sequence in the string gadget as Alt F1 (be sure to enter a space between Alt and F1).
# Select the Run Program option in the Command cycle gadget.
# Enter the path for MultiView (SYS:Utilities/MultiView) in the Command Parameters text gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

FKey has no ARexx interface.

== MouseBlanker ==

MouseBlanker blanks the mouse pointer from the display when you are typing at the keyboard. The mouse pointer returns to the screen when you move the mouse again.

To enable MouseBlanker, double-click on its icon. To disable MouseBlanker, double-click on its icon again or open the Exchange window, select MouseBlanker from the scroll gadget, and select the Remove gadget.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

MouseBlanker has no ARexx interface.

== NoCapsLock ==

NoCapsLock disables the Caps Lock key. The Shift keys still function normally, but Chaps Lock has no effect if pressed accidentally.

To start NoCapsLock, double-click on its icon. It does not open a window. To disable NoCapsLock, open the Exchange window, select NoCapsLock from the scroll gadget, and select the Remove gadget or double-click on its icon again.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

NoCapsLock has no ARexx interface.

== RAWBInfo ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

RAWBInfo has no ARexx interface.

== ScreenBlankerEngine ==

Missing description.

=== Tool Types ===

=== Shell Usage ===

; Format
:

; Template
:

=== ARexx Interface ===

ScreenBlankerEngine has no ARexx interface.

= Dockies Drawer =

Missing description.

== Access.docky ==

Missing description.

== Anim.docky ==

Missing description.

== Button.docky ==

Missing description.

== Clock.docky ==

Missing description.

== Debugger.docky ==

Missing description.

== Fancy.docky ==

Missing description.

== Lens.docky ==

Missing description.

== Minimizer.docky ==

Missing description.

== Online.docky ==

Missing description.

== Rainbow.docky ==

Missing description.

== Separator.docky ==

Missing description.

== Spacer.docky ==

Missing description.

== SubDock.docky ==

Missing description.

== Test.docky ==

Missing description.

AmigaOS Manual: Python Instructions

2022-08-28T07:33:39Z

Janne Peräaho: Created chapter outline

= Syntax =

= Alphabetical Reference =

== assert ==
== break ==
== class ==
== continue ==
== def ==
== del ==
== exec ==
== for ==
== global ==
== if ==
== import ==
== in ==
== lambda ==
== pass ==
== print ==
== raise ==
== return ==
== try ==
== while ==
== with ==
== yield ==

AmigaOS Manual: Python

2022-08-28T07:18:55Z

Janne Peräaho: Added chapter 4: Instructions

{{WIP}}
= Welcome =

Python is a high-level, object-oriented general purpose programming language created by Guido van Rossum. It includes a large standard library containing standardized solutions for the common programming problems and tools for accessing the system resources. On Amiga, Python can replace [[AmigaOS Manual: ARexx|ARexx]] as a scripting language.

This manual introduces you to Python, tells you how to create Python programs and provides a reference section of Python commands.

[[AmigaOS Manual: Python Introducing Python|Chapter 1. Introducing Python]] This chapter gives an overview of Python, how it works on the Amiga, and the basic features of the programming language.

[[AmigaOS Manual: Python Getting Started|Chapter 2. Getting Started]]

[[AmigaOS Manual: Python Elements of Python|Chapter 3. Elements of Python]]

[[AmigaOS Manual: Python Instructions|Chapter 4. Instructions]]

[[AmigaOS Manual: Python Functions|Chapter 5. Functions]] This chapter describes the use of functions and provides an alphabetical listing of the built-in Python functions.

[[AmigaOS Manual: Python Methods|Chapter 6. Methods]] This chapter provides a listing of the built-in Python methods.

[[AmigaOS Manual: Python Modules and Packages|Chapter 7. Modules and Packages]]

[[AmigaOS Manual: Python Classes and Objects|Chapter 8. Classes and Objects]] This chapter explains how to use Python's object-oriented features.

[[AmigaOS Manual: Python Debugging|Chapter 9. Debugging]]

[[AmigaOS Manual: Python Parsing|Chapter 10. Parsing]] This chapter explains how to break up strings and files into more easily processed components.

[[AmigaOS Manual: Python Sounds|Chapter 11. Sounds]] This chapter explains how to record and play sounds.

[[AmigaOS Manual: Python Printing|Chapter 12. Printing]] This chapter explains how to print.

[[AmigaOS Manual: Python Serial and parallel ports|Chapter 13. Serial and parallel ports]] This chapter explains how to receive and send data through the serial and parallel ports.

[[AmigaOS Manual: Python Network resources|Chapter 14. Network resources]] This chapter explains how you can connect to a remote server and exchange data with it.

[[AmigaOS Manual: Python Graphical User Interfaces|Chapter 15. Graphical User Interfaces]] This chapter explains how to create graphical user interfaces with Python.

[[AmigaOS Manual: Python Interprocess communication through ARexx ports|Chapter 16. Interprocess communication through ARexx ports]]

[[AmigaOS Manual: Reserved Python Words|Appendix: A. Reserved Python Words]] This appendix lists Python keywords.

[[AmigaOS Manual: Python Escape Characters|Appendix: B. Python Escape Characters]] This appendix lists Python escape characters.

[[AmigaOS Manual: Standard Exceptions|Appendix: C. Standard Exceptions]] This appendix lists the standard Python exceptions.

[[AmigaOS Manual: Built-in Constants|Appendix: D. Built-in Constants]] This appendix lists the Python's built-in constants.

[[AmigaOS Manual: Environment Variables|Appendix: E. Environment Variables]] This appendix lists the Python environment variables.

[[AmigaOS Manual: Python Glossary|Glossary]] The glossary contains common Python terms.

= Document Conventions =

The following conventions are used in this manual:

; [ ] (brackets)
: Optional instruction parts are enclosed in brackets.

; <n>
: Variables are displayed in angle brackets. Do not enter the angle brackets when entering the variable.

; Courier
: Text appearing in the Courier font represents output from your Python programs or other information that displays on your screen.

= Sources of Additional Information =

Further information on learning and using Python can be found in:

[https://docs.python.org/2.7/ Python 2.7.15 Documentation], by Python Software Foundation.

AmigaOS Manual: Reserved Python Words

2022-08-21T10:26:31Z

Janne Peräaho: Added keyword descriptions

Python has 34 keywords that have a predefined meaning and thus they cannot be used as a variable name. The keywords are:

{| class="wikitable"
! style="text-align:left;" | Keyword
! style="text-align:left;" | Description
|-
| and || A logical operator
|-
| as || Creates an alias
|-
| assert || Used for debugging. Raises an AssertionError exception with a specified error message if the supplied condition is False.
|-
| break || Exits loop
|-
| class || Defines a class
|-
| continue || Terminates the current loop iteration and begins the next one
|-
| def || Defines a function
|-
| del || Deletes an object
|-
| elif || A short for "else if"
|-
| else || Defines actions that are executed when if condition is False. See if. When used with exception handler, defines actions that are executed when there there was no error. See try.
|-
| except || Defines an error handler for an exception handler. See try.
|-
| exec || Executes the supplied Python code
|-
| False || A boolean value
|-
| finally || Defines actions for exception handler that are executed always. See try.
|-
| for || Creates a for loop
|-
| from || Imports a part of a module
|-
| global || Declares a global variable
|-
| if || Defines actions that are executed when if condition is True.
|-
| import || Imports a module
|-
| in || Checks if a value is present in an array
|-
| is || Tests if two values are equal
|-
| lambda || Defines an anonymous function
|-
| None || Defines a null value
|-
| not || A logical operator
|-
| or || A logical operator
|-
| pass || Does nothing, a null statement
|-
| print || Prints a message to the screen
|-
| raise || Raises an exception
|-
| return || Exits a function and returns a value
|-
| True || A boolean value
|-
| try || Defines an exception handler (tests a block of code for errors). See except, finally, and else.
|-
| while || Creates a while loop
|-
| with || Manages external resources
|-
| yield || Exits a generator function and returns a value
|}

All the keywords except False, None, and True are in lowercase and they must be written as they are.

AmigaOS Manual: Reserved Python Words

2022-08-21T10:10:11Z

Janne Peräaho: Added keyword descriptions

Python has 34 keywords that have a predefined meaning and thus they cannot be used as a variable name. The keywords are:

{| class="wikitable"
! style="text-align:left;" | Keyword
! style="text-align:left;" | Description
|-
| and || A logical operator
|-
| as || Creates an alias
|-
| assert || Used for debugging. Raises an AssertionError exception with a specified error message if the supplied condition is False.
|-
| break || Exits loop
|-
| class || Defines a class
|-
| continue || Terminates the current loop iteration and begins the next one
|-
| def || Defines a function
|-
| del || Deletes an object
|-
| elif ||
|-
| else || Defines actions that are executed when if condition is False. See if. When used with exception handler, defines actions that are executed when there there was no error. See try.
|-
| except || Defines an error handler for an exception handler. See try.
|-
| exec || Executes the supplied Python code
|-
| False ||
|-
| finally || Defines actions for exception handler that are executed always. See try.
|-
| for || Creates a for loop
|-
| from || Imports a part of a module
|-
| global || Declares a global variable
|-
| if || Defines actions that are executed when if condition is True.
|-
| import || Imports a module
|-
| in || Checks if a value is present in an array
|-
| is || Tests if two values are equal
|-
| lambda || Defines an anonymous function
|-
| None || Defines a null value
|-
| not || A logical operator
|-
| or || A logical operator
|-
| pass || Does nothing, a null statement
|-
| print || Prints a message to the screen
|-
| raise || Raises an exception
|-
| return || Exits a function and returns a value
|-
| True ||
|-
| try || Defines an exception handler (tests a block of code for errors). See except, finally, and else.
|-
| while || Creates a while loop
|-
| with ||
|-
| yield ||
|}

All the keywords except False, None, and True are in lowercase and they must be written as they are.

AmigaOS Manual: Reserved Python Words

2022-08-21T10:03:10Z

Janne Peräaho: Added keyword descriptions

Python has 34 keywords that have a predefined meaning and thus they cannot be used as a variable name. The keywords are:

{| class="wikitable"
! style="text-align:left;" | Keyword
! style="text-align:left;" | Description
|-
| and || A logical operator
|-
| as ||
|-
| assert ||
|-
| break ||
|-
| class ||
|-
| continue ||
|-
| def || Defines a function
|-
| del || Deletes an object
|-
| elif ||
|-
| else || Defines actions that are executed when if condition is False. See if. When used with exception handler, defines actions that are executed when there there was no error. See try.
|-
| except || Defines an error handler for an exception handler. See try.
|-
| exec || Executes the supplied Python code
|-
| False ||
|-
| finally || Defines actions for exception handler that are executed always. See try.
|-
| for || Creates a for loop
|-
| from || Imports a part of a module
|-
| global || Declares a global variable
|-
| if || Defines actions that are executed when if condition is True.
|-
| import || Imports a module
|-
| in || Checks if a value is present in an array
|-
| is || Tests if two values are equal
|-
| lambda || Defines an anonymous function
|-
| None || Defines a null value
|-
| not || A logical operator
|-
| or || A logical operator
|-
| pass || Does nothing, a null statement
|-
| print || Prints a message to the screen
|-
| raise || Raises an exception
|-
| return || Exits a function and returns a value
|-
| True ||
|-
| try || Defines an exception handler (tests a block of code for errors). See except, finally, and else.
|-
| while || Creates a while loop
|-
| with ||
|-
| yield ||
|}

All the keywords except False, None, and True are in lowercase and they must be written as they are.

AmigaOS Manual: Reserved Python Words

2022-08-21T09:56:56Z

Janne Peräaho: Added keyword descriptions

Python has 34 keywords that have a predefined meaning and thus they cannot be used as a variable name. The keywords are:

{| class="wikitable"
! style="text-align:left;" | Keyword
! style="text-align:left;" | Description
|-
| and || A logical operator
|-
| as ||
|-
| assert ||
|-
| break ||
|-
| class ||
|-
| continue ||
|-
| def || Defines a function
|-
| del || Deletes an object
|-
| elif ||
|-
| else || Defines actions that are executed when if condition is False. See if. When used with exception handler, defines actions that are executed when there there was no error. See try.
|-
| except || Defines an error handler for an exception handler. See try.
|-
| exec ||
|-
| False ||
|-
| finally || Defines actions for exception handler that are executed always. See try.
|-
| for || Creates a for loop
|-
| from || Imports a part of a module
|-
| global || Declares a global variable
|-
| if || Defines actions that are executed when if condition is True.
|-
| import || Imports a module
|-
| in || Checks if a value is present in an array
|-
| is || Tests if two values are equal
|-
| lambda || Defines an anonymous function
|-
| None ||
|-
| not || A logical operator
|-
| or || A logical operator
|-
| pass || Does nothing, a null statement
|-
| print ||
|-
| raise || Raises an exception
|-
| return || Exits a function and returns a value
|-
| True ||
|-
| try || Defines an exception handler (tests a block of code for errors). See except, finally, and else.
|-
| while || Creates a while loop
|-
| with ||
|-
| yield ||
|}

All the keywords except False, None, and True are in lowercase and they must be written as they are.

AmigaOS Manual: Reserved Python Words

2022-08-21T09:39:41Z

Janne Peräaho: Added keyword descriptions

AmigaOS Manual: Reserved Python Words

2022-08-21T09:30:34Z

Janne Peräaho: Table of keywords

AmigaOS Manual: Python Escape Characters

2022-08-21T08:26:58Z

Janne Peräaho:

In the table below you can find the complete list of Python escape characters.

{| class="wikitable"
! style="text-align:left;" | Escape Code
! style="text-align:left;" | Description
|-
| \0 || Null character
|-
| \" || Double quote
|-
| \' || Single quote
|-
| \\ || Backslash
|-
| \a || Alert (Beep)
|-
| \b || Backspace
|-
| \f || Form Feed
|-
| \n || New Line
|-
| \r || Carriage Return
|-
| \t || Tab
|-
| \v || Vertical tab
|-
| \ooo || Octal value ooo
|-
| \xhh || Hexadecimal value hh
|}

AmigaOS Manual: Python Escape Characters

2022-08-21T08:17:41Z

Janne Peräaho:

In the table below you can find the complete list of Python escape characters.

{| class="wikitable"
! style="text-align:left;" | Code
! style="text-align:left;" | Description
|-
| \0 || Null character
|-
| \" || Double quote
|-
| \' || Single quote
|-
| \\ || Backslash
|-
| \a || Alert (Beep)
|-
| \b || Backspace
|-
| \f || Form Feed
|-
| \n || New Line
|-
| \r || Carriage Return
|-
| \t || Tab
|-
| \v || Vertical tab
|-
| \ooo || Octal value ooo
|-
| \xhh || Hexadecimal value hh
|}

AmigaOS Manual: Python Escape Characters

2022-08-21T08:15:11Z

Janne Peräaho: Table of Python escape characters

In the table below you can find the complete list of Python escape characters.

{| class="wikitable"
! style="text-align:left;" | Code
! style="text-align:left;" | Description
|-
| \0 || Null character
|-
| \' || Single quote
|-
| \" || Double quote
|-
| \\ || Backslash
|-
| \a || Alert (Beep)
|-
| \b || Backspace
|-
| \f || Form Feed
|-
| \n || New Line
|-
| \r || Carriage Return
|-
| \t || Tab
|-
| \v || Vertical tab
|-
| \ooo || Octal value ooo
|-
| \xhh || Hexadecimal value hh
|}

AmigaOS Manual: Python

2022-08-21T07:44:26Z

Janne Peräaho: Added "Reserved Python Words" and "Python Escape Characters"

{{WIP}}
= Welcome =

Python is a high-level, object-oriented general purpose programming language created by Guido van Rossum. It includes a large standard library containing standardized solutions for the common programming problems and tools for accessing the system resources. On Amiga, Python can replace [[AmigaOS Manual: ARexx|ARexx]] as a scripting language.

This manual introduces you to Python, tells you how to create Python programs and provides a reference section of Python commands.

[[AmigaOS Manual: Python Introducing Python|Chapter 1. Introducing Python]] This chapter gives an overview of Python, how it works on the Amiga, and the basic features of the programming language.

[[AmigaOS Manual: Python Getting Started|Chapter 2. Getting Started]]

[[AmigaOS Manual: Python Elements of Python|Chapter 3. Elements of Python]]

[[AmigaOS Manual: Python Functions|Chapter 4. Functions]] This chapter describes the use of functions and provides an alphabetical listing of the built-in Python functions.

[[AmigaOS Manual: Python Methods|Chapter 5. Methods]] This chapter provides a listing of the built-in Python methods.

[[AmigaOS Manual: Python Modules and Packages|Chapter 6. Modules and Packages]]

[[AmigaOS Manual: Python Classes and Objects|Chapter 7. Classes and Objects]] This chapter explains how to use Python's object-oriented features.

[[AmigaOS Manual: Python Debugging|Chapter 8. Debugging]]

[[AmigaOS Manual: Python Parsing|Chapter 9. Parsing]] This chapter explains how to break up strings and files into more easily processed components.

[[AmigaOS Manual: Python Sounds|Chapter 10. Sounds]] This chapter explains how to record and play sounds.

[[AmigaOS Manual: Python Printing|Chapter 11. Printing]] This chapter explains how to print.

[[AmigaOS Manual: Python Serial and parallel ports|Chapter 12. Serial and parallel ports]] This chapter explains how to receive and send data through the serial and parallel ports.

[[AmigaOS Manual: Python Network resources|Chapter 13. Network resources]] This chapter explains how you can connect to a remote server and exchange data with it.

[[AmigaOS Manual: Python Graphical User Interfaces|Chapter 14. Graphical User Interfaces]] This chapter explains how to create graphical user interfaces with Python.

[[AmigaOS Manual: Python Interprocess communication through ARexx ports|Chapter 15. Interprocess communication through ARexx ports]]

[[AmigaOS Manual: Reserved Python Words|Appendix: A. Reserved Python Words]] This appendix lists Python keywords.

[[AmigaOS Manual: Python Escape Characters|Appendix: B. Python Escape Characters]] This appendix lists Python escape characters.

[[AmigaOS Manual: Standard Exceptions|Appendix: C. Standard Exceptions]] This appendix lists the standard Python exceptions.

[[AmigaOS Manual: Built-in Constants|Appendix: D. Built-in Constants]] This appendix lists the Python's built-in constants.

[[AmigaOS Manual: Environment Variables|Appendix: E. Environment Variables]] This appendix lists the Python environment variables.

[[AmigaOS Manual: Python Glossary|Glossary]] The glossary contains common Python terms.

= Document Conventions =

The following conventions are used in this manual:

; [ ] (brackets)
: Optional instruction parts are enclosed in brackets.

; <n>
: Variables are displayed in angle brackets. Do not enter the angle brackets when entering the variable.

; Courier
: Text appearing in the Courier font represents output from your Python programs or other information that displays on your screen.

= Sources of Additional Information =

Further information on learning and using Python can be found in:

[https://docs.python.org/2.7/ Python 2.7.15 Documentation], by Python Software Foundation.

AmigaOS Manual: Python Modules and Packages

2022-07-31T20:33:11Z

Janne Peräaho: /* installer */

= Amiga Specific Modules =

Amiga Python contains six Amiga specific modules:
* '''amiga''' - provides access to the most common system calls
* '''arexx''' - support for ARexx communication and ARexx hosts
* '''asl''' - provides access to the requesters
* '''catalog''' - provides access to the localization methods
* '''icon''' - provides access to the icon methods
* '''installer''' - provides access to the [[Installation_Utility|Installation Utility]] methods

== amiga ==

This module provides access to the AmigaOS system functionality. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import amiga module
import amiga
</syntaxhighlight>

=== abort() ===

abort ()

Abort the interpreter immediately. Calling the abort method fails in the hardest way possible on the hosting operating system.
This method does not return!

=== access() ===

have_access = access ( path, mode )

Use the real uid (User Identifier) or gid (Group Identifier) to test for access to a path. Note that most operations will use the effective uid/gid, therefore this routine can be used in a suid (Set Owner User ID) or sgid (Set Group ID) environment to test if the invoking user has the specified access to the path.

The mode argument can be '''F_OK''' to test existence, or the inclusive-OR of '''R_OK''', '''W_OK''', and '''X_OK'''.

Access() returns '''True''' if access is allowed, '''False''' if not.

=== chdir() ===

chdir ( path )

Change the current working directory to the specified path.

=== chmod() ===

chmod ( path, mode )

Change the access permissions of a file.

=== chown() ===

chown ( path, uid, gid )

Change the owner and group id of path to the numeric uid and gid.

=== close() ===

close ( fd )

Close a file descriptor (for low level I/O).

=== dup() ===

fd2 = dup ( fd )

Return a duplicate of a file descriptor.

=== dup2() ===

dup2 ( old_fd, new_fd )

Duplicate file descriptor.

=== fdopen() ===

file_object = fdopen ( fd [, mode = 'r' [, bufsize ] ] )

Return an open file object connected to a file descriptor.

=== fstat() ===

result = fstat ( fd )

Like stat(), but for an open file descriptor.

=== ftruncate() ===

ftruncate ( fd, length )

Truncate a file to a specified length.

=== getcpu() ===

getcpu ()

Get the CPU model string.

=== getcwd() ===

path = getcwd ()

Return a string representing the current working directory.

=== getcwdu() ===

path = getcwdu ()

Return a unicode string representing the current working directory.

=== getmachine() ===

getmachine ()

Get the machine model string.

=== getpid() ===

pid = getpid ()

Return the current process ID.

=== getports() ===

list_of_strings = getports ()

Returns a list of public message port names.

=== isatty() ===

bool = isatty ( fd )

Return '''True''' if the file descriptor 'fd' is an open file descriptor connected to the slave end of a terminal.

=== kill() ===

kill ( pid, sig )

Kill a process 'pid' with a signal 'sig'.

=== link() ===

link ( source, destination )

Create a hard link to a file.

=== listdir() ===

list_of_strings = listdir ( path )

Returns a list containing the names of the entries in the directory.

;path
: Path of the directory to list.

The list is in arbitrary order. It does not include the special entries '.' and '..' even if they are present in the directory.

=== lseek() ===

newpos = lseek ( fd, pos, how )

Change file descriptor position.

=== lstat() ===

result = lstat ( path )

Like [[AmigaOS_Manual:_Python_Modules_and_Packages#stat.28.29|stat()]], but does not follow symbolic links.

=== mkdir() ===

mkdir ( path, [, mode = 0777 ] )

Create a directory.

=== open() ===

fd = open ( filename, flag [, mode = 0777 ] )

Open a file for a low level input/output.

=== pipe() ===

read_end, write_end = pipe ()

Create a pipe.

=== popen() ===

pipe = popen ( command [, mode = 'r' [, bufsize ] ] )

Open a pipe to or from a command returning a file object.

=== putenv() ===

putenv ( key, value )

Change or add an environment variable.

=== read() ===

string = read ( fd, buffersize )

This method will read a string from the previously opened file.

=== remove() ===

remove ( path )

Remove a file.

;See also
* [[AmigaOS_Manual:_Python_Modules_and_Packages#unlink.28.29|unlink()]]

=== rename() ===

rename ( oldName, newName )

Rename a file or a directory.

=== rmdir() ===

rmdir ( path )

Deletes the directory which path is passed as an argument. To be successful, the directory must be empty.

=== stat() ===

statInfo = stat ( path )

Returns information on a file or a directory. When called, the method returns the following data structure:
{| class="wikitable"
! Name !! Description
|-
| '''st_mode''' || object's protection bits
|-
| '''st_ino''' || object's inode number
|-
| '''st_dev''' || object's device
|-
| '''st_nlink''' || number of hard links
|-
| '''st_uid''' || user ID of the owner
|-
| '''st_gid''' || group ID of the owner
|-
| '''st_size''' || size of the file object (bytes)
|-
| '''st_atime''' || time of most recent access
|-
| '''st_mtime''' || time of most recent content modification
|-
| '''st_ctime''' || time of most recent metadata change
|}

;See also
* [[AmigaOS_Manual:_Python_Modules_and_Packages#stat_float_times.28.29|stat_float_times()]]

; Example:
Get information on file "myFile" and print its size:
<syntaxhighlight lang="python">
statInfo = amiga.stat ( "RAM:myFile" )

print ( statInfo.st_size )
</syntaxhighlight>

=== stat_float_times() ===

old_value = stat_float_times ( [ new_value ] )

Determines whether [[AmigaOS_Manual:_Python_Modules_and_Packages#stat.28.29|stat()]] represents time stamps as floating point numbers. If '''new_value''' is True, future calls to [[AmigaOS_Manual:_Python_Modules_and_Packages#stat.28.29|stat()]] will return floating point numbers, otherwise future calls will return integer numbers.

If '''new_value''' is omitted, the current setting will be returned.

=== strerror() ===

error_message = strerror ( code )

Translates an error code to a message string.

;Example
Print the error message associated with the error code 17:
<syntaxhighlight lang="python">
amiga.strerror( 17 )
</syntaxhighlight>

=== system() ===

exit_status = system ( command )

Execute the command (a string) in a subshell.

;Example
Show how long the system has been running using the Shell command '''Uptime'''.
<syntaxhighlight lang="python">
amiga.system( "Uptime" )
</syntaxhighlight>

=== tempnam() ===
=== tmpfile() ===
=== tmpnam() ===
=== umask() ===
=== unlink() ===
=== urandom() ===
=== utime() ===
=== waitforport() ===
=== write() ===

== arexx ==

This module provides support for ARexx communication and ARexx hosts. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import arexx module
import arexx
</syntaxhighlight>

=== Msg Class ===
==== error() ====

Reply an ARexx message with an error.

==== getvar() ====

Get an ARexx variable through the context of the message.

==== reply() ====

Reply an ARexx message.

==== setvar() ====

Set an ARexx variable via the context of the message.

=== Port Class ===
==== close() ====
==== getmsg() ====
==== wait() ====

=== dorexx() ===

rc, rc2, result = dorexx ( port, message )

Send an ARexx message '''message''' to the supplied ARexx host port '''port'''.

; Example:
Command Workbench to display its About requester:
<syntaxhighlight lang="python">
arexx.dorexx( 'WORKBENCH', 'menu window root invoke workbench.about' )
</syntaxhighlight>

=== Variables ===
* __doc__
* __file__
* __name__

== asl ==

This module contains AmigaOS-specific requester methods for file and path queries, message boxes, ans similar aspects. The methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import ASL module
import asl
</syntaxhighlight>

=== FileRequest() ===

drawer, file = FileRequest ( title, drawer, filename, pattern )

Opens a file select requester with the given title, the drawer and filename gadgets predefined by drawer and title. If a pattern is given, a pattern gadget is also displayed and pre-set with the given pattern. The result is a tuple drawer, filename which relects the choice of the user.

; Example:
Opens up a file requester in T: with 'my.log' as a default name, and a filter set to '#?.log':
<syntaxhighlight lang="python">
drawer, file = asl.FileRequest('Python File Request', 'T:', 'my.log', '#?.log' )
</syntaxhighlight>

=== MessageBox() ===

result = MessageBox( title, body_text, buttons )

Opens a message box with the given title and body text. The options on the dialog are taken from the 'buttons' argument. The 'buttons' string contains individual substrings separated by a '|'.

The result of this method is the button number selected by the user. Numbering starts from left with 1, 2 and so on, but the final button is 0.

; Example:
Puts up a requester asking for a 'Yes' or 'No' answer:
<syntaxhighlight lang="python">
result = asl.MessageBox('Python Request', 'AmigaOS rules', 'Yes|No')
</syntaxhighlight>
Selecting 'Yes' returns 1 and selecting 'No' returns 0.

=== Variables ===
* __doc__
* __file__
* __name__

== catalog ==

This module allows you to read Amiga catalog files and retrieve localized string from them. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import catalog module
import catalog
</syntaxhighlight>

=== OpenCatalog() ===

catalog = OpenCatalog( catalogname, language, builtinlanguage )

Open a named catalog. Catalog contains all the text strings that an application uses.

; Example:
Open a catalog of application '''myapplication''' using the system default language. For example, if the system language is Finnish, the OpenCatalog method will try to open '''myapplication''''s Finnish catalog. If the catalog does not exist, a builtin English catalog will be used.
<syntaxhighlight lang="python">
import catalog

try:
myApplicationCatalog = catalog.OpenCatalog ( "myapplication.catalog", None, "english" )
except:
myApplicationCatalog = None
</syntaxhighlight>

=== GetString() ===

string = GetString( stringid, defaultstring )

Get a string from a catalog. If the requested string ''stringid'' does not exist, the supplied ''defaultstring'' will be returned instead.

; Example:
Get the 11th string from a catalog, which has previously been opened as a ''myApplicationCatalog'' object. If there is no such string, string "About..." will be returned.
<syntaxhighlight lang="python">
string = myApplicationCatalog.GetString ( 11, "About..." )
</syntaxhighlight>

== icon ==

The icon module allows you to manipulate the information stored in the Amiga icon files. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import icon module
import icon
</syntaxhighlight>

=== DiskObject Class ===

disk_object = DiskObject( path )

Opens an icon file. The '''path''' argument is a path to the icon file to be opened without the icon file extension ".info". On success, the DiskObject method will return a "DiskObject" object which contains the following attributes:

{| class="wikitable"
! Attribute !! Description
|-
| tooltypes || Icon tool types as a list of tuples
|-
| deftool || The default tool
|-
| stacksize || Program stack size
|}

Attributes can be manipulated and saved back to the icon using the PutIcon() method.

;See also
* PutIcon()

; Example:
Open the "SYS:System/Shell" icon file ("SYS:System/Shell.info") and print its attributes.
<syntaxhighlight lang="python">
import icon # Include icon module

ic = icon.DiskObject( 'SYS:System/Shell' )
print( 'Tool types: ' + str( ic.tooltypes ) )
print( 'Default tool: ' + ic.deftool )
print( 'Stack size: ' + str( ic.stacksize ) )
</syntaxhighlight>

==== PutIcon() ====

dobj.PutIcon ( name [, notifywb ] )

Writes a previously created DiskObject object '''dobj''' (an icon) to disk. The '''name''' argument is a path to the icon file to be written without the icon file extension ".info". When '''notifywb''' is True, PutIcon() will ask Workbench to update the icon if it is displayed. By default '''notifywb''' is False.

;See also
* DiskObject()

== installer ==

The installer module provides an interface to the [[Installation_Utility|Installation Utility]]. The provided methods allow you to create an installation script with a graphical user interface. The module's methods may only be used if the module objects has been imported. Below is an example how to import this module's objects.

<syntaxhighlight lang="python">
# Import installer module
from installer import *
</syntaxhighlight>

{{Note|The installer module is available only within [[Installation_Utility|Installation Utility]].}}

=== AddButton() ===

AddButton( label, frame, weight, onclick )

Add a button to a GUI page.

;See also
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddCheckBox() ===

AddCheckBox( label, weight, checked, onclick )

Add a checkbox gadget to a GUI page.

;See also
* AddButton()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddChooser() ===

AddChooser( label, choices, weight, selected, mode, onclick )

Add a chooser gadget to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddLabel()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddLabel() ===

AddLabel( label, frame, weight, align )

Add a text label to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddPackage() ===

AddPackage( type, name, description, optional, selected, diskspace, featuregroup, alternatepath, files )

Add a package to the installation.

;See also
* IsPackageSelected()
* SelectPackage()
* SetPackageOption()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddPostInstallAction() ===

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddRadioButton() ===

AddRadioButton( labellist, weight, selected, onclick )

Add a radiobutton gadget to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddSpace() ===

AddSpace( weight )

Add space to a GUI page's layout.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddString()

;Example
<syntaxhighlight lang="python">
AddSpace( weight = 5 )
</syntaxhighlight>

=== AddString() ===

AddString( label, value, weight, handler )

Add a string gadget to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddSpace()
* GetString()
* SetString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== BeginGroup() ===

BeginGroup( orientation, label, frame, weight )

Begin a new layout group in a GUI page.

;See also
* EndGroup()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== EndGUI() ===

EndGUI()

End a GUI page's user interface definition.

;See also
* StartGUI()

;Example
<syntaxhighlight lang="python">
EndGUI ()
</syntaxhighlight>

=== EndGroup() ===

EndGroup()

End of layout group.

;See also
* BeginGroup()

;Example
<syntaxhighlight lang="python">
EndGroup ()
</syntaxhighlight>

=== GetDeviceList() ===

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetInteger() ===

;See also
* SetInteger()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetObject() ===

;See also
* SetObject()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetString() ===

text = GetString( page, stringid )

Get a string gadget content.

;See also
* SetString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetUIAttr() ===

value = GetUIAttr( page, element, attribute )

Get a value of a GUI element's attribute.

;See also
* SetUIAttr()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GotoPage() ===

GotoPage( page )

Go to the given page.

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== IsPackageSelected() ===

selected = IsPackageSelected( package )

Queries if a package is selected.

;See also
* AddPackage()
* SelectPackage()
* SetPackageOption()

;Example
<syntaxhighlight lang="python">
from installer import *

myPackage = AddPackage ( type = FILEPACKAGE, name = "My Package", optional = False, selected = True, file = [ "MyApplication/" ] )

if IsPackageSelected ( myPackage ):
print ( "Package selected." )
</syntaxhighlight>

=== NewPage() ===

page = NewPage( type )

Creates a new installer page. The ''type'' argument tells what kind of page will be created. The available page types are:

;DESTINATION
: A page to select a directory to serve as the target for the installation.
: '''Note:''' this page is mandatory.

;FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "Cancel" to the "Finish" button.

;GUI
: A page where GUI elements can be added and controlled via a Python handler.

;INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

;LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: '''Note:''' the [[Installation_Utility|Installation Utility]] will look for a text file called "license_languagename.language.txt", if not found, it will look for a file called "license.txt".

;PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.

;README
: A page that displays a text file from disk for reference/README purposes.
: '''Note:''' the [[Installation_Utility|Installation Utility]] will look for a text file called "readme_languagename.language.txt", if not found, it will look for a file called "readme.txt".

;WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: '''Note:''' this page is mandatory.

If successful, the method will return created page's number. Otherwise an OSError exception is raised.

;Example
Add a welcome page:
<syntaxhighlight lang="python">
pageWelcome = NewPage ( WELCOME )
SetString (
pageWelcome, "message",
"Welcome to the installation!"
)
</syntaxhighlight>

=== RunInstaller() ===

RunInstaller()

Runs the installation.

;Example
Execute installation:
<syntaxhighlight lang="python">
RunInstaller ()
</syntaxhighlight>

=== SelectPackage() ===

;See also
* AddPackage()
* IsPackageSelected()
* SetPackageOption()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetInteger() ===

SetInteger( page, integerid, value )

Set an interger variable on a page.

;See also
* GetInteger()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetObject() ===

SetObject( page, objectid, value )

Set a Python object variable on a page.

;See also
* GetObject()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetPackageOption() ===

SetPackageOption( package, option, value )

Set package option.

;See also
* AddPackage()
* IsPackageSelected()
* SelectPackage()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetString() ===

SetString( page, stringid, text )

Set a page's string gadget value.

;See also
* GetString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetUIAttr() ===

SetUIAttr( page, element, attribute, value )

Set a value of a GUI element attribute.

;See also
* GetUIAttr()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== StartGUI() ===

StartGUI( page )

Start a GUI page's user interface definition.

;See also
* EndGUI()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== Variables ===
* ALIGN_BLOCK
* ALIGN_CENTER
* ALIGN_LEFT
* ALIGN_RIGHT
* ARCHIVEPACKAGE
* BOX_FRAME
* BUTTON_FRAME
* CANCEL
* CHOOSER_DROPDOWN
* CHOOSER_POPUP
* DESTINATION
* DROPBOX_FRAME
* FIELD_FRAME
* FILEPACKAGE
* FINISH
* GROUP_FRAME
* GROUP_HORIZONTAL
* GROUP_VERTICAL
* GUI
* GUI_ACTIVE
* GUI_CHECKED
* GUI_LABEL
* GUI_ONCLICK
* GUI_SELECTED
* GUI_STRING
* HANDLERPACKAGE
* ID_BUSY_DISK
* ID_CON
* ID_DISKSTATE_VALIDATED
* ID_DISKSTATE_VALIDATING
* ID_DISKSTATE_WRITE_PROTECTED
* ID_DOS_DISK
* ID_FASTDIR_DOS_DISK
* ID_FASTDIR_FFS_DISK
* ID_FSS_DISK
* ID_INTER_DOS_DISK
* ID_INTER_FFS_DISK
* ID_KICKSTART_DISK
* ID_LONGNAME_DOS_DISK
* ID_LONGNAME_FFS_DISK
* ID_MSDOS_DISK
* ID_NOT_REALLY_DOS
* ID_NO_DISK_PRESENT
* ID_RAWCON
* ID_UNREADABLE_DISK
* ID_VALIDATED
* ID_VALIDATING
* ID_WRITE_PROTECTED
* INHIBIT_BACKWARD
* INHIBIT_CANCEL
* INHIBIT_FORWARD
* INSTALL
* JUMP
* LICENSE
* NEXT
* NONE_FRAME
* PACKAGESELECT
* PREVIOUS
* PROCESSING
* README
* SBAR_HORIZ_FRAME
* SBAR_VERT_FRAME
* STANDARD_FRAME
* THIN_FRAME
* WELCOME

= Amiga Specific Packages =

The current Amiga Python release does not contain any Amiga specific packages.

AmigaOS Manual: Python Modules and Packages

2022-07-31T20:32:38Z

Janne Peräaho: Corrected import example and added a note.

= Amiga Specific Modules =

Amiga Python contains six Amiga specific modules:
* '''amiga''' - provides access to the most common system calls
* '''arexx''' - support for ARexx communication and ARexx hosts
* '''asl''' - provides access to the requesters
* '''catalog''' - provides access to the localization methods
* '''icon''' - provides access to the icon methods
* '''installer''' - provides access to the [[Installation_Utility|Installation Utility]] methods

== amiga ==

This module provides access to the AmigaOS system functionality. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import amiga module
import amiga
</syntaxhighlight>

=== abort() ===

abort ()

Abort the interpreter immediately. Calling the abort method fails in the hardest way possible on the hosting operating system.
This method does not return!

=== access() ===

have_access = access ( path, mode )

Use the real uid (User Identifier) or gid (Group Identifier) to test for access to a path. Note that most operations will use the effective uid/gid, therefore this routine can be used in a suid (Set Owner User ID) or sgid (Set Group ID) environment to test if the invoking user has the specified access to the path.

The mode argument can be '''F_OK''' to test existence, or the inclusive-OR of '''R_OK''', '''W_OK''', and '''X_OK'''.

Access() returns '''True''' if access is allowed, '''False''' if not.

=== chdir() ===

chdir ( path )

Change the current working directory to the specified path.

=== chmod() ===

chmod ( path, mode )

Change the access permissions of a file.

=== chown() ===

chown ( path, uid, gid )

Change the owner and group id of path to the numeric uid and gid.

=== close() ===

close ( fd )

Close a file descriptor (for low level I/O).

=== dup() ===

fd2 = dup ( fd )

Return a duplicate of a file descriptor.

=== dup2() ===

dup2 ( old_fd, new_fd )

Duplicate file descriptor.

=== fdopen() ===

file_object = fdopen ( fd [, mode = 'r' [, bufsize ] ] )

Return an open file object connected to a file descriptor.

=== fstat() ===

result = fstat ( fd )

Like stat(), but for an open file descriptor.

=== ftruncate() ===

ftruncate ( fd, length )

Truncate a file to a specified length.

=== getcpu() ===

getcpu ()

Get the CPU model string.

=== getcwd() ===

path = getcwd ()

Return a string representing the current working directory.

=== getcwdu() ===

path = getcwdu ()

Return a unicode string representing the current working directory.

=== getmachine() ===

getmachine ()

Get the machine model string.

=== getpid() ===

pid = getpid ()

Return the current process ID.

=== getports() ===

list_of_strings = getports ()

Returns a list of public message port names.

=== isatty() ===

bool = isatty ( fd )

Return '''True''' if the file descriptor 'fd' is an open file descriptor connected to the slave end of a terminal.

=== kill() ===

kill ( pid, sig )

Kill a process 'pid' with a signal 'sig'.

=== link() ===

link ( source, destination )

Create a hard link to a file.

=== listdir() ===

list_of_strings = listdir ( path )

Returns a list containing the names of the entries in the directory.

;path
: Path of the directory to list.

The list is in arbitrary order. It does not include the special entries '.' and '..' even if they are present in the directory.

=== lseek() ===

newpos = lseek ( fd, pos, how )

Change file descriptor position.

=== lstat() ===

result = lstat ( path )

Like [[AmigaOS_Manual:_Python_Modules_and_Packages#stat.28.29|stat()]], but does not follow symbolic links.

=== mkdir() ===

mkdir ( path, [, mode = 0777 ] )

Create a directory.

=== open() ===

fd = open ( filename, flag [, mode = 0777 ] )

Open a file for a low level input/output.

=== pipe() ===

read_end, write_end = pipe ()

Create a pipe.

=== popen() ===

pipe = popen ( command [, mode = 'r' [, bufsize ] ] )

Open a pipe to or from a command returning a file object.

=== putenv() ===

putenv ( key, value )

Change or add an environment variable.

=== read() ===

string = read ( fd, buffersize )

This method will read a string from the previously opened file.

=== remove() ===

remove ( path )

Remove a file.

;See also
* [[AmigaOS_Manual:_Python_Modules_and_Packages#unlink.28.29|unlink()]]

=== rename() ===

rename ( oldName, newName )

Rename a file or a directory.

=== rmdir() ===

rmdir ( path )

Deletes the directory which path is passed as an argument. To be successful, the directory must be empty.

=== stat() ===

statInfo = stat ( path )

Returns information on a file or a directory. When called, the method returns the following data structure:
{| class="wikitable"
! Name !! Description
|-
| '''st_mode''' || object's protection bits
|-
| '''st_ino''' || object's inode number
|-
| '''st_dev''' || object's device
|-
| '''st_nlink''' || number of hard links
|-
| '''st_uid''' || user ID of the owner
|-
| '''st_gid''' || group ID of the owner
|-
| '''st_size''' || size of the file object (bytes)
|-
| '''st_atime''' || time of most recent access
|-
| '''st_mtime''' || time of most recent content modification
|-
| '''st_ctime''' || time of most recent metadata change
|}

;See also
* [[AmigaOS_Manual:_Python_Modules_and_Packages#stat_float_times.28.29|stat_float_times()]]

; Example:
Get information on file "myFile" and print its size:
<syntaxhighlight lang="python">
statInfo = amiga.stat ( "RAM:myFile" )

print ( statInfo.st_size )
</syntaxhighlight>

=== stat_float_times() ===

old_value = stat_float_times ( [ new_value ] )

Determines whether [[AmigaOS_Manual:_Python_Modules_and_Packages#stat.28.29|stat()]] represents time stamps as floating point numbers. If '''new_value''' is True, future calls to [[AmigaOS_Manual:_Python_Modules_and_Packages#stat.28.29|stat()]] will return floating point numbers, otherwise future calls will return integer numbers.

If '''new_value''' is omitted, the current setting will be returned.

=== strerror() ===

error_message = strerror ( code )

Translates an error code to a message string.

;Example
Print the error message associated with the error code 17:
<syntaxhighlight lang="python">
amiga.strerror( 17 )
</syntaxhighlight>

=== system() ===

exit_status = system ( command )

Execute the command (a string) in a subshell.

;Example
Show how long the system has been running using the Shell command '''Uptime'''.
<syntaxhighlight lang="python">
amiga.system( "Uptime" )
</syntaxhighlight>

=== tempnam() ===
=== tmpfile() ===
=== tmpnam() ===
=== umask() ===
=== unlink() ===
=== urandom() ===
=== utime() ===
=== waitforport() ===
=== write() ===

== arexx ==

This module provides support for ARexx communication and ARexx hosts. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import arexx module
import arexx
</syntaxhighlight>

=== Msg Class ===
==== error() ====

Reply an ARexx message with an error.

==== getvar() ====

Get an ARexx variable through the context of the message.

==== reply() ====

Reply an ARexx message.

==== setvar() ====

Set an ARexx variable via the context of the message.

=== Port Class ===
==== close() ====
==== getmsg() ====
==== wait() ====

=== dorexx() ===

rc, rc2, result = dorexx ( port, message )

Send an ARexx message '''message''' to the supplied ARexx host port '''port'''.

; Example:
Command Workbench to display its About requester:
<syntaxhighlight lang="python">
arexx.dorexx( 'WORKBENCH', 'menu window root invoke workbench.about' )
</syntaxhighlight>

=== Variables ===
* __doc__
* __file__
* __name__

== asl ==

This module contains AmigaOS-specific requester methods for file and path queries, message boxes, ans similar aspects. The methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import ASL module
import asl
</syntaxhighlight>

=== FileRequest() ===

drawer, file = FileRequest ( title, drawer, filename, pattern )

Opens a file select requester with the given title, the drawer and filename gadgets predefined by drawer and title. If a pattern is given, a pattern gadget is also displayed and pre-set with the given pattern. The result is a tuple drawer, filename which relects the choice of the user.

; Example:
Opens up a file requester in T: with 'my.log' as a default name, and a filter set to '#?.log':
<syntaxhighlight lang="python">
drawer, file = asl.FileRequest('Python File Request', 'T:', 'my.log', '#?.log' )
</syntaxhighlight>

=== MessageBox() ===

result = MessageBox( title, body_text, buttons )

Opens a message box with the given title and body text. The options on the dialog are taken from the 'buttons' argument. The 'buttons' string contains individual substrings separated by a '|'.

The result of this method is the button number selected by the user. Numbering starts from left with 1, 2 and so on, but the final button is 0.

; Example:
Puts up a requester asking for a 'Yes' or 'No' answer:
<syntaxhighlight lang="python">
result = asl.MessageBox('Python Request', 'AmigaOS rules', 'Yes|No')
</syntaxhighlight>
Selecting 'Yes' returns 1 and selecting 'No' returns 0.

=== Variables ===
* __doc__
* __file__
* __name__

== catalog ==

This module allows you to read Amiga catalog files and retrieve localized string from them. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import catalog module
import catalog
</syntaxhighlight>

=== OpenCatalog() ===

catalog = OpenCatalog( catalogname, language, builtinlanguage )

Open a named catalog. Catalog contains all the text strings that an application uses.

; Example:
Open a catalog of application '''myapplication''' using the system default language. For example, if the system language is Finnish, the OpenCatalog method will try to open '''myapplication''''s Finnish catalog. If the catalog does not exist, a builtin English catalog will be used.
<syntaxhighlight lang="python">
import catalog

try:
myApplicationCatalog = catalog.OpenCatalog ( "myapplication.catalog", None, "english" )
except:
myApplicationCatalog = None
</syntaxhighlight>

=== GetString() ===

string = GetString( stringid, defaultstring )

Get a string from a catalog. If the requested string ''stringid'' does not exist, the supplied ''defaultstring'' will be returned instead.

; Example:
Get the 11th string from a catalog, which has previously been opened as a ''myApplicationCatalog'' object. If there is no such string, string "About..." will be returned.
<syntaxhighlight lang="python">
string = myApplicationCatalog.GetString ( 11, "About..." )
</syntaxhighlight>

== icon ==

The icon module allows you to manipulate the information stored in the Amiga icon files. The module's methods may only be used if the module has been imported. Below is an example how to import this module.

<syntaxhighlight lang="python">
# Import icon module
import icon
</syntaxhighlight>

=== DiskObject Class ===

disk_object = DiskObject( path )

Opens an icon file. The '''path''' argument is a path to the icon file to be opened without the icon file extension ".info". On success, the DiskObject method will return a "DiskObject" object which contains the following attributes:

{| class="wikitable"
! Attribute !! Description
|-
| tooltypes || Icon tool types as a list of tuples
|-
| deftool || The default tool
|-
| stacksize || Program stack size
|}

Attributes can be manipulated and saved back to the icon using the PutIcon() method.

;See also
* PutIcon()

; Example:
Open the "SYS:System/Shell" icon file ("SYS:System/Shell.info") and print its attributes.
<syntaxhighlight lang="python">
import icon # Include icon module

ic = icon.DiskObject( 'SYS:System/Shell' )
print( 'Tool types: ' + str( ic.tooltypes ) )
print( 'Default tool: ' + ic.deftool )
print( 'Stack size: ' + str( ic.stacksize ) )
</syntaxhighlight>

==== PutIcon() ====

dobj.PutIcon ( name [, notifywb ] )

Writes a previously created DiskObject object '''dobj''' (an icon) to disk. The '''name''' argument is a path to the icon file to be written without the icon file extension ".info". When '''notifywb''' is True, PutIcon() will ask Workbench to update the icon if it is displayed. By default '''notifywb''' is False.

;See also
* DiskObject()

== installer ==

The installer module provides an interface to the [[Installation_Utility|Installation Utility]]. The provided methods allow you to create an installation script with a graphical user interface. The module's methods may only be used if the module objects has been imported. Below is an example how to import this module's objects.

<syntaxhighlight lang="python">
# Import installer module
from installer import *
</syntaxhighlight>

{{Note|The installer module is available only within Installation Utility.}}

=== AddButton() ===

AddButton( label, frame, weight, onclick )

Add a button to a GUI page.

;See also
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddCheckBox() ===

AddCheckBox( label, weight, checked, onclick )

Add a checkbox gadget to a GUI page.

;See also
* AddButton()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddChooser() ===

AddChooser( label, choices, weight, selected, mode, onclick )

Add a chooser gadget to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddLabel()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddLabel() ===

AddLabel( label, frame, weight, align )

Add a text label to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddRadioButton()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddPackage() ===

AddPackage( type, name, description, optional, selected, diskspace, featuregroup, alternatepath, files )

Add a package to the installation.

;See also
* IsPackageSelected()
* SelectPackage()
* SetPackageOption()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddPostInstallAction() ===

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddRadioButton() ===

AddRadioButton( labellist, weight, selected, onclick )

Add a radiobutton gadget to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddSpace()
* AddString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== AddSpace() ===

AddSpace( weight )

Add space to a GUI page's layout.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddString()

;Example
<syntaxhighlight lang="python">
AddSpace( weight = 5 )
</syntaxhighlight>

=== AddString() ===

AddString( label, value, weight, handler )

Add a string gadget to a GUI page.

;See also
* AddButton()
* AddCheckBox()
* AddChooser()
* AddLabel()
* AddRadioButton()
* AddSpace()
* GetString()
* SetString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== BeginGroup() ===

BeginGroup( orientation, label, frame, weight )

Begin a new layout group in a GUI page.

;See also
* EndGroup()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== EndGUI() ===

EndGUI()

End a GUI page's user interface definition.

;See also
* StartGUI()

;Example
<syntaxhighlight lang="python">
EndGUI ()
</syntaxhighlight>

=== EndGroup() ===

EndGroup()

End of layout group.

;See also
* BeginGroup()

;Example
<syntaxhighlight lang="python">
EndGroup ()
</syntaxhighlight>

=== GetDeviceList() ===

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetInteger() ===

;See also
* SetInteger()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetObject() ===

;See also
* SetObject()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetString() ===

text = GetString( page, stringid )

Get a string gadget content.

;See also
* SetString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GetUIAttr() ===

value = GetUIAttr( page, element, attribute )

Get a value of a GUI element's attribute.

;See also
* SetUIAttr()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== GotoPage() ===

GotoPage( page )

Go to the given page.

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== IsPackageSelected() ===

selected = IsPackageSelected( package )

Queries if a package is selected.

;See also
* AddPackage()
* SelectPackage()
* SetPackageOption()

;Example
<syntaxhighlight lang="python">
from installer import *

myPackage = AddPackage ( type = FILEPACKAGE, name = "My Package", optional = False, selected = True, file = [ "MyApplication/" ] )

if IsPackageSelected ( myPackage ):
print ( "Package selected." )
</syntaxhighlight>

=== NewPage() ===

page = NewPage( type )

Creates a new installer page. The ''type'' argument tells what kind of page will be created. The available page types are:

;DESTINATION
: A page to select a directory to serve as the target for the installation.
: '''Note:''' this page is mandatory.

;FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "Cancel" to the "Finish" button.

;GUI
: A page where GUI elements can be added and controlled via a Python handler.

;INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

;LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: '''Note:''' the [[Installation_Utility|Installation Utility]] will look for a text file called "license_languagename.language.txt", if not found, it will look for a file called "license.txt".

;PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.

;README
: A page that displays a text file from disk for reference/README purposes.
: '''Note:''' the [[Installation_Utility|Installation Utility]] will look for a text file called "readme_languagename.language.txt", if not found, it will look for a file called "readme.txt".

;WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: '''Note:''' this page is mandatory.

If successful, the method will return created page's number. Otherwise an OSError exception is raised.

;Example
Add a welcome page:
<syntaxhighlight lang="python">
pageWelcome = NewPage ( WELCOME )
SetString (
pageWelcome, "message",
"Welcome to the installation!"
)
</syntaxhighlight>

=== RunInstaller() ===

RunInstaller()

Runs the installation.

;Example
Execute installation:
<syntaxhighlight lang="python">
RunInstaller ()
</syntaxhighlight>

=== SelectPackage() ===

;See also
* AddPackage()
* IsPackageSelected()
* SetPackageOption()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetInteger() ===

SetInteger( page, integerid, value )

Set an interger variable on a page.

;See also
* GetInteger()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetObject() ===

SetObject( page, objectid, value )

Set a Python object variable on a page.

;See also
* GetObject()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetPackageOption() ===

SetPackageOption( package, option, value )

Set package option.

;See also
* AddPackage()
* IsPackageSelected()
* SelectPackage()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetString() ===

SetString( page, stringid, text )

Set a page's string gadget value.

;See also
* GetString()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== SetUIAttr() ===

SetUIAttr( page, element, attribute, value )

Set a value of a GUI element attribute.

;See also
* GetUIAttr()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== StartGUI() ===

StartGUI( page )

Start a GUI page's user interface definition.

;See also
* EndGUI()

;Example
<syntaxhighlight lang="python">
</syntaxhighlight>

=== Variables ===
* ALIGN_BLOCK
* ALIGN_CENTER
* ALIGN_LEFT
* ALIGN_RIGHT
* ARCHIVEPACKAGE
* BOX_FRAME
* BUTTON_FRAME
* CANCEL
* CHOOSER_DROPDOWN
* CHOOSER_POPUP
* DESTINATION
* DROPBOX_FRAME
* FIELD_FRAME
* FILEPACKAGE
* FINISH
* GROUP_FRAME
* GROUP_HORIZONTAL
* GROUP_VERTICAL
* GUI
* GUI_ACTIVE
* GUI_CHECKED
* GUI_LABEL
* GUI_ONCLICK
* GUI_SELECTED
* GUI_STRING
* HANDLERPACKAGE
* ID_BUSY_DISK
* ID_CON
* ID_DISKSTATE_VALIDATED
* ID_DISKSTATE_VALIDATING
* ID_DISKSTATE_WRITE_PROTECTED
* ID_DOS_DISK
* ID_FASTDIR_DOS_DISK
* ID_FASTDIR_FFS_DISK
* ID_FSS_DISK
* ID_INTER_DOS_DISK
* ID_INTER_FFS_DISK
* ID_KICKSTART_DISK
* ID_LONGNAME_DOS_DISK
* ID_LONGNAME_FFS_DISK
* ID_MSDOS_DISK
* ID_NOT_REALLY_DOS
* ID_NO_DISK_PRESENT
* ID_RAWCON
* ID_UNREADABLE_DISK
* ID_VALIDATED
* ID_VALIDATING
* ID_WRITE_PROTECTED
* INHIBIT_BACKWARD
* INHIBIT_CANCEL
* INHIBIT_FORWARD
* INSTALL
* JUMP
* LICENSE
* NEXT
* NONE_FRAME
* PACKAGESELECT
* PREVIOUS
* PROCESSING
* README
* SBAR_HORIZ_FRAME
* SBAR_VERT_FRAME
* STANDARD_FRAME
* THIN_FRAME
* WELCOME

= Amiga Specific Packages =

The current Amiga Python release does not contain any Amiga specific packages.

Installation Utility

2022-07-29T19:43:42Z

Janne Peräaho: Extended the alternatepath explanation

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation Utility'' as the default tool.

==== Tool Types ====

Installation Utility supports the following tool types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| BACKFILL=<image file> || An image that will be used to fill the Installation Utility window's background.
|- style="vertical-align: top;"
| LANGUAGE=<language> || Language that your installation script should use. In order to work, your installation script must support the supplied language.
|- style="vertical-align: top;"
| LOGO=<image file> || An image that will be displayed on top of every installation page.
|- style="vertical-align: top;"
| PACKAGENAME=<name> || This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory. (Default: ''package.py'')
|}

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' This page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' This page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Note:'' Installation Utility version 53.18 does not support page type PACKAGESELECT.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Note:'' On Installation Utility version 53.18 the page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' The Installation Utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' The Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.
: ''Note:'' Installation Utility version 53.18 does not support package types ARCHIVEPACKAGE and HANDLERPACKAGE.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. When an alternative path has been defined, Installation Utility ignores the target directory selected in the DESTINATION page and installs the package to the alternative path location. An alternative path can be used when, for example, some files need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None, i.e. no alternate path.

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T11:54:42Z

Janne Peräaho: Documented tool types

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation Utility'' as the default tool.

==== Tool Types ====

Installation Utility supports the following tool types:

{| class="wikitable"
! style="text-align:left;"| Tool Type
! style="text-align:left;"| Description
|- style="vertical-align: top;"
| BACKFILL=<image file> || An image that will be used to fill the Installation Utility window's background.
|- style="vertical-align: top;"
| LANGUAGE=<language> || Language that your installation script should use. In order to work, your installation script must support the supplied language.
|- style="vertical-align: top;"
| LOGO=<image file> || An image that will be displayed on top of every installation page.
|- style="vertical-align: top;"
| PACKAGENAME=<name> || This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory. (Default: ''package.py'')
|}

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' This page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' This page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Note:'' Installation Utility version 53.18 does not support page type PACKAGESELECT.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Note:'' On Installation Utility version 53.18 the page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' The Installation Utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' The Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.
: ''Note:'' Installation Utility version 53.18 does not support package types ARCHIVEPACKAGE and HANDLERPACKAGE.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T06:51:03Z

Janne Peräaho: /* NewPage */

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL
* LANGUAGE
* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' This page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' This page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Note:'' Installation Utility version 53.18 does not support page type PACKAGESELECT.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Note:'' On Installation Utility version 53.18 the page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' The Installation Utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' The Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.
: ''Note:'' Installation Utility version 53.18 does not support package types ARCHIVEPACKAGE and HANDLERPACKAGE.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T06:50:41Z

Janne Peräaho: Edited notes

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL
* LANGUAGE
* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' this page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' this page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Note:'' Installation Utility version 53.18 does not support page type PACKAGESELECT.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Note:'' On Installation Utility version 53.18 the page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' The Installation Utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' The Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.
: ''Note:'' Installation Utility version 53.18 does not support package types ARCHIVEPACKAGE and HANDLERPACKAGE.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T06:44:53Z

Janne Peräaho: /* NewPage */

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL
* LANGUAGE
* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' this page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' this page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Editor's note:'' There is a reservation for a page type PACKAGESELECT. However, NewPage can't create a PACKAGESELECT page.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Editor's note:'' The page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' the installation utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' the Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.
: ''Note:'' Installation Utility version 53.18 does not support package types ARCHIVEPACKAGE and HANDLERPACKAGE.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T06:39:59Z

Janne Peräaho: Added note on package types ARCHIVEPACKAGE and HANDLERPACKAGE

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL
* LANGUAGE
* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' this page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' this page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Editor's note:'' There is a reservation for a page type PACKAGESELECT. However, NewPage can't create a PACKAGESELECT page.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Editor's note:'' The page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' the installation utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' the installation utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.
: ''Note:'' Installation Utility version 53.18 does not support package types ARCHIVEPACKAGE and HANDLERPACKAGE.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T06:28:52Z

Janne Peräaho: /* SetObject */

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL
* LANGUAGE
* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' this page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' this page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Editor's note:'' There is a reservation for a page type PACKAGESELECT. However, NewPage can't create a PACKAGESELECT page.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Editor's note:'' The page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' the installation utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' the installation utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T04:26:01Z

Janne Peräaho: /* From the Command Line */

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL
* LANGUAGE
* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' this page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' this page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Editor's note:'' There is a reservation for a page type PACKAGESELECT. However, NewPage can't create a PACKAGESELECT page.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Editor's note:'' The page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' the installation utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' the installation utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || On a PROCESSOR type page, names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T04:24:35Z

Janne Peräaho: /* Tooltypes */

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

Installation Utility PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL
* LANGUAGE
* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' this page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' this page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Editor's note:'' There is a reservation for a page type PACKAGESELECT. However, NewPage can't create a PACKAGESELECT page.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Editor's note:'' The page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' the installation utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' the installation utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || On a PROCESSOR type page, names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.

Installation Utility

2022-07-28T04:23:59Z

Janne Peräaho: Added command template

= How the Installer Works =

== Basic Concept ==

The installation utility executes a python script that sets up the installation. In addition to standard Python commands the installation utility provides a module called "installer" and an interface to it. Using this interface you can create the different pages that can be found in almost all installation processes: a welcome page, a displayed licence page, a selection page, an installation page and finally a finish page.
In the end, there are only a few script commands required.

== Running an Installation Script ==

=== From the Command Line ===

Installation Utility PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

<pre>
"SYS:Utilities/Installation utility" PACKAGE=myscript.py LOGO=mylogo.png
</pre>
Note: the logo will be displayed all along the installation process.

''Note2: right now you need to set these argument names with capital letters, as shown above.''

=== From the Workbench ===

Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.

==== Tooltypes ====

* BACKFILL

-

* LANGUAGE

-

* LOGO

You can use this tooltype to specify an image name to use in the installer window.

* PACKAGENAME (Default: ''package.py'')

This tooltype is used to specify the script name to execute. It is useful if you want to use a standalone icon that will open a script with a different name or in another directory.

= Example Script =

A minimal install script looks like this:

<pre>
# Simple, basic installation script
from installer import *

# These will be used for the first page (welcome) and last page (finish)
welcomeText = "This is a welcome text, displayed at the first page"
finishText = "This is the finish message"

# Define the Welcome page
welcomePage = NewPage(WELCOME)
SetString(welcomePage, "message", welcomeText)

# Define the License page. The user must accept this license to continue the install process.
# The license text will be read from a text file called "license.txt" and will be displayed on the page.
licensePage = NewPage(LICENSE)

# Define a page to select the installation directory
destinationPage = NewPage(DESTINATION)
SetString(destinationPage, "message", "Please indicate where you want to install the files .")
SetString(destinationPage, "destination", "SYS:")

# Define a directory to be copied to the destination
filePack = AddPackage (FILEPACKAGE,
name = "Full directory",
description = "Directory to copy as-is in the destination",
files = ["data"],
optional = False
)

# Define a progress page that is shown during the installation
installPage = NewPage(INSTALL)

# Create a "finish" page.
finalPage = NewPage(FINISH)
SetString(finalPage, "message", finishText)

# Finally, this runs the installation.
RunInstaller()
</pre>

= Python Interface =

== Introduction ==

The installer is entirely programmed in Python. For this purpose, it provides a Python module called 'installer' that serves as a functional interface to the GUI. The entire GUI is build out of pages. Pages present different kind of information to the user. The installation can be navigated with a pair of forward/backward buttons to visit each page in turn. Certain pages (notably the INSTALL page) will trigger the installation process itself, although the interface is flexible enough to make an installation that is entirely driven by the Python script. A minimal setup function will create a "default" layout of pages for an installer. The basic is to have a single archive that is installed into a destination drawer created on the disk - about 90% of all installers will do exactly this. Therefore a lot of the mechanics involved in this type of installer is automated.

== Python Functions in the Installer Package ==

=== NewPage ===

<nowiki>pageId = NewPage( WELCOME|FINISH|DESTINATION|PACKAGESELECT|INSTALL|GUI|PROCESSING|LICENSE|README )</nowiki>

This function creates a new page and returns its page number for later reference. The only argument to the function is the type of page to create. Possible values are:

; WELCOME
: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
: ''Note:'' this page is mandatory.

; FINISH
: A message page that is specifically targeted at closing the installation. This page automatically gets the "finish" attribute set to make the installation change the "cancel" to the "finish" button.

; DESTINATION
: A page to select a directory to serve as the target for the installation.
: ''Note:'' this page is mandatory.

; PACKAGESELECT
: A page for selecting packages to be installed.
: ''Editor's note:'' There is a reservation for a page type PACKAGESELECT. However, NewPage can't create a PACKAGESELECT page.

; INSTALL
: The presence of this page automatically triggers the installation of the selected packages.

; GUI
: A page where GUI elements can be added and controlled via a Python handler.

; PROCESSING
: A page to display a simple progress bar for doing some Python-scripted processing.
: ''Editor's note:'' The page has no progress bar.

; LICENSE
: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
: ''Note:'' the installation utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

; README
: A page that displays a text file from disk for reference/README purposes.
: ''Note:'' the installation utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

If the page cannot be generated, an OSError exception is raised.

=== GotoPage ===

This function accepts a single argument, the page to display. This function should rarely be needed.

=== SetString ===

<nowiki>SetString( pageId, variable, content )</nowiki>

=== SetInteger ===

<nowiki>SetInteger( pageId, variable, content )</nowiki>

=== SetObject ===

<nowiki>SetObject( pageId, property, value )</nowiki>

SetObject allows you to change the properties of a page created with the NewPage function. The PAGEID argument tells which page's property will be changed (see the list of available properties below). The PROPERTY argument is the name of the property to be changed and VALUE is the value to be set for the property.

The following properties are available:
{| class="wikitable"
! style="text-align:left;" | Property
! style="text-align:left;" | Explanation
|-
| '''align''' || Page's header alignment: left, center, or right.
|-
| '''destination''' || On a DESTINATION type page, holds the default installation directory path. The path is visible in the page's target directory gadget.
|-
| '''entryhandler''' || Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|-
| '''message''' || Page's header content (plain text).
|-
| '''processor''' || On a PROCESSOR type page, names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
|}

=== GetString, GetInteger, GetObject ===

<nowiki>value = GetString( pageId, variable)</nowiki>

<nowiki>value = GetInteger( pageId, variable)</nowiki>

<nowiki>value = GetObject( pageId, variable)</nowiki>

These functions are the reverse of the above - they read a variable from the page specified as its first argument and the name specified as the second argument. They return a default value if the name was not found.

=== RunInstaller ===

<nowiki>RunInstaller()</nowiki>

This function runs the installer's main loop, and needs to be the last command in an installation. Any subsequent scripting is done via handlers connected to the pages.

=== AddPackage ===

<nowiki>packageId = AddPackage(
type = FILEPACKAGE|ARCHIVEPACKAGE|HANDLERPACKAGE
[,name = <name>]
[,description = <description>]
[,optional = False|True]
[,selected = False|True]
[,diskspace = <diskspace>]
[,featuregroup = <bitmask>]
[,alternatepath = <path>]
[,files = <file list>]
)</nowiki>

This function adds a package to the list of installable packages. The function's interface uses keywords to make it more readable. The keywords are:

; type
: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
: This argument MUST be given.

; name
: A string that specifies the name of the package. This name is presented to the user of the installer on a PACKAGESELECT page.
: A name should be given. It defaults to an empty string.

; description
: A textual description of the package. It is presented to the user next to the package list on a PACKAGESELECT page if the package is selected in the package list.
: The description may be empty, although it is consider bad style. It defaults to an empty string.

; optional
: A boolean value indicating whether the package is optional to install or required to be installed. A value of True means the package is optional.
: Default is True (package is optional)

; selected
: A boolean indicating whether the package should be pre-selected or not. If True, the package is selected the first time the PACKAGESELECT page is entered.
: Default is True (package is selected), although the user might deselect the package on a PACKAGESELECT page

; diskspace
: An integer value specifying the number of bytes the package occupies after installation. If a zero size is given (or the parameter is omitted) the installer tries to figure out the size requirements automatically, but be warned this might be a time consuming process.
: Defaults to zero (try to figure out yourself)

; featuregroup
: An integer bitmask giving one bit of each feature group defined. A one bit indicates this package is part of the group, while a zero bit indicates it isn't.
: Defaults to zero (not in any feature group)

; alternatepath
: Specifies an alternative installation path. For example, some files might need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
: Defaults to None (i.e. no alternate path)

; files
: A list of strings, each string representing one file associated with this package. The interpretation of these files depend on the package type:
:: ARCHIVEPACKAGE: each file is an archive that is supposed to be extracted into the destination.
:: HANDLERPACKAGE: The strings are not interpreted in any way, it is up to the handler to do that.
:: FILEPACKAGE: Each string stands for a file or directory to be copied. Files are straight copies, while directory names are interpreted slightly different: if a directory name is given, that entire directory is copied to the destination, including the directory itself. For example, if you specify "System" then the destination directory will include a "System" directory. On the other hand, if you specify it as "System/" with a trailing slash, the content of the directory will be copied but not the directory itself, i.e. the destination directory would contain all the file and directories in the "System" directory but not the directory itself.
:: ''Note:'' directory/file names must be relative to the current directory i.e. where the installer is executed. You cannot use here a complete path name with the volume name like ''RAM:mydir''.
: The default is an empty list.

The result of this function is a package number, which can be used subsequently to adjust package settings or query certain features.

=== SetPackageOption ===

<nowiki>SetPackageOption( packageId, option, value )</nowiki>

This function allows you to set package options. It accepts three parameters:
* package number
* option to set
* value

=== SelectPackage ===

<nowiki>SelectPackage( packageId, False|True )</nowiki>

Select or deselect a package for installation.

=== IsPackageSelected ===

<nowiki>selected = IsPackageSelected( packageId )</nowiki>

Queries if a package is selected.

=== AddPostInstallAction ===

<nowiki>AddPostInstallAction( action )</nowiki>

Add a post install action for the installation.

=== GetDeviceList ===

<nowiki>deviceList = GetDeviceList()</nowiki>

Get a list of mounted devices.

== GUIs ==

GUIs must be created from scratch using a procedural interface. The following procedures deal with creating and handling the user interface. In general, the user interface must be generated once and cannot be changed afterwards (with exceptions, see below).

=== Creating a GUI ===

<nowiki>StartGUI( pageNumber )</nowiki>

<nowiki>EndGUI()</nowiki>

A GUI is started with a call to '''StartGUI( pageNumber )'''. This will start to create a GUI on the indicated page number, and all subsequent calls will add to this GUI until '''EndGUI()''' is called. If the indicated page number is invalid or is not a GUI page, ever subsequent calls are ignored until a new StartGUI with a valid page number is called.

Immediately after the call, a single GUI object might be defined. In almost all cases, this will be a group to hold a number of GUI elements.

=== Grouping UI Elements ===

<nowiki>BeginGroup(
[orientation = GROUP_VERTICAL|GROUP_HORIZONTAL]
[,label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
)</nowiki>

<nowiki>EndGroup()</nowiki>

Groups are defined with the '''BeginGroup''' and '''EndGroup''' calls. BeginGroup takes the following keyword arguments:
:; orientation
:: This specifies whether the children of this group are laid out vertically (GROUP_VERTICAL) or horizontally (GROUP_HORIZONTAL). By default the layout is vertically.

:; label
:: A short text string that can be displayed as a label for this group. The label is only used if a frame other than NONE_FRAME is specified. By default no label is used.

:; frame
:: One of the constants NONE_FRAME, THIN_FRAME, BUTTON_FRAME, GROUP_FRAME, FIELD_FRAME, DROPBOX_FRAME, SBAR_HORIZ_FRAME, SBAR_VERT_FRAME, BOX_FRAME, STANDARD_FRAME. They directly correspond to the bevel styles of bevel.image. Defaults to NONE_FRAME.

:; weight
:: An integer defining the weighted width or height of this group. This corresponds to layout.gadget's CHILD_WeightedWidth or CHILD_WeightedHeight tags, depending on the layout direction.

EndGroup has no parameters and automatically terminates the last group opened by BeginGroup.

=== UI Elements ===

User interface elements are added with the following calls. All of these return an ID number.

==== AddLabel ====

<nowiki>AddLabel(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,align = ALIGN_LEFT|ALIGN_RIGHT|ALIGN_CENTER|ALIGN_BLOCK]
)</nowiki>

This call adds a text label, with selectable frame. The following keyword arguments are supported:
:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; frame
:: A frame to put around the label.

:; weight
:: The weight of the label, as explained above.

:; align
:: Text alignment to use for the label. Possible values are: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_BLOCK

==== AddString ====

<nowiki>AddString(
[label = <label>]
[,value = <value>]
[,weight = <weight>]
[,handler = <callable object>]
)</nowiki>

:; label
:: A string that specifies the label to be displayed. Default is empty, although an empty label doesn't make much sense

:; value
:: Value to use as the default string

:; weight
:: The weight of the label, as explained above.

:; handler
:: A Python callable object that is invoked when the string field is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

==== AddButton ====

<nowiki>buttonId = AddButton(
[label = <label>]
[,frame = NONE_FRAME|THIN_FRAME,|BUTTON_FRAME|GROUP_FRAME|FIELD_FRAME
|DROPBOX_FRAME|SBAR_HORIZ_FRAME|SBAR_VERT_FRAME|BOX_FRAME|STANDARD_FRAME]
[,weight = <weight>]
[,onclick = <callable object>]
)</nowiki>

This call adds a push button object to the current group. The function supports the following keyword arguments:
:; label
:: A string specifying the label to be displayed within the button. Defaults to an empty label.

:; frame
:: One of the constants mentioned above for the group. Defaults to BUTTON_FRAME.

:; weight
:: As above

:; onclick
:: A Python callable object that is invoked when the button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id) where page_number is the page number of the GUI page and element_id is the element id returned by this call.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddCheckBox ====

<nowiki>checkBoxId = AddButton(
[label = <label>]
[,weight = <weight>]
[,checked = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a checkbox object to the GUI. The following keyword arguments are valid:

:; label
:: A string that appears as a label to the right of the checkbox. Defaults to an empty label.

:; weight
:: As above

:; checked
:: An integer that specifies whether the checkbox is initially checked or not. A zero means the checkbox is clear, any other value says the box is checked.

:; onclick
:: A python callable object that is invoked when the checkbox is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, state) where page_number and element_id are the same as above, and state is a 0 if the user just unchecked the checkbox, or a 1 is it was just checked.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddRadioButton ====

<nowiki>radioButtonId = AddRadioButton(
<label list>
[,weight = <weight>]
[,selected = False|True]
[,onclick = <callable object>]
)</nowiki>

This call adds a set of mutually exclusive radio buttons. The following keyword arguments are valid:

:; label list
:: A list of Python strings, with each of these strings appearing as a choice on the Radio buttons. This parameter is required.

:; weight
:: As above

:; selected
:: The number of the button initially selected. Defaults to the first button (0).

:; onclick
:: A python callable object that is invoked when the radio button is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the button number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddChooser ====

<nowiki>chooserId = AddChooser(
[label = <label>]
[,choices = <list>]
[,weight = <weight>]
[,selected = False|True]
[,mode = CHOOSER_POPUP|CHOOSER_DROPDOWN]
[,onclick = <callable object>]
)</nowiki>

This function adds a chooser gadget to the GUI. The following keyword arguments are valid:

:; label
:: A test string to be displayed in the chooser in pop-up mode (see below). Defaults to an empty string, and is not used for drop-down mode.

:; choices
:: A list of text strings to be displayed as choices for the chooser. This argument is mandatory.

:; weight
:: As above

:; selected
:: The number of the currently visible item in drop-down mode. Defaults to 0.

:; mode
:: One of the constants CHOOSER_POPUP or CHOOSER_DROPDOWN. This corresponds to the chooser.gadget CHOOSER_PopUp and CHOOSER_DropDown tag items.

:; onclick
:: A python callable object that is invoked when the chooser is clicked. The call is made with the following parameters:
::: handler(page_number, element_id, selected) where page_number and element_id are the same as above, and selected is the title number that was selected.

The call returns an id that can be used to construct the variable name for handling attributes of this object.

==== AddSpace ====

<nowiki>AddSpace([weight = <weight>])</nowiki>

This call adds a bit of space to the GUI. It accepts only one parameter:

:; weight
:: An integer specifying the weight of the space. Defaults to 1.

The call does not return a value. Space does not have any variables.

=== UI Element Settings ===

<nowiki>value = GetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK )</nowiki>

<nowiki>SetUIAttr( pageId, elementId, GUI_LABEL|GUI_SELECTED|GUI_CHECKED|GUI_ONCLICK, <value> )</nowiki>

In order to change some aspects of user interface elements (like the selection status of a checkbox) or read their current state, two functions exist called '''GetUIAttr''' and '''SetUIAttr'''.

The former reads an attribute from an identified user interface element (identified by the page number and element id) while the latter sets (and updates the on-screen representation) of an equally identified element.

A number of attributes can be set and gotten from UI elements; some of them are shared among more than one element type, while others are specific. The following list names the attributes:

; GUI_LABEL (string)
: The label displayed on a UI element.
: Applies to BUTTON, LABEL, GROUP, CHECKBOX

; GUI_SELECTED (integer)
: The selected item in a chooser or radio button.
: Applies to CHOOSER and RADIOBUTTON

; GUI_CHECKED (integer)
: Whether the checkbox checkmark is set or not.
: Applies to CHECKBOX

; GUI_ONCLICK (Python callable)
: The handler invoked when the UI element is activated.
: Applies to CHOOSER, BUTTON, LABEL, GROUP, CHECKBOX, RADIOBUTTON

= Hints =

* See the AmigaOS 4 installation script on the AmigaOS Installation CD. It is a big script full of functions. Take it as example and experiment.