Boing Ball  Amiga Emulator FAQ

AmigaDOS Commands

Updated: 16/07/2023

These are the AmigaDOS commands for AmigaOS 4 found in the C directory with an explaination of the command and an example.
See other AmigaOS commands here.

AddAudioModes
Format: AddAudioModes Files/M Quiet/S Refresh/S Remove/S DblScan/S
Purpose: Add additional audo modes from DEVS:Audiomodes to audio system.
Parameters: File =Audio mode files to add, Quiet = suppress output,
Refresh = restores original mode files, Remove = Remove all audio modes,
Dblscan = open and close a double-scan screen.
Example: AudioModes Paula Quiet

AddNetInteface
Format: AddNetInterface Interface/M Quiet/S Timeout/K/N
Purpose: Add a network interface to the protocol stack
Parameters: Interface = Name of interface to add, Quiet = suppress output,
Timeout = for DHCP, time taken for configuration to complete (10 secs or mre , 60 secs default)
Example: AddNetInterface Ethernet Quiet

AddNetRoute
Format: Quiet/S DST=Destination/K, HostDst=HostDestination/K, NetDST=NetDestination/K VIA=Gateway/K, Default=DefaultGateway/K
Purpose: To define routes to hosts or networks via an interface.
Parameters: Quiet = suppress output, DST = Destination address of a root e.g. IP address or name,
HostDst = A host address destination, NetDest = A network address destination, Default = Default gateway address or name.
Example: AddNetRoute HostDst 192.168.10.12 Via 192.168.1.1

AppListInfo
Format: AppListInfo Filename/S
Purpose: Display information about program file and whether it is a 68k load file or not.
Parameters: Filename = Path of program.
Example: AppListInfo sys:utilities/notepad

Arp
Format: Arp ALL/S Delete/S Set/S Hostname Address Temp/S Pro=Publish/S Proxy/S File/K NoNames/S=Numbers/S
Format 2: Arp -a -d -s Hostname Address -f file -n
Purpose: Display or set Address Resolution Protocol table.
Parameters:
All or -a = Display all arp entries.
Delete or -d = Delete an arp entry for Hostname.
Set or -s = Create new arp entry with Hostname and Address.
Hostname = Name of host.
Address = Hardware address.
Temp = Add a temp arp entry.
Pub or Publish = Arp entry will be published, host acts as arp server.
Pro or Proxy = Adds a proxy arp entry.
File or -f = Add entries from a file (format: hostname address [TEMP] [PUB]).
Nonames or Numbers = Show network addresses as numbers.
Example: Arp Set Mercruy 00:40:55:FE:90:12

BuildMapTable
Format: BuildMapTable ascii-map-table [CHARSET]
Purpose: Convert Charset to Unicode mapping tables to mapping tables in binary format for diskfont library.
Table contains index and Unicode code with optional comments starting with '#' sign.
Parameters: Ascii-map-table = text file, Charset = Specify a mime charset name or alias.
Example: BuildMapTable CP1258.txt

CacheStat
Format: CacheStat [Verbose/S]
Purpose: Display information on system caches.
Parameters: Verbose = More information.
Example: CacheStat

CharSetConvert
Format: CharSetconvert From/A FromCharset/A To ToCharset EOL/K
Purpose: Converts one character set into another.
Parameters, From = Source charset filename, FromCharset = name of charset,
To = output file, ToCharset = name of output charset, EOL = convert end of line to CR, LF or CRLF.
Example: CharSetConvert russian KOI8-R russian-ISO ISO-8859-5 EOL=LF

Clip
Format: Clip UNIT/N/K WAIT/S GET/S PUT/S COUNT/S TEXT
Purpose: To read and write data to the clipboard.
Parameters: U or UNIT = which clipboard upit to use, W or WAIT = wait for data to be filled (used with GET),
GET = Retreive text from given clipboard unit, PUT or SET = write text to clipboard unit,
COUNT = number of clipboard units that contain data, TEXT = text to place in clipboard.
Example: CLIP Put "Some text string" UNIT 2

CmiBoost
Format: CmiBoost
Purpose: To boost microphone input.
Example: CmiBoost.

ConfigureNetInterface
Format: ConfigureNetInterface Interface/A Quiet/S Address/K Netmask/K BroadcastAddr/K Destination/K Metric/K/N MTU/K/N
AliasAddr/K DeleteAddr/K Online/S Offline/S Up/S Down/S Debug/K Complete/K Configure/K Lease/K Release//S ID/K Timeout/KN
DhcpUnicast/K
Purpose: Configure a network interface e.g. ethernet.
Parameters: Interface = name of interface (required), Quiet = do not display messages, Address = IP Address, NetMask = subnet mask,
BroadcastAddr = Broadcast address, Destination[Addr] = Point-to-point partner, Metric = metric value, MTU = max transmission size,
AliasAddr = Add another address to interface, DeleteAddr = remove alias address, Online/Offline/Up/Down = Change state of interface,
Debug = enable debug output (value = Yes or No), Complete = Interface configuration is complete (value = Yes or No),
Release[Address] = Release DHCP assigned address, Timeout = timeout value (60 secs), Lease = set lease period, ID = name of local host
(see Configure=DHCP), Dhcpunicast = Enable unicast (value = Yes or No)
Example: ConfigureNetInterface ethernet Address 10.0.0.5 Netmask 255.255.255.0 Destination 10.0.0.1

