Terminology
The following /
additions indicate how a parameter must be used:
/A
The argument is required and may not be omitted.
/K
The argument must be given with the keyword and may not be used positionally.
/S
The keyword is a switch and takes no argument.
/M
Multiple argument.
/N
Numeric argument.
/F
The argument must be the last on the row.
The ?
character after a command will print help for the command in case some help documentation exists.
Addbuffers
Format: Addbuffers Drive/A Buffers/N
Purpose: To add memory to floppy disk buffers to improve speed.
Parameters:
Example: Addbuffers DF0: 10
AddDatatypes
Format: AddDataTypes files/M QUIET/S REFRESH/S
Purpose: To activate datatypes or adds another datatype.
Parameters:
Example: AddDataTypes gif.datatype REFRESH
Alias
Format: Alias Name String/F
Purpose: To assigns a short name to a command.
Parameters:
Example: Alias Del Delete
Ask
Assign
Format: Assign Name Target/M LIST/S EXISTS/S DISMOUNT/S DEFER/S PATH/S ADD/S REMOVE/S VOLS/S DIRS/S DEVICES/S
Purpose: To assign names to directory paths.
Parameters:
Name: Name of the assign
Target: Directory path
List: Display list of assigns
Exists: Test if assign exists (use IF WARN)
Dismount: Remove assign
Defer: Assign later
Path: Add assign with path,
Add: Add a new target to existing path (like LIBS:)
Remove: Remove an assign
Vols: List volumes
Dirs: List directories
Devices: List devices.
Example: Assign PPaint: DH0:PPaint
Avail
Binddrivers
Break
CD
ChangeTaskPri
Format: ChangeTaskPri Pri=Priority/A/N Process/K/N
Purpose: To change a program's execution priority (see Status).
Parameters:
Example: ChangeTaskPri 2 1
Conclip
Copy
Format: Copy From/M To/A ALL/S QUIET/S BUF=BUFFER/K/N CLONE/S DATES/S NOPRO/S COM/S NOREQ/S
Purpose: To copy files to another file or to another directory (with/without protection bits).
Parameters:
From: Files to copy
To: Directory or file to copy to
All: Copy all files
Quiet: No output
Buffer: Size of buffer (default: 100K)
Clone: Copy file and dates-tamp, protect bits and comment
Dates: Copy date-stamp as well
NoPro: Set default protection bits
Com: Copy comment
NoReq: No requester popups.
Example: Copy mydoc.txt docs: Dates
CPU
Format: CPU CACHE/S BURST/S NOCACHE/S NOBURST/S DATACACHE/S DATABURST/S NODATACACHE/S NODATABURST/S INSTCACHE/S INSTBURST/S NOINSTCACHE/S NOINSTBURST/S COPYBACK/S NOCOPYBACK/S EXTERNALCACHE/S NOEXTERNALCACHE/S FASTROM/S NOFASTROM/S NOMMUTEST/S CHECK/K
Purpose: To change or display CPU settings e.g. caches, burst, fastrom. Useful for some backward compatibility.
Parameters:
Cache, NoCache, DataCache, InstCache, NoDataCache, NoInstCache: Turn all or some caches on of off
Burst, NoBurst, DataBurst, InstBurst, NoDataBurst, NoInstBurst: Turn all or some burst modes on or off
CopyBack, NoCopyBack: Enable/disable copyback mode for 68040
ExternalCache, NoExternalCache: Enable/disable external cache for 68040
FastRom, NoFastRom: Copy ROM Fast memory or not
NoMMUTest: Don't check for MMU
Check: Check cpu.
Example: CPU INSTCACHE FASTROM
Date
Format: Date Day Date Time To=Ver/K
Purpose: To display or change the date or time.
Parameters:
Example: Date To=date.txt
Delete
Format: Delete File/M/A ALL/S QUIET/S FORCE/S
Purpose: To delete files or directories.
Parameters:
Example: Delete OldFilesDir All
Dir
Diskchange
Diskcopy
Format: Diskcopy From/A To/A Name/K NOVERIFY/S MULTI/S
Purpose: Duplicates disk to another disk.
Parameters:
Example: Diskcopy DF0: to DF1:
DiskDoctor
Echo
Format: Echo String/M NOLINE/S FIRST/K/N LEN/K/N TO/K
Purpose: To display text in a script or part of a string of text.
Parameters:
Example: Echo "Enter your name: " NoLine
Ed
Format: ED From/A Size/N With/K Window/K Tabs/N Width=Cols/N Height=Rows/N
Purpose: To edit text files using a screen editor.
Parameters:
From: File to Edit
Size: Size of Memory for file
With: Extended commands file
Window: Console window (e.g. *: current)
Tabs: Tab size
Width: Number of columns
Height: Number of rows.
Example: ED S:User-Startup
Edit
Format: Edit From/A To With/K Ver/K Opt/K Width/N Previous/N
Purpose: To edit text files using a line editor.
Parameters:
Example: Edit s:User-Startup With Ed-Script
Else
If Exists s:User-Startup
Say "User Startup already exists"
Else
Ed s:User-Startup
Endif
Endcli
Endif
If $Age GT 65
Say "You are a pensioner!"
Endif
Endskip
Eval
Format: Eval Value1/A Op Value2/M To/K LFormat/K
Purpose: To evaluate a simple arithmetic expression.
Parameters:
Value1, Value2: Values to evaluate (Decimal, Hex (0xn) or Octal (0nnn)
Op: Operation (+,-,*,/,^,%)
To: File to save result
LFormat: Output format string (use *n to give a line feed).
Example: Eval $count + 1 to env:count
Execute
Failat
Format: Failat RCLIM/A
Purpose: To change the failure limit for scripts (0,5,10,20) (0 - Ok, 5 - Warn, 10 - Error, 20 - Fail).
Parameters:
Example: Failat 20
Fault
FF
FileNote
Format: Filenote File/A Comment ALL/S QUIET/S
Purpose: To attach a comment to a file (see LIST).
Parameters:
Example: FileNote List.txt "A list of people's names"
Format: Format Device=Drive/K/A Name/K/A OFS/S FFS/S INTL=INTERNATIONAL/S NOINTL=NOINTERNATIONAL/S DIRCACHE/S NODIRCACHE/S NOICONS/S QUICK/S
Purpose: Program to initialise Amiga disks
Location: System folder
Parameters:
Device, Drive: Disk device or name to format
Name: New volume name
OFS: Old Filing System
FFS: Fast File System
Intl, International: FFS International mode
NoIntl, NoInternational: International mode off
DirCache, NoDirCache: Directory caching on or off
NoIcons: No disk or trash icons
Quick: Less thorough format
Example: Format Drive DF0: Name "Docs" NOICONS FFS
Get
Getenv
Iconx
If
Format: If NOT/S WARN/S ERROR/S FAIL/S EQ/K GT/K GE/K VAL/S EXISTS/K
Purpose: If the econdition is true then execute following commands until an ELSE or ENDIF statement occurs.
Parameters:
Not: Reverse boolean result
Warn: Test warn flag from previous command
Error: Test error flag from previous command
Fail: Test fail flag from previous command
EQ: Equality test
GT: Greater than test
GE: Greater or equal test
VAL: Input is a number
Exists: Test file exists.
Example: IF WARN, IF $count GT 10, IF EXISTS C:List
Info
Install
Format: Install Device/A NOBOOT/S CHECK/S FFS/S
Purpose: Program saves a bootblock to a disk. If you have only one drive then type INSTALL ? and then swap disks and then type DF0: and press RETURN to save the bootblock.
Parameters:
Device: Disk to install bootblock
NoBoot: Erase bootblock
Check: Test for bootblock
FFS: Use Fast File System.
Example: Install DF0:
IPrefs
Join
Format: Join File/M/A AS=TO/K/A
Purpose: Program to join two or more files together.
Parameters:
Example: Join File1 File2 File3 as FileFull
Lab
List
Format: List Dir/M P=PAT/K KEYS/S DATES/S NODATES/S To/K Sub/K Since/K Upto/K QUICK/S BLOCK/S NOHEAD/S FILES/S DIRS/S LFORMAT/K ALL/S
Purpose: Program which lists file details in a directory.
Parameters:
Dir: One or more directory name(s)
Keys: Display keys
NoDates: Do not display dates
To: Destination file
Sub: Subdirectories included
Since: List files since date given
Upto: List files upto given date
Quick: Simple directory list
Block: List files in block sizes
NoHead: Do not display header lines
Files: Files only
Dirs: Directorys only
LFormat: Output list using this format string
All: All files.
Example: List Workbench: Block Dates Since=01-Jul-00
LoadWB
Lock
Format: Lock Drive/A ON/S OFF/S Passkey
Purpose: Program to lock or unlock a device from writing to it..
Parameters:
Example: Lock DH1: On GHK459
MagTape
Format: MagTape Device/K Unit/N/K RET=RETENSION/S REW=REWIND/S SKIP/N/K
Purpose: Program controls a magnetic tape device.
Parameters:
Example: Magtape Device TAPE1: Unit 0 REWIND
MakeDir
MakeLink
Format: MakeLink From/A To/A HARD/S FORCE/S
Purpose: To create a logical link between two files.
Parameters:
Example: MakeLink T C:Type Hard
Mount
Newcli
Format: Newcli Window From
Purpose: To open a new Command Line Interface console (CON) window. Window format: CON:X/Y/Width/Height/Name/Option(s).
Options: Auto,Backdrop,Noborder, Nodrag,Simple, Smart,Wait,Close
Parameters:
Example: Newcli CON:0/10/400/200/Shell/CLOSE
NewShell
Format: NewShell Window From
Purpose: To open a new shell (CON) window.
Parameters:
Example: NewShell From S:Shell-Startup
Path
Prompt
Format: Prompt Prompt
Purpose: To change the command prompt text (Codes: %R: last return code, %S: Current path, %N: CLI Number).
Parameters:
Example: Prompt "%N.%S> "
Protect
Format: Protect File/A Flags ADD/S SUB/S ALL/S QUIET/S
Purpose: To change the protection' flags of a file. (r=read,w=write, e=execute,d=delete,s=script,p=pure)
Parameters:
Example: Protect Editor rwed
Quit
Relabel
Format: Relabel Drive/A Name/A
Purpose: To change the name of a disk.
Parameters:
Drive: Disk to change
Name: New volume name
Example: Relabel DF0: "Documents"
RemRAD
Rename
Format: Rename From/A/M To=As/A QUIET/S
Purpose: To rename a file another file name or move a file to another directory.
Parameters:
From: Old filename
To, As: New filename
Quiet: No output.
Example: Rename MyDoc as MyDoc.doc
RequestChoice
Format: RequestChoice Title/A Body/A Gadgets/M PubScreen/K
Purpose: To ask a user for input via a requester dialog box.
Parameters:
Title: Title for dialog box
Body: Text for dialog box
Gadgets: List of buttons
Pubscreen: Screen to use.
Example: RequestChoice >ENV:RT "Format" "About to format your hard disk*nAre you sure?" "Go ahead" "No way!"
RequestFile
Format: RequestFile Drawer File/K Pattern/K Title/K Positive/K Negative/K AcceptPattern/K RejectPattern/K SAVEMODE/S MULTISELECT/S DRAWERSONLY/S NOICONS/S PUBSCREEN/K
Parameters:
Drawer: Initial drawer to use
File: Initial file name
Pattern: Use pattern as filter
Title: Title of dialog box
Positive: Text for OK button
Negative: Text for Cancel button
AcceptPattern: Defines file pattern(s) to show (overrides Pattern)
RejectPattern: Pattern(s) of files to hide
SaveMode: Change colours to indicate Save or other mode
MultiSelect: Allow multiple file selection
DrawersOnly: Display only directories
NoIcons: Suppress info files
PubScreen: Screen to use.
Purpose: To ask a user for a filename via a file requester.
Example: RequestFile >ENV:File Title "Select a File" Positive "Load" Noicons
Resident
Format: Resident Name File REMOVE/S ADD/S REPLACE/S PURE=FORCE/S SYSTEM/S
Purpose: To store an AmigaDOS command in memory (quicker than reloading from disk each time it is executed). To ensure that a command can be made resident, check the pure flag (see List).
Parameters:
Name, File: File to be made resident
Remove: Remove file from resident list
Add: Add file to resident memory
Pure, Force: Force a non-pure file to be resident
System: Show system's resident code segments.
Example: Resident C:Dir Pure
Run
Search
Format: Search From/M Search/A ALL/S NONUM/S QUIET/S QUICK/S FILE/S PATTERN/S
Purpose: To search for a string in a file or search for a file on a disk.
Parameters:
From: Directory to search from
Search: Text to search for
All: Search sub-directories
NoNum: Line numbers are not displayed
Quiet: No Output
Quick: Reduce output listing
File: Search a file rather than content
Pattern: Search using a pattern.
Example: Search SYS: "List" File All
Set
Format: Set Name String/F
Purpose: To set or list a local environment variable (local to current shell or current process).
Parameters:
Example: Set MyName "Peter"
SetClock
Format: Setclock LOAD/S SAVE/S RESET/S
Purpose: To load or set the date and time from a battery-backed clock.
Parameters:
Example: Date 27-Nov-00 10:00, SetClock Save
SetDate
Format: Setdate File/A Weekday Date Time ALL/S
Purpose: To set the date of a file or a directory (see List).
Parameters:
File: File to change
Weekday: Day of week
Date: Date
Time: Time
All: All files.
Example: Setdate DEVS: Monday 10:30
Setenv
Format: Setenv Name String/F
Purpose: To change the contents of a environment variable.
Parameters:
Example: Setenv Workbench "3.1"
Setfont
Format: Setfont Name/A Size/N/A SCALE/S PROP/S ITALIC/S BOLD/S UNDERLINE/S
Purpose: To set the console font.
Parameters:
Name: Font name
Size: Font size
Scale: Scale font to size
Prop: Specify if a Proportional font
Italic: Use italic font
Bold: Use bold font
Underline: Use underlined font.
Example: SetFont Courier 15 Bold
SetKeyboard
Format: Setkeyboard Keymap/A
Purpose: To set the keyboard layout using layout files in Devs:Keymaps. You can use the Input preferences instead.
Parameters:
Example: SetKeyboard USA0
SetMap
SetPatch
SetPatch
Format: Setpatch QUIET/S NOCACHE/S REVERSE/S NONSD/S NOAGA/S PATCHCONFIGFILE=PCF/K PATCHCONFIGLINE=PCL/K PATCHINFO=PI/S FORCEUPDATE/S KILLUPDATE/S NOROMUPDATE/S DISABLEROMMODULES/S SKIPROMUPDATES=SKIPROMMODULES/K WAITFORVALIDATE/S AVOIDMEMFKICKFORPATCHES/S
Purpose: To patch Operating System functions, enable or disable rom updates, disable HD NDS mode, wait for disk validation and remove bugs (44.38).
Parameters:
Quiet: No output
NoCache: Cache off
Reverse: Reverse action of setpatch
NoNSD: No New Style Device (Large HD support)
PatchConfigFile: Specify a patch config file
PatchConfigLine: Specify a Patch Config line
PatchInfo: Show patch information
ForceUpdate: Install updates despite something installed earlier
NoRomUpdate: Do not install ROM updates
DisableRomModules: Remove some ROM modules (can cause a crash)
SkipRomUpdates: Skip following updates
WaitForValidate: Waits for all volumes to be validated
AvoidMemFKickForPatches: Ignore MemFKick for Patches.
Example: Setpatch NOROMUPDATE NONSD QUIET
Skip
Sort
Format: Sort From/A To/A Colstart/K CASE/S NUMERIC/S
Purpose: To sort a file and output results to a new file.
Parameters:
From: File to sort
To: Output file
Colstart: Column to sort from
Case: Upper case entries are done first
Numeric: Input treated as numbers.
Example: Sort Figures To SortedFigures Numeric
Stack
Status
Type
Unset
UnSetEnv
Unalias
Version
Format: Version Name Version/N Revision/N FILE/S FULL/S Unit/N INTERNAL/S RES/S
Purpose: To display workbench, library or device version information.
Parameters:
Name: File
Version: Print Kickstart or Workbench number and sets env variables and sets Warn flag
Revision: As Version but for Revision number
File: Check file rather than memory
Full: Display full information
Internal: Check internal files
Res: Check resident files.
Example: Version kickstart Version=39 Revision=106
Wait
Format: Wait Time/N SEC=SECS/S MIN=MINS/S UNTIL/K
Purpose: To wait for a specified period of time.
Parameters:
Example: Wait Until 12:00
Which
Why