Better autogenerated documentation.

This commit is contained in:
David Given
2023-05-25 21:14:41 +02:00
parent 28ca2b72f1
commit 854b3e9c59
49 changed files with 592 additions and 67 deletions

View File

@@ -1,5 +1,7 @@
atarist
====
## Almost PC compatible
<!-- This file is automatically generated. Do not edit. -->
# Almost PC compatible
Atari ST disks are standard MFM encoded IBM scheme disks without an IAM header.
Disks are typically formatted 512 bytes per sector with between 9-10 (sometimes
@@ -13,7 +15,39 @@ Be aware that many PC drives (including mine) won't do the 82 track formats.
## Options
(no options)
- Format variants:
- `360`: 360kB 3.5" 80-track 9-sector SSDD
- `370`: 370kB 3.5" 82-track 9-sector SSDD
- `400`: 400kB 3.5" 80-track 10-sector SSDD
- `410`: 410kB 3.5" 82-track 10-sector SSDD
- `720`: 720kB 3.5" 80-track 9-sector DSDD
- `740`: 740kB 3.5" 82-track 9-sector DSDD
- `800`: 800kB 3.5" 80-track 10-sector DSDD
- `820`: 820kB 3.5" 82-track 10-sector DSDD
## Examples
To read:
- `fluxengine read atarist --360 -s drive:0 -o atarist.img`
- `fluxengine read atarist --370 -s drive:0 -o atarist.img`
- `fluxengine read atarist --400 -s drive:0 -o atarist.img`
- `fluxengine read atarist --410 -s drive:0 -o atarist.img`
- `fluxengine read atarist --720 -s drive:0 -o atarist.img`
- `fluxengine read atarist --740 -s drive:0 -o atarist.img`
- `fluxengine read atarist --800 -s drive:0 -o atarist.img`
- `fluxengine read atarist --820 -s drive:0 -o atarist.img`
To write:
- `fluxengine write atarist --360 -d drive:0 -i atarist.img`
- `fluxengine write atarist --370 -d drive:0 -i atarist.img`
- `fluxengine write atarist --400 -d drive:0 -i atarist.img`
- `fluxengine write atarist --410 -d drive:0 -i atarist.img`
- `fluxengine write atarist --720 -d drive:0 -i atarist.img`
- `fluxengine write atarist --740 -d drive:0 -i atarist.img`
- `fluxengine write atarist --800 -d drive:0 -i atarist.img`
- `fluxengine write atarist --820 -d drive:0 -i atarist.img`
## References