CountLines
Format: Countlines Name/A/M
Purpose: count nmber of lines in one or more files.
Parameters: Name = filename(s)
Example: Countlines Atextfile.txt

Cut
Format: Cut String/A Char/K Word/S Seperator
Purpose: To extract characters or words from a string.
Parameters: String = Text to cut from, Char = start and end character positions, Word = Word to extract, seperator = Defines start/end boundaries.
Example: Cut "Hello World" Char=7-11 = World

DeleteNetRoute
Format: DeleteNetRoute Quiet/S Destination/K DefaultGateway/K
Purpose: To remove a route defined for your network.
Parameters: Quiet = Supress messages, Destination = Destination network to be deleted, DefaultGateway = The gateway address to be deleted.
Example: DeleteNetRoute 192.168.0.1

Dismount
Format: Dismount Device/A Soft/S Force/S
Purpose: To shutdown and remove a file system.
Parameters: Device = device or disk to dismount, Soft =dismount only, Force = Remove filesystem from memory and dismount.
Example: Dismount DH0: Soft

DumpDebugBuffer
Format: DumpDebugBuffer File Clear/S
Purpose: To dump debug output to the shell window.
Parameters: File = Optional file to dump debug information to, Clear = empties debug buffer.
Example: DumpDebugBuffer

FC-Cache
Format: FC-Cache -E=--Error-on-no-fonts -f = --force -r = --really_force -s = --system-only -v = --verbose -V = --version -h = --help -y =
--systemroot Directory/M
Purpose: To build Freetype font information cache files.
Parameters: -E = display error if no fonts found, -f = scan directories with valid caches, -r = erase and rescan caches, -s = scan system-wide dirs,
-y = prepend sysroot to all paths, -v = display status information, -V = display version no., -h = display command help, Directory = dir to scan.
Example: Fc-Cache -v

FC-Cat
Format: FC-Cat -r = --recurse -v = --verbose -V = --version -h = --help FILE/M DIRECTORY/M
Purpose: Read FreeType information cache files and display it in ASCII format.
Parameters: -r = recurse into sub-directories, -v = show detailed information, -V = show program version, -h = display command help,
FIle = fonts cache2 files, directory = directory to scan.

FC-List
Format: FC-List -v = --verbose -q = --quiet -V = --version -h = --help -f = --format PATTERN ELEMENT/M
Purpose: List available FreeType fonts.
Parameters: -v =display output of font pattern, -q = suppress output, -V = show program version, -h = display command help, -f = format output depending on format string, Pattern = Display fonts matching pattern, Element = Display elements for matching fonts.
Example: FC-List :lang=hi

FC-Match
Format: FC-Match -s = --sort -a = --all -v = --verbose -V = --version -h = --help -f = --format PATTERN ELEMENT/M
Purpose: Display best matching FreeType font using patterm rules.
Parameters: -s = display sorted list of fonts, -a = display sorted list of best matching fonts, v =display output of font pattern, -V = show program version, -h = display command help, -f = format output depending on format string, Pattern = Display fonts matching pattern, Element = Display elements for matching fonts.
Example: FC-Match --sort

FDTool
Format: FDTool Unit/K/N Debug/K/N Auto/S Manual/S Checknow/S Info/S Version/S
Purpose: Control and examine status of the floppy drives.
Parameters: U or Unit = Floppy drive unit (0,1, ...), D or Debug = Set debug level (0-30), A or Auto = Auto checking, M or Manual = Stop auto checking, C or CheckNow = Force a single disk check, I or Info = display info about device, V, Vers or Version = FDTool and device versions.
Example: FDTool Unit=0 Debug=1 Checknow

FileSize
Format: FileSize Files/M From/K All/S Report/S Format/K
Purpose: Collect size information on files and add up the number of files, bytes and blocks used.
Parameters:Files = List of files, directories or wildcard patterns, From = Text file containing names of files, dirs or patterns to examine, All = Examine dirs and subdirectories, Report = Print progress reports on dir contents, Format = String containing form for filesize output e.g. %b = blick %l = bytes, %f = no of files.
Example: FileSize Sys:utilities All Report Format "%l"

FlashTool
Format: FlashTool Command Args/M
Purpose: To read, write and erase EEPROM memory chips.
Parameters: Command to send (-p, -t, -e, -b, -s, -w, -c, -l, -v) , Args = Arguments for command.
Example: FlashTool -e slide-device 0

ForEach
Format: ForEach Name Path/K In/M From/K/N Step /K/N Script/K Com/K With/K All/S Files/S Dirs/S Since/K Upto/K
Purpose: Runs a script for each file encountered.
Parametrs: Name = variable name where content is from IN list, Path = variable where path is stored, All = recursive, Files = process only files in the IN list, Dirs = Process only directories in the IN list, Com = single command to execute, Script = Script file to execute, With = file with list of names, From To Step = Specify numeric range with increment steps, Sort = Sort name list before processing, Since Upto = Date comparisons.
Example: ForEach i into qwe1 que2 ram:#? .. end

