Difference between revisions of "Commands"

From BeebWiki
Jump to: navigation, search
m (1 revision)
(update)
Line 29: Line 29:
 
  ----Load      - Load a file
 
  ----Load      - Load a file
 
  ----Menu      - Enter a menu
 
  ----Menu      - Enter a menu
 +
----Mon      - Monitor
 
  ----Patch    - Patch an object
 
  ----Patch    - Patch an object
 
  ----Read      - Read from an object
 
  ----Read      - Read from an object
Line 34: Line 35:
 
  ----Run      - Run an object
 
  ----Run      - Run an object
 
  ----Save      - Save a file
 
  ----Save      - Save a file
 +
----Split    - Split objects
 
  ----Tidy      - Tidy objects
 
  ----Tidy      - Tidy objects
 +
----Tree      - Directory tree manipulation
 
  ----Type      - Type an object
 
  ----Type      - Type an object
 +
----Verify    - Verify objects
 
  ----Wipe      - Wipe objects
 
  ----Wipe      - Wipe objects
 
  ----Write    - Write to an object
 
  ----Write    - Write to an object
Line 48: Line 52:
 
  BIN----      - Binary file commands
 
  BIN----      - Binary file commands
 
  BMP----      - BitMap commands
 
  BMP----      - BitMap commands
 +
Boot----      - Boot command
 
  C----        - Create objects
 
  C----        - Create objects
 
  C----        - Character commands
 
  C----        - Character commands
Line 57: Line 62:
 
  CPM----      - CPM commands
 
  CPM----      - CPM commands
 
  Def----      - Define settings
 
  Def----      - Define settings
 +
Desk----      - Desktop commands
 +
DFS---        - Disk Filing System commands
 +
Dir---        - Directory commands
 
  Dis----      - Opposite command
 
  Dis----      - Opposite command
 +
Disc----      - Disc commands
 +
Disk----      - Disk commands
 +
Disp----      - Display commands
 
  DOS----      - DOS commands
 
  DOS----      - DOS commands
 
  Enable----    - Enable "dangerous" commands
 
  Enable----    - Enable "dangerous" commands
Line 70: Line 81:
 
  GO----        - Call code
 
  GO----        - Call code
 
  GS----        - GSTranslate commands
 
  GS----        - GSTranslate commands
 +
H----        - Teletext Header commands
 +
H----        - Hourglass commands
 
  Hex----      - Hex files
 
  Hex----      - Hex files
 
  Hi----        - Enter High version of language
 
  Hi----        - Enter High version of language
 +
Host----      - Host commands
 
  Key----      - Soft (function) key commands
 
  Key----      - Soft (function) key commands
 
  Kill----      - Kill (disable) objects
 
  Kill----      - Kill (disable) objects
Line 78: Line 92:
 
  Mail----      - Mail programs
 
  Mail----      - Mail programs
 
  MDR----      - Spectrum Microdrive commands
 
  MDR----      - Spectrum Microdrive commands
 +
MIDI----      - MIDI commands
 
  Mk----        - Make object
 
  Mk----        - Make object
 +
MkSrc----    - Make source file
 +
Mon----      - Monitor programs
 +
Mouse----    - Mouse commands
 
  MMC----      - GoMMC commands
 
  MMC----      - GoMMC commands
 +
Net---        - Network commands
 +
NFS---        - Network filing system commands
 +
NV----        - NonVolatile RAM commands
 +
Poll----      - Poll services
 
  Prod----      - Prod (ping) a service
 
  Prod----      - Prod (ping) a service
 
  Prot----      - Protection commands
 
  Prot----      - Protection commands
 
  PS----        - Printer server commands
 
  PS----        - Printer server commands
 +
R----        - Remote commands
 
  RAM----      - RAM filing system commands
 
  RAM----      - RAM filing system commands
 +
Rem---        - Remote actions
 
  RFS----      - RFS (Ram filing system) commands
 
  RFS----      - RFS (Ram filing system) commands
 
  RM----        - Relocatable Module commands
 
  RM----        - Relocatable Module commands
 +
ROM----      - ROM commands
 +
RS----        - Serial (RS232) commands
 +
S----        - Sprite commands
 
  Scr----      - BBC Screen commands
 
  Scr----      - BBC Screen commands
 
  Screen----    - RISC OS Screen commands
 
  Screen----    - RISC OS Screen commands
 +
Ser----      - Serial commands
 
  Set----      - Set settings
 
  Set----      - Set settings
 
  Sort----      - Sorting commands
 
  Sort----      - Sorting commands
  S----         - Sprite commands
+
  Spec----     - ZX Spectrum commands
 
  SR----        - Sideways RAM/ROM commands
 
  SR----        - Sideways RAM/ROM commands
 
  TAP----      - Spectrum tapefile commands
 
  TAP----      - Spectrum tapefile commands
 
  Tx----        - Text or Teletext commands
 
  Tx----        - Text or Teletext commands
 +
TTXT----      - Teletext receiver commands
 
  Un----        - Opposite action
 
  Un----        - Opposite action
 +
VD----        - Viewdata commands
 
  W----        - Windows commands
 
  W----        - Windows commands
 +
X----        - Extended commands
 +
Z80----      - Z80 commands
 
  Zip----      - Zip commands
 
  Zip----      - Zip commands
 
  ZX----        - ZX Spectrum commands
 
  ZX----        - ZX Spectrum commands
Line 111: Line 143:
 
  SSDto---      - Convert from SSD disk image
 
  SSDto---      - Convert from SSD disk image
 
  TAPto---      - Convert from Tapefile
 
  TAPto---      - Convert from Tapefile
 +
