Update docs with a new HELP screenshot

This commit is contained in:
Patrick Kloepfer 2019-09-24 10:54:33 -04:00
parent 52dccc3298
commit 13a2d390ca
3 changed files with 36 additions and 13 deletions

View File

@ -98,7 +98,7 @@ TELNETD is a server process that listens for incoming requests to connect to you
When TELNETD detects an incoming request it starts a GETTY process and creates a virtual internet terminal for the user and begins the LOGIN process same as the system would for a hardwired terminal. Note TELNETD requires that you have a supported ethernet card and have configured your system for a network appropriately.
## BIN,External Shell commands:
## BIN/External Shell commands:
The BIN or "External" shell commands are the tools used by most users to display and manipulate data stored on their A2osX system. Typcical commands allow you to display directory contents (LS), display file contents (CAT), copy files (CP), delete files (RM), etc. These commands are found in **./BIN/** letting you know they are normal user commands.
@ -186,7 +186,7 @@ This utility allows you to change the type of a file to a standard files types s
| --- | --- |
| CMP File1 File2 [SKIP1 [SKIP2]]| -A : Shows All differences <br> -V : Verbose Mode |
CMP will compare two files to determine if they are byte for byte equal. If the files are equal CMP exits normally with an exit code of 0. If the files have one or more bytes that are different, CMP will exit with an application error code of 223 (hex E0). By using the Verbose option you can see the offset and values of the first different byte. With the Verbose and All options you can see the list of all offsets and values that are different. The SKIP options allow you specify a number of bytes to skip in the file(s) before starting the comparison. CMP A B 100 200 would skip to the 100th byte of A and the 200th byte of B before starting the byte by byte comparison. Note then that B would need to be 100 bytes larger then A for the comparison to ever end without error.
CMP will compare two files to determine if they are byte for byte equal. If the files are equal CMP exits normally with an exit code of 0. If the files have one or more bytes that are different, CMP will exit with an application error code of 223 (Hex $DF). By using the Verbose option you can see the offset and values of the first different byte. With the Verbose and All options you can see the list of all offsets and values that are different. The SKIP options allow you specify a number of bytes to skip in the file(s) before starting the comparison. CMP A B 100 200 would skip to the 100th byte of A and the 200th byte of B before starting the byte by byte comparison. Note then that B would need to be 100 bytes larger then A for the comparison to ever end without error.
### CP

View File

@ -132,7 +132,7 @@ In maintenance mode, you still have access to all A2osX utilities and scripts, s
### A2osX Preemptive Mode
A2osX is a multiuser multitasking operating system. As with any such operating system running on a single core single CPU system such as an Apple II with the 6502, A2osX switches between all of the running processes automatically ensuring that each gets serviced in a reasonable time. It is the A2osX Kernel that performs this task in 1 of 2 manners: Cooperative or Preemptive mode. In Cooperative mode, the default, switching between processes occurs whenever an application makes a "blocking" API call such as waiting for a key pressed, a network frame... or cooperatively relinquishes control (explicitly calling >SLEEP, see the A2osX Developers Guide). In Preemptive Mode, set by option in KCONFIG utility (see A2osX Command Guide), the kernel switches between "sleeping" processes automatically at 1/10th-second intervals. In order to use Preemptive Mode, your system must have supported hardware that generates an interrupt used by A2osX such as an Apple II Mouse or ThunderClock interface.
A2osX is a multiuser multitasking operating system. As with any such operating system running on a single core single CPU system such as an Apple II with the 6502, A2osX switches between all of the running processes automatically ensuring that each gets serviced in a reasonable time. It is the A2osX Kernel that performs this task in 1 of 2 manners: Cooperative or Preemptive mode. In Cooperative mode, the default, switching between processes occurs whenever an application makes a "blocking" API call (i.e. waiting for a key press or a network frame) or cooperatively relinquishes control (by explicitly calling >SLEEP, see the A2osX Developers Guide). In Preemptive Mode, set by option in the KCONFIG utility (see A2osX Command Guide), the kernel switches between "sleeping" processes automatically at 1/10th-second intervals. In order to use Preemptive Mode, your system must have supported hardware that generates an interrupt used by A2osX such as an Apple II Mouse or ThunderClock interface.
## Devices
@ -269,20 +269,29 @@ RD
## Error Messages
* ProDOS Error Codes : $00->$5F
* No Error : $00
* User Script Error Codes : $01->$1F
* Note this range may be used by multiple different scripts.
* ProDOS Error Codes : $20->$5F
* Kernel Error Codes : $60->$7F
* Lib Error Codes : $80->$BF
* Shell Error Codes : $C0->$CF
* Application Error Codes : $ D0->$FF
* Shell Error Codes : $C0->$DF
* BIN/External Command Error Codes : $ E0->$F8
* Note this range may be reused by multiple BINs.
* Reserved for internal Kernel Use : $FA->$FF
### ProDOS or MLI Errors
### No Error : $00
This is the normal or expected returned when the last command or script statement executed properly.
### User Script Error Codes : $01->$1F
This range of Error Codes may be used by Users/Developers in scripts. Consult the Shell Developers Guide for more information.
### ProDOS or MLI Errors : $20->$5F
| Hex | Error Code | Error Message |
| --- | --- | --- |
| $00 | 0 | No Error|
| $01 | 1 | Bad Call Number|
| $04 | 4 | Bad Parameter Count|
| $06 | 6 | Communications Error|
| $21 | 33 | Invalid Status Code|
| $25 | 37 | Interrupt Table Full|
| $27 | 39 | I/O Error|
@ -312,7 +321,7 @@ RD
| $57 | 87 | Duplicate Volume|
| $5A | 90 | File Structure Damaged|
### Kernel Errors
### Kernel Errors : $ 60->$7F
| Hex | Error Code | Error Message |
| --- | --- | --- |
@ -337,7 +346,12 @@ RD
| $68 | 0 | Invalid PWD database |
| $67 | 0 | Invalid User |
### Shell Errors
### Kernel Error Codes : $60->$7F
| Hex | Error Code | Error Message |
| --- | --- | --- |
### Shell Errors : $ C0->$D8
| Hex | Error Code | Error Message |
| --- | --- | --- |
@ -353,6 +367,15 @@ RD
| $C8 | 0 |Undefined Function|
| $C9 | 0 |Unexpected EOF|
### BIN/External Command Error Codes : $ E0->$F8
This range of error codes is used by all A2osX and User/Developer create BINs or application programs to denote some completion result, usually not fatal. For example, the CMP command (./BIN/CMP) compares two files to see if they are equal. CMP will return 0 ($00) if the files compare equal and there is no other error; CMP will return 70 ($46) if one of the files is not found (a ProDOS error); and CMP will return 224 ($D0) if the files do not match, a not fatal error as the BIN did run, do its job, just the result was an "Application" mismatch error.
This range may be reused by multiple BINs so scripts checking these results should be aware of the BIN called and the valid return results for that BIN.
### Reserved for internal Kernel Use : $FA->$FF
## License
A2osX is licensed under the GNU General Pulic License.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 16 KiB