FS_Plugin_Cache
Format: FS_Plugin_Cache Device/A CacheSize/K/N ReadAHead/K/N MemLimit/K/N Quiet/S WriteAround/S NoCheckSums/S
Purpose: Increase performance of the Fast File System 2 (FFS2) system.
Parameters: Device = Disk device, CacheSize = Size multiplied by 1024 e.g. 8192 = 8MB, ReadAhead = blocks to read in advance, MemLimit = Max limit of memory to use, Quiet = Suppress messages, WriteAround = blocks to write ahead, NoCheckSums = Don't perform any checksums on data.
Example: FS_Plugin_Cache DH3: CacheSize 4096

FS_Plugin_Encrypt
Format: FS_Plugin_Encrypt Device/A Blocks/K/N Quiet/S
Purpose: Starts a data encryption plugin for FFS2 filesystem. En/Decryption runs on the fly. A password will be requested at the start. The filesystem will need reformatting to use the plugin.
Parameters: Device = Device to encrypt, Blocks = Number of data blocks to encrypt at a time, Quiet = Suppress messages.
Example: FS-Plugin_Encrypt DH4:

FS_Set_Flush_Strategy
Format: FS_Set_Flush_Strategy Volume Strategy/N
Purpose: Sets flushing strategy for a volume. N = 0 strict flushing strategy, 1 = relaxed strategy.
Parameters: Volume = volume name, Strategy = stategy number (0, 1)
Example FS_Set_FlushStategy Workbench: 0

FTP
Format: FTP Verbose/S Debug/S Trace/S NoPrompts/S NoAutoLogins/S NoGlobbing/S Host Port/N
Purpose: File transfer program.
Parameters: -v or Verbose = show all responses from server, -d or Debug = Enable debugging, -t or Trace = enable tracing, -n or NoAutoLogins = prevent auto-login on initial connection (check for .netrc file), -g or NoGlobbing = Disable file name globbing, Host = address of remote ftp server, Port = TCP port (default 21). See wiki.
Example: FTP -v ftp.remotesite.com 21

GetNetStatus
Format: GetNetStatus Check/K Quiet
Purpose Display network startis including interfaces, resolves, routes.
Parameters: Check = List of conditions to check: Interfaces, PTPInterfaces, BCastInterfaces, Resolver, Routes, DefaultRoute, Quiet = suppress output.
Example: GetNetStatus Check="Interfaces"

Group
Format: Group File/A/M Group/A All/S Quiet/S
Purpose: Change the access rights of a file or directory to a named group.
Parameters: File = Name of file, directory or pattern, Group = Name of group, All = apply to all files in direcory, Quiet = Suppress output.
Example: Group DocDir DocAdmins All

Help
Format: Help CommandName Short/S LFormat/S ShowList/S
Purpose: Display help text for a command. Displays help text from NAME section of the help text.
Parameters: CommandName = Command to display help for, Short = display short description, LFormat = customize output, ShowList = show list of available help texts.
Exameple: Help Copy

Hi
Format: HI
Purpose: Stops all ARexx programs
Parameters: None
Example: HI

History
Format: History Lines/N Start/K/N Load/K Save/K Size/K/N Clear/S Show/S Nonum/S
Purpose: Display or store the command line history.
Parameters: Lines = restrict number of lines shown, Start = show history from given start number, Load = load a history file, Save = Save history to a file, Size = Changes size of history buffer (default 4), Clear = drop current command history, Show = show history, Nonum = ignore numbers.
Example: History Lines 10

Identd
Format: Identd
Purpose: TCP/IP Identd protocol server which sends uer information to a remote host that is requesting a service from.
Parameters: None
Example: Identd

IdeTool
Format: IdeTool Command Argument..
Purpose: Modify ATAPI device driver parameters incl. unit number, transfer mode, power mode, interrupt mode, PCI IDE configuration, configspace.
Parameters: -letter [arguments] (see wiki)
Example: IdeTool -v

IPF
Format: IPF [-AdDEInoPrsvVyzZ] [-l <block | pass | nomatch>] [-F < i | o | a | s | S >] -f <filename> [-f <filename> [...]]
Purposes: Alters packet filtering lists for IP packet I/O.
Parameters: See wiki for all the options.
Example: IPF -V

IPFSTAT
Format: IPFSTAT [ -aAfghIinosv ] [ -d <device> ]
Format2: IPFSTAT -t [ -C ] [ -D <addrport> ] [ -P <protocol> ] [ -S <addrport> ] [ -T <refresh time> ] [ -d <device> ]
Purpose: Display packet filter statistics and list.
Parameters: See wiki for all the options.
Example: IPFSTAT

IPMON
Format: IPMON [-aDFhnpstvxX] [-N <device>] [-o [NSI]] [-O [NSI]] [-P <pidfile>] [-S <device>] [-f <device>] [<filename>]
Purpose: Opens IPL device for logged statistics/
Parameters: N = Device log to read, -o = Which log files to read, -O = which log files not to read, -P = write process id to file, -S = set log file to open for reading state log records from or to device, -F = alternative device, filename = filename to read or write to.
Example IPMON -D