TextTo---    - Convert from Text
 
  ZipTo---      - Convert from Zipfile
 
  ZipTo---      - Convert from Zipfile
 
  ---toBBC      - Convert to BBC format file
 
  ---toBBC      - Convert to BBC format file
Line 122: Line 155:
 
  ---toSSD      - Convert to SSD disk image
 
  ---toSSD      - Convert to SSD disk image
 
  ---toTAP      - Convert to tapefile
 
  ---toTAP      - Convert to tapefile
 +
---toText    - Convert to Text
  
 
==Commands list==
 
==Commands list==

Revision as of 14:09, 8 March 2015

Command names

Commands must be named sensibly. A command is a verb, so commands should be named as the operative verb, with an optional modifier. Commands that convert data should be named as XXXtoYYY. Commands must not use 2 or 4 instead of to or for.

Command Suffixes

Commands must be named <object><verb>, if <object> is missing the <verb> operates on files.

Command suffixes list

----All       - Perform action multiple times
----Cat       - Catalog an object
----Clear     - Clear objects
----Copy      - Copy objects
----Delete    - Delete objects
----Diff      - List differences between two objects
----Dump      - Dump an object
----Edit      - Edit object
----Echo      - Echo string
----Ensure    - Ensure objects
----Ex        - Examine (extended catalog)
----Form      - Format objects
----Free      - Display free space
----Info      - Info on an object
----Insert    - Insert objects
----Join      - Join objects
----List      - List an object
----Load      - Load a file
----Menu      - Enter a menu
----Mon       - Monitor
----Patch     - Patch an object
----Read      - Read from an object
----Rename    - Rename an object
----Run       - Run an object
----Save      - Save a file
----Split     - Split objects
----Tidy      - Tidy objects
----Tree      - Directory tree manipulation
----Type      - Type an object
----Verify    - Verify objects
----Wipe      - Wipe objects
----Write     - Write to an object

Command prefixes

Commands must named <object><verb>, if <object> is missing the <verb> operates on files.

Command prefixes list

B----         - Basic
Bas----       - Basic
BBC---        - BBC format files
BIN----       - Binary file commands
BMP----       - BitMap commands
Boot----      - Boot command
C----         - Create objects
C----         - Character commands
Cat----       - Catalog commands
Check----     - Check for presence of objects
CMOS----      - Configuration commands, actually xxxxCMOS
Conv----      - Conversion commands
Copy----      - Copy objects
CPM----       - CPM commands
Def----       - Define settings
Desk----      - Desktop commands
DFS---        - Disk Filing System commands
Dir---        - Directory commands
Dis----       - Opposite command
Disc----      - Disc commands
Disk----      - Disk commands
Disp----      - Display commands
DOS----       - DOS commands
Enable----    - Enable "dangerous" commands
F----         - File manipulation
FI----        - FileInfo
Find----      - Find objects
Form----      - Format objects
FS----        - File Server commands
G----         - Graphics commands
G----         - Get information
Get----       - Get information
GO----        - Call code
GS----        - GSTranslate commands
H----         - Teletext Header commands
H----         - Hourglass commands
Hex----       - Hex files
Hi----        - Enter High version of language
Host----      - Host commands
Key----       - Soft (function) key commands
Kill----      - Kill (disable) objects
Lib----       - Library commands
M----         - Memory commands
Mail----      - Mail programs
MDR----       - Spectrum Microdrive commands
MIDI----      - MIDI commands
Mk----        - Make object
MkSrc----     - Make source file
Mon----       - Monitor programs
Mouse----     - Mouse commands
MMC----       - GoMMC commands
Net---        - Network commands
NFS---        - Network filing system commands
NV----        - NonVolatile RAM commands
Poll----      - Poll services
Prod----      - Prod (ping) a service
Prot----      - Protection commands
PS----        - Printer server commands
R----         - Remote commands
RAM----       - RAM filing system commands
Rem---        - Remote actions
RFS----       - RFS (Ram filing system) commands
RM----        - Relocatable Module commands
ROM----       - ROM commands
RS----        - Serial (RS232) commands
S----         - Sprite commands
Scr----       - BBC Screen commands
Screen----    - RISC OS Screen commands
Ser----       - Serial commands
Set----       - Set settings
Sort----      - Sorting commands
Spec----      - ZX Spectrum commands
SR----        - Sideways RAM/ROM commands
TAP----       - Spectrum tapefile commands
Tx----        - Text or Teletext commands
TTXT----      - Teletext receiver commands
Un----        - Opposite action
VD----        - Viewdata commands
W----         - Windows commands
X----         - Extended commands
Z80----       - Z80 commands
Zip----       - Zip commands
ZX----        - ZX Spectrum commands

Conversion commands

Conversion commands must be named <object>to<object. Note, they MUST NOT be named <object>2<object>.

Conversions list

BBCto---      - Convert from BBC format file
BINto---      - Convert from binary file
BMPto---      - Convert from BitMap image
DSDto---      - Convert from DSD disk image
HexTo---      - Convert from Hex file
MDRto---      - Convert from Microdrive image
SSDto---      - Convert from SSD disk image
TAPto---      - Convert from Tapefile
TextTo---     - Convert from Text
ZipTo---      - Convert from Zipfile
---toBBC      - Convert to BBC format file
---toBIN      - Convert to binary file
---toBMP      - Convert to BitMap file
---toDSD      - Convert to DSD disk image
---toHex      - Convert to Hex file
---ToInf      - Convert to INF metadata files
---toMDR      - Convert to microdrive image file
---toSnap     - Convert to snapshot file
---toSSD      - Convert to SSD disk image
---toTAP      - Convert to tapefile
---toText     - Convert to Text

Commands list

Jgharston 00:01, 31 October 2011 (UTC)