IPNAT
Format: IPNAT [ -lnrsvCF ] -f <filename>
Purpose: Defines Network Address Translation rules.
Parameters: -C = delete all NAT rule entries, -F = delete all active NAT entries, -l = list entries, -n = stop any ioctl calls, -s = display statistics, -r = remove matching NAT rules, -v = display more verbose information, -f = Read file for rules to add or remove to tables.
Example: IPNAT -s

KDEBUG
Format: KDebug Command/F
Purpose: Control kernel debug levels.
Parameters: Command = debuglevel n = debug verbosity (0,5,10,20), console name = Select serial or memory console, alignment warn | nowarn = control alignment warning levels,
memorymap = display current memory map, pagestat n = Dump paging statistics upto n pages (default 20), status = dump kernel options.
Example: KDebug debuglevel 5

MD5SUM
Format: MD5SUM NAMES/M ALL/S TO/K DEVICES/S SORT/S BUFFERSIZE/K/N CHECK=FROM/K STATUS/S WARN/S QUIET/S ALGORITHM/K
Purpose: To calculate and compare file checksums.
Parametrs: Name = Files to calculate checksums for, All = include dirs and subdirs, Devices = Checksum raw storage devices, Sort = sorts list, To = Output to file, Buffersize = Size of read buffer (default 256K), Check name = Read file and calculate check checksums, Status = no output if mismatch found, Warn = display warning for unmatched sums, Quiet = prevent display of progress reports, Algorithm = Sets summing algorithm (MD5, SHA-1 | 256 | 384 | 512, Whirlpool).
Example: MD5Sum CL Sort

MEMSTAT
Format: MemStat Verbose/S KB/S Detailed/S
Purpose: Display heap and page file memory information.
Parameters: Verbose = Display more information ,KB = Display Amount and Max values in KB, Detailed = See verbose.
Example: Memstat KB

MKNTFS
Format: MkNTFS [options] device [number of sectors]
Purpose: Create a NTFS (New Technology File System) file system on a disk. NTFS is used by Windows Operating System.
Parameters: See wiki for options.
Example: MKNTFS DH4: 512

MOUNTINFO
Format: MountInfo Device/A To/K Addicon/S Activate/S Debug/S
Purpose: To create mount files for the file systems.
Parameters: Device = name of device to create a mount file for, To = write mount file to a file instead of console, Addicon = Add info file for mount file, Activate = store the mount file which will be activated once mounted, Debug = To and Addicon is ignored, output is for software developers.
Example: Mountinfo DH5:

MOVE
Format: Move From/A/M To/A,Quiet/S BUF=Buffers/K/N NoReq/S NoReplace/S Interactive/S Force/S Copylinks/S Followlinks/S
Purpose: To move files or directories to another location or rename files.
Parameters: From = Source file(s) or directory(s), To = Destination dir or file, Buffers = Number of 512 byte buffers used, NoReq = No requester, NoReplace = Do not replace an existing file, Interactive = Prompts to replace files or not, Force = Overwrite protected files, Copylinks = Include linked files, Followlinks = Follow linked directories.
Example: Move File2 to Work:File2

NETLOGVIEWER
Format: NetLogViewer CX_Popkey/K CX_Priority/K/N CX_Popup/K
Purpose: Capture debug or notifcation messages sent by bsdsocket.library or clients.
Parameters: CX_Popkey = Key combination to view log window (Shift Alt F8), CX_Priority = Priority of input event handler (default: 0), CX_Popup = Show log window on start.
Example: NetLogviewer

NETSHUTDOWN
Format: NetShutdown Timeout/N Quiet/S
Purpose: Shutdown the network interfaces.
Parameters: Timeout = Timout in seconds before quitting (default: 5 secs), Quiet = suppress messages.
Example: NetShutdown

NTFSCAT
Format: NTFSCAT -a=--attribute,-n=--attribute-name,-i=--inode,-f=--force,-h=--help,-q=--quiet,-V=--version,-v=--verbose,DEVICE,FILE
Purpose: To display NTFS files and streams.
Parameters: -a = Attribute type to display, -n = display named attribute, -i = display file by inode number, -f = force, -h = help, -q = quiet output, -V = version, -v = verbose output.
Example: Ntfscat /dev/hda1 boot.ini

NTFSCK
Format: NTFSCK Dir Opt/K All/S Dir/S Files/S Interactive=Inter/S ShowPrograms/S MaxColumns/K/N
Purpose: Check NTFS file systems consistency.
Parameters:
Example:

NTFSCLUSTER
Format: NTFSCluster Dir Opt/K All/S Dir/S Files/S Interactive=Inter/S ShowPrograms/S MaxColumns/K/N
Purpose: Find a file in a given a cluster or sector.
Parameters:
Example:

NTFSFIX
Format: NTFSFix Dir Opt/K All/S Dir/S Files/S Interactive=Inter/S ShowPrograms/S MaxColumns/K/N
Purpose: Fixes a NTFS file system.
Parameters:
Example:

NTFSINFO
Format: NTFSInfo Dir Opt/K All/S Dir/S Files/S Interactive=Inter/S ShowPrograms/S MaxColumns/K/N
Purpose: Display all file's attributes on a NTFS volume.
Parameters:
Example: NTFSInfo File1

NTFSLABEL
Format: NTFSLabel Dir Opt/K All/S Dir/S Files/S Interactive=Inter/S ShowPrograms/S MaxColumns/K/N
Purpose: Set or display a label name on a NTFS volume.
Parameters:
Example:

NTFSLS
Format: NTFSLS Dir Opt/K All/S Dir/S Files/S Interactive=Inter/S ShowPrograms/S MaxColumns/K/N
Purpose: Display directory of a NTFS volume.
Parameters:
Example: NTFSLS DH4:

NTFSUNDELETE
Format: NTFSUndelete Dir Opt/K All/S Dir/S Files/S Interactive=Inter/S ShowPrograms/S MaxColumns/K/N
Purpose: Recover deleted files on a NTFS volume.
Parameters:
Example:

NTFSWIPE
Format: NTFSWipe -i -d -l -m -p -t -u -s -a -c num -b list -n -f -q -v -V -h device
Purpose: Write zeros to unused parts of disk on NTFS volume.
Parameters: -i or --info = show volume info, -d or --directory = wipe dir indexes, -l or --logfile = write to logfile, -m or --mft = wipe mft space, -p or --pagefile = wipe swap space, -t or --tails = wipe file tails, -u or --unused = wipe unused clusters, -s or --undel = wip undelete data, -a or --all = wipe all unused space, -c = count times to write (1), -b = list values to write (0), -n or --no-action = do not write to disk, -f or --force = use less caution, -q or --quiet = suppress messages, -v or --verbose = more output, -V or --version = version information, -h or --help = help text.
Example: NTFSWipe -i /dev/hda1

NVGETVAR
Format: NVGetVar Name
Purpose: To get value of a named UBoot environment variable.
Parameters: Name = name of variable
Example: NVGetVar boot_config

NVSETVAR
Format: NVSetVar Name Value
Purpose: To set value of all or named UBoot environment variable.
Parameters: Name = name of variable, Value = Value to set
Example: NVSetVar boot_config "AmigaOS 4.1 FE"

OPENSSL
Format: OpenSSL command
Purpose: Open Secure Socket Layers tool.
Parameters: See openssl reference.
Example: Openssl version

OWNER
Format: Owner File/A Owner/A All/S Quiet/S
Purpose: Change the owner of a file or directory.
Parameters: File = Name of file or a pattern or directory, Owner = Name or number of owner, All = All files in subdirs, Quiet = Supress messages.
Example: Owner Newfile Mike

PATHPART
Format: PathPart Dir/K File/K Add/K/N
Purpose: To split or assemble directory and file names.
Parameters: Dir = Directory name, File = Filename, Add = Add dir and file names together.
Example: PathPath SYS:Documents/Wordprocessing/Myfile.doc

PETUNE
Format: Petune GlobalDebugLevel/K/N DebugLevel/K/N DebugOffset/K InstStats/K Emulator/K SegmentList/S
Purpose:
Parameters:
Example:

PING
Format: PING -c n -d -i wait -l preload -n -q -R DontRoute -s size -v Bell Host hostname
Purpose: To send ICMP echo request packets to a host.
Parameters -c or Count = Send number of packetc, -d or Debug = Enable debug, -i or Interval = wait n seconds between pings, -l or Load = send n packets as fast as possible before returning to normal, -n or NumericOnly or Numeroc = Numeric output only, -R or RecordRoute = Record route in the packet, DontRoute = Bypass normal routing tables and send direct, -s or Size = Number of data bytes to send, -v or Verbose = other information displayed, Bell = Play a bell sound, hostname = Name or address of host to ping.
Example: PING -c 20 10.0.0.10

PIPE
Format: Pipe command/A/F
Purpose: To connect input and output of Shell streams.
Parameters: Output of command to pipe through.
Example PIPE datafile

POOLSTAT
Format: Poolstat
Purpose: Display memory pools used by the system.
Parameters: None
Example: Poolstat

POPCD
Format: PopCD
Purpose: Return (or pop) the last directory saved with PushCD command.
Parameters: None
Example: PopCD

PUSHCD
Format: PushCD DIR
Purpose: Save current directory to stack and optionally change directory too.
Parameters: None
Example: PushCD Work:Documents

PYTHON
Format: Python -c,-d,-E,-h,-i,-m,-O,-OO,-Q,-S,-t,-u,-v,-V,-W,-x,file,args
Purpose: Run the Python programming language interpreter.
Parameters: -c = command, -m = module, file or stdin.
Example: Python myprog.py

REBOOT
Format: Reboot FAST=WARMREBOOT WAIT=secs SYNC
Purpose: To reboot the computer.
Parameters: Fast or WarmReboot = Do a quick restart, Wait = Wait for n seconds before starting, Sync = Sync disks.
Example: Reboot Sync

RECORDER
Format: Recorder To Append/S Off/S Line/S Size/N/K Flush/S
Purpose: To capture output sent to console and store it in a file.
Parameters: To = File to store output, Append = Append to existing file, Off, Line, Size = Max size, Flush.
Example: Recorder to console.log Append

RELOADAPPLIST
Format: ReloadAppList
Purpose: Reloads application list
Parameters: None
Example: Reloadapplist

REMOVENETINTERFACE
Format: RemoveNetInterface Interface/A Force/A Quiet/S
Purpose: Removes a network interface.
Parameters: Interface = name of interface to remove, Force = Remove it without checks, Quiet = suppress message
Example: Removenetinterface interface2

REQUESTSTRING
Format: RequestString Title/A Body/A Positive/K Negative/K DefString/K MaxLen/K/N NotEmpty/S Invisible/S TO/K PubScreen/K Charset/K,Inactive/S
Purpose: Use custom string requesters.
Parameters: Title = title of request, Body = text of the requester, Positive = text for positive response, Negative = text for negative response, MaxLen = Max length of string (default 256), NotEmpty = Do not allow empty strings, Invisible = Text displayed as '*' eg. passwords, To = where to store string (default: stdout), PubScreen = name of public screen, Charset = Character set of requester strings (default: screen font), Inactive = Do not activate on open.
Example: RequestString "Name" "Enter your name" "OK" "Cancel"

ROADSHOWCONTROL
Format: RoadShowControl Get/K Set/K Save/S Quiet/S
Purpose: Display or change internal configuration optionsfor TCP/IP
Parameters: Get = Display named option's value, Set = Set value of option, Save = Save set value to disk, Quiet = suppress output.
Example: RoadShowControl Get udp.cksum

RX
Format: RX Name Arg/F
Purpose: Run an Arexx program.
Parameters: Name = name of rexx script, Arg = optional parameters.
Example: RX "say 99 / 4"

RXC
Format: RXC
Purpose: Close the ARexx resident process.
Parameters: None
Example: RXC

RXLIB
Format: RXLib Name Priority Offset/N Version/N
Purpose: Manage and list Arexx function libraries and hosts.
Parameters: Name = Name of library or host, Offset = library vector offset value, priority = number -100 to 100.
Example: RXLib rexxsupport.library 0 -30

RXSET
Format: RXSET Name Value/F
Purpose: Set name and values in the Clip list or list them.
Parameters: Name = Name string to set, Value = New value.
Example: RXSET invalue = 100

SAMPLENETSPEED
Format: SampleNetSpeed Interface Left/N Top/N Width/N Height/N Screen/K
Purpose: Display network i/o performance in a window.
Parameters: Interface = Name of network interface Left, Top, Width, Height = Position and size of Window, Screen = Name of a screen (default: Workbench)
Example: SampleNetSpeed ethernet

SETDOSDEBUG
Format: SetDosDebug DebugValue/N
Purpose: Sets or displays DOS Debug level.
Parameters: DebugValue = Value (0-9) , 0 = No additional info, 1 = show serious errors, 2 = include low priority errors, 3 = include general warnings, 4+ = undefined.
Example: SetDosDebug 2

SETFONTCHARSET
Format: SetFontCharset BitmapFontFilename/A Charset/A VerString/K
Purpose: Adds a charset tag and version string to a FontContentsHeader file.
Parameters: BitmapFontFilename = Name of bitmap font file, Charset = Character set name, Verstring = VersionString
Example: SetFontCharset SYS:Fonts/Symbol/24 X-Custom Verstring "$VER: Symbol\24 51.1 (11.5.2004)"

SHOW68KLOADS
Format: Show68KLoads
Purpose: Lists 680x0 libraries, devices, handlers and other modules.
Parameters: None
Example: Show68kLoads

SHOWAPPLIST
Format: ShowApplist
Purpose: Displays keys from DEVS:application.dos. Includes filexsum, file size, requester, JIT flags and control values.
Parameters: None
Example: ShowApplist

SHOWNETSTATUS
Format: ShowNetStatus Interface/M Interfaces/S ArpCache/S Routes/S DomainNameServers/S ICMP/S IGMP/S IP/S Memory/S MultiCastRouting/S Routing/S TCP/S TCPSockets/S UDPSockets/S Names/S All/S Repeat/S Quiet/S
Purpose: Display network status for interface(s) or network in general including IP address, MAC address, speed, packet stats, read and write requests.
Parameters: Interface = Name of interface, Interfaces = Show all interfaces, Arp = Show arp cache, Routes = display routes configured, DNS or DomainNameServices = Show DNS servers assigned, ICMP = Show ICMP stats,IGMP = Show IGMP stats, IP = Show IP stats, MB or Memory = Show memory buffer stats, MR or MultiCastRouting = Show multicast routing stats, RT or Routing = Show routing stats, TCP = Show TCP stats, UDP = Show UDP stats, TCPSockets = Show tcp socket information, UDPSockets = Show udp socket info, Names = display any symbolic names for IP addresses, All = Show all TCP or UDP Sockets, Repeat = Repeat query each second, Quiet = suppress error messages.
Example: ShowNetStatus Enternet routes dns tcp

SMARTCTL
Format: SmartCtl Label Back/S
Format2: SmartCtl -h -V -i -a -q type -d type -T type -b type -r type -s value -o value -S value -H -c -A -l type -v n,opt -F type -P type -t test -C -X
Purpose: Control and monitor smart disks.
Parameters: Run smartctl -h to view parameters.
Example: smartctl -a alide.device:0

SOUNDPLAYER
Format: SoundPlayer Verbose/s Quiet/S SampleRate/k/N From/M Volume/K/N
Purpose: Plays sound sample.
Parameters: Verbose = Displays details abount the sample, Quiet = suppress output, Samplerate = Rate in Hz, From = Sample file, Volume = sound volume.
Example: Playsound sample.wav verbose

SWAPCD
Format: SwapCD Dir Level/N
Purpose: Switches current directory and a stacked directory.
Parameters: Dir = Directory name or pattern, Level = level in stack.
Example: SwapCD SYS:Tools/Commodities

TCC
Format: TCC
Purpose: Close Arexx tracing console window.
Parameters: None
Example: TCC

TCO
Format: TCO
Purpose: Opens the Arexx tracing console window.
Parameters: None
Example: TCO

TCPDUMP
Format: TcpDump [-aAdDeflLnNOpqRStuUvxX] [-c <count>] [-C <file_size>] [-E <algo:secret>] [-F <file>] [-i <interface>] [-r <file>] [-s <snaplen>] [-T <type>] [-w <file>] [-y <datalinktype>] [<expression>]
Purpose: Dumps network traffic to file or window.
Parameters: -c = Exit after receiving 'count' packets, -C = check file size before saving raw packet to file, -E = use spi@ipaddr algo:secret from decrypting IPSec ESP packets, -F = Use file as input for filter expression, -i = Listen on this interface, -r = read packets from file, -s = read 'snaplen' bytes of data from each packet (default 68), -T = force packets selected by expression to specifed type, -w = write packets to file, -y = set data link type, expression = which packets to dump e.g. host name, net network, port number.
See 'help tcpdump' for more information.
Example TcpDump -i ethernet

TE
Format: TE
Purpose: Clears the Arexx global tracing flag.
Parameters: None
Example: TE

TEE
Format: TEE Size/N/K Line/S
Purpose: Sends data from stdin to stdout and prints to console.
Parameters: Size = Data chunk size (default 512), Line = read line by line.
Example: TEE Line

TRACEROUTE
Format: TraceRoute Debug/S MaxTTL/K/N Numeric/S Port/K/N Queries/K/N DontRoute/S Source/K Tos/K/N Wait/K/N Host/A PacketSize/N
Format2: TraceRoute -d -m -n -p -q -r -s -t -v -w Host PacketSize
Purpose: To print the route a packet takes to reach the host.
Parameters: MaxTTL = max time to live (max hops) used to probe packets (30 by default), Numeric = display hop addresses numerically, Port = set base UDP port in probes,
Queries = number of probes per ttl (default 3), DontRoute = Bypass normal routing tables and go direct to host, Source = use following IP address as source address, TOS = set type
of service in probe packets (default 0), Verbose = received ICMP packets are listed, Wait = set time for response (default 3 secs).
Example: TraceRoute Numeric 10.0.1.5

TS
Format: TS
Purpose: Start Arexx interactive tracing.
Parameters: None
Example: TS

UPTIME
Format: Uptime
Purpose: Display how long the system has been running.
Parameters: None
Example: Uptime

URLOPEN
Format: URLOpen Protocol/K Link/F
Purpose: To open a website via command line
Parameters: Protocol = Web protcol to use (http, https, ftp), Link = Name of web site.
Example: URLOpen http www.google.co.uk

USBCTRL
Format: USBCtrl Preboot/S Start/S Restart/S Stop/S Flushlog/S Force/S
Purpose: Control USB devices
Parameters: tbc
Example: USBCtrl Start

WAITFORPORT
Format: WaitForPort Name/A Timeout/N
Purpose: Wait for a public message port to appear from named port.
Parameters: Name = Name of Port, Timeout = Wait for period (default 10 secs)
Example: WaitforPort PROG_1

WBINFO
Format: WBInfo Object/M/A PubScreen/K
Purpose: Opens workbench information window via a shell command.
Parameters: Object = Name of file, drawer or disk to get info, PubScreen = Public Screen
Example: WBInfo Sys:Utilities/Clock

WBRUN
Format: WBRun Prog/A Args/M Show/K ViewBy/K Delay/N/K NoReq/S
Purpose: To run a program as if run from Workbench.
Parameters: Prog = Path and name of program to run, Args = Program arguments, Show = Show files (ALL) or only icons (ICONS), ViewBy = Show how file window is display, by Name, Date, Size or Type, Delay = Wait no of seconds before starting program, NoReq = No request.
Example: WBRun Sys:Utilities Show=All ViewBy=Name

WBSTARTUPCTRL
Format: WBStartupCtrl Path/K Add/K Remove/K Quiet
Purpose: Program to ctrol programs that run when Workbench loads.
Parameters: Path = Create updated preferences file at this location, Add = Add specified program to list, Remove = Remove specified program from list, Quiet = Suppress messages.
Example: WBStartupCtrl Add=Sys:Utilities/Commodities/MouseBlanker

XAD2LHA
Format: Xad2Lha From/A To Password/K NoExtern/S Quiet/S Header0/S
Purpose: Convert Xad file to LHA archive (uses xadmaster.library)
Parameters: From = File to convert, To = Result LHA file, Password = Password protect string, NoExtern = prohibits external clients, Quiet = Suppress output, Header0 = use header level 0 for older clients.
Example: Xad2Lha file.xad file.lha

XADLIBINFO
Format: XadLibInfo
Purpose: List recognised archive or compression formats including name, flags, id, xad verrsion and revision of clients.
Parameters: None
Example: XadLibInfo

XADLIST
Format: XadList File/M All/S NoExternal/S OnlyKnown/S
Purpose: List recognised archive or compressed files in current directory or specified file(s).
Parameters: File = Files to list, All = tbc, NoExternal = prohibits external clients, Onlyknown = tbc
Example: XadList work:#?.L??

XADUNDISK
Format: XadUndisk From/A To Lowcyl/N Highcyl/N Entry/N Password SaveTexts/K NoExtern/S Info=List/S Showtexts/S Overwrite/S IgnoreGeometry/S Format/S DiskImage/S UseSectorLabel/S
Purpose: Extracts data from disk archives
Parameters: From = disk archve name, To = destination device or filename. See xadundisk.doc with xadmaster.
Example: Xadundisk From disk.dmg To = DF0:

XADUNF
Format: Xadunf Filename/A Info/S Dest
Purpose: Unknown
Parameters: Filename = file to process, Info = tba, Dest = Destination folder/file.
Example:

XADUNFILE
Format: Xadunfile From/A Dest=Destdir/K Password/K,File/K NameSize/K/N FFS=OFS/S SFS/S Info=List/S Q=Quiet/S AM=AskMakedir/S OW=Overwite/S SP=ShowProt/S Verbose/S Darc=DiskArchive/S Entry/K/N DIMG=DiskImage/S NA=NOABS/S NC=NoComment/S ND=Nodate/S, NE=Noextern/S,NKP=NoKillPart/S NP=NoProt/S NT=NoTree/S
Purpose: Extracts data from file archives
Parameters: Ftrom = file to process, Dest = Destination folder/file.See xadunfile.doc with xadmaster.
Example:XadUnFile archive.lha ram:

XADUNFILEM
Format: XadUnfileM From/A/M Dest=Destdir/K Password/K,File/K NameSize/K/N FFS=OFS/S SFS/S Info=List/S Q=Quiet/S AM=AskMakedir/S OW=Overwite/S SP=ShowProt/S Verbose/S Darc=DiskArchive/S Entry/K/N DIMG=DiskImage/S NA=NOABS/S NC=NoComment/S ND=Nodate/S, NE=Noextern/S,NKP=NoKillPart/S NP=NoProt/S NT=NoTree/S
Purpose: Extracts data from multiple file archives
Parameters: Ftrom = file to process, Dest = Destination folder/file. See xadunfile.doc with xadmaster.
Example:XadUnFileM file1.lha ram:

XADUNTAR
Format: XadUntar From/A/M Dest=Destdir/K Password/K,File/K NameSize/K/N FFS=OFS/S SFS/S Info=List/S Q=Quiet/S AM=AskMakedir/S OW=Overwite/S SP=ShowProt/S Verbose/S Darc=DiskArchive/S Entry/K/N DIMG=DiskImage/S NA=NOABS/S NC=NoComment/S ND=Nodate/S, NE=Noextern/S,NKP=NoKillPart/S NP=NoProt/S NT=NoTree/S
Purpose: Extracts data from tar files including compressed tar files.
Parameters: Ftrom = file to process, Dest = Destination folder/file.
Example:XadUntar file1.tar ram:

XBENCH
Format: XBench Filename/A Password/K Method/M Test/S All/S Save/K Log=Logfile/K
Purpose: File compression benchmarking.
Parameters: Filename = file to benchmark, Password = archive password, Method = tbc, Test = Test mode, All = tbc, Save = tbc, Log = Log file.
Example: Xbench openssh-bin.lha

XDIR
Format: XDir files/dirs
Purpose: Directory list of files or directories including compression details.
Parameters: Files/dirs = Files or directories to list.
Example: Xdir file1lha, Xdir work:files/

XPACK
Format: XPack File/M/A Method/K Minsize/N/K Suffix/K Password/K All/S Force/S Program/S XScan/S Lossy/S Quiet/S
Purpose: To pack or unpack files quickly using XPK compression library.
Parameters:
Example:

XPK
Format: XPK-frsux] [-p password] [-m method] files
Purpose: Pakc or unpack tool using XPK package.
Parameters: -m = packing method, -f = force repack, -s - do not remove original, -r = recurse, -u = unpack, -p = encrypt/decrypt, -x = pack exe's only.
Example: xPK -r -p topsecret -m FEAL.32 dh1:private_docs

XQUERY
Format: XQuery [packer]
Purpose: Shows important information about a packer or all packers
Parameters: packer = name of packer
Example: XQuery FEAL

XSCAN
Format: XScan File/M/A All/S Remove/S
Purpose: Scans through XFH partition and modifies them which will allow to read directories faster
Parameters: File = files or folders to scan, All = Scan all dir trees, Remove = Remove filenotes,
Example: xScan Docs/#?.doc REMOVE

XTYPE
Format: Xtype Filenames
Purpose: Prints given files to standard output e.g. console, and decompress them if necessary.
Parameters: Filename = file to print.
Example: xType intuition.doc.nuke

XUP
Format: XUp [-s] [-S] [-p password] filenames
Purpose: Unpacks the given files and replace original files with uncompression files. Wild cards not supported and attributes are not preservced.
Parameters: -s = Suffix, keeps compression version, -S = Removes any .#? suffix, not only the .xpk one.
Example: xUp -p secret mytext

Back to UAE FAQ.