From 9086f184133586adf0ef13dba9decc3515fdeb34 Mon Sep 17 00:00:00 2001 From: David Given Date: Mon, 19 Jul 2021 22:39:14 +0200 Subject: [PATCH] Update documentation. --- doc/disk-atarist.md | 5 ++++- doc/disk-brother.md | 6 +++--- doc/disk-ibm.md | 7 ++++++- doc/disk-northstar.md | 30 +++++++++++++++--------------- mkninja.sh | 3 ++- 5 files changed, 30 insertions(+), 21 deletions(-) diff --git a/doc/disk-atarist.md b/doc/disk-atarist.md index e908572f..5f099f79 100644 --- a/doc/disk-atarist.md +++ b/doc/disk-atarist.md @@ -11,7 +11,7 @@ Reading disks Just do: - fluxengine read atarist + fluxengine read ...and you'll end up with an `atarist.st` file. The size of the disk image will vary depending on the format. This is an alias for `fluxengine read ibm` with @@ -30,6 +30,9 @@ The syntax is: fluxengine write -i input.st +Available formats +----------------- + `` can be one of these: - `atarist360`: a 360kB 3.5" disk, with 80 cylinders, 1 side, and 9 sectors diff --git a/doc/disk-brother.md b/doc/disk-brother.md index 9b452d05..6cf5eeb1 100644 --- a/doc/disk-brother.md +++ b/doc/disk-brother.md @@ -38,11 +38,11 @@ Reading disks Just do: ``` -fluxengine read brother +fluxengine read `` ``` -You should end up with a `brother.img` which is either 119808 or 239616 bytes -long. +... where `` can be `brother120` or `brother240`. You should end up +with a `brother.img` which is either 119808 or 239616 bytes long. Writing disks ------------- diff --git a/doc/disk-ibm.md b/doc/disk-ibm.md index f93a724e..a74df292 100644 --- a/doc/disk-ibm.md +++ b/doc/disk-ibm.md @@ -33,12 +33,17 @@ Reading disks Just do: - fluxengine read ibm + fluxengine read `` ...and you'll end up with an `ibm.img` file. This should work on most PC disks (including FM 360kB disks, 3.5" 1440kB disks, 5.25" 1200kB disks, etc.) The size of the disk image will vary depending on the format. +The common PC formats are `ibm720` and `ibm1440`, but there are _many_ others, +and there's too many configuration options to usefully list. Use `fluxengine +write` to list all formats, and try `fluxengine write ibm1440 --config` to see +a sample configuration. + Configuration options you'll want include: - `--decoder.ibm.sector_id_base=N`: specifies the ID of the first sector; diff --git a/doc/disk-northstar.md b/doc/disk-northstar.md index d9c34c3c..7ddfdc09 100644 --- a/doc/disk-northstar.md +++ b/doc/disk-northstar.md @@ -26,23 +26,13 @@ You must use a 48-TPI (40-track) 300RPM 5.25" floppy drive. To read a double-sided North Star floppy, run: ``` -fluxengine read northstar +fluxengine read ``` -To read a single-sided North Star floppy, run: - -``` -fluxengine read northstar -heads 0 -``` +...where `` is one of the formats listed below. You should end up with a `northstar.nsi` with a file size dependent on the floppy -disk type: - -| Disk Type | File Size (bytes) | -| ----------------------------------- | ------- | -| Single-Sided, Single-Density (SSSD) | 89,600 | -| Single-Sided, Double-Density (SSDD) | 179,200 | -| Double-Sided, Double-Density (DSDD) | 358,400 | +disk type. Writing disks ------------- @@ -56,8 +46,18 @@ To write a double-sided North Star floppy, run: fluxengine write -i image_to_write.nsi ``` -...where `` is `northstar87`, `northstar175` or `northstar350` -depending on the format you want to write. +...where `` is one of the formats listed below. + +Available formats +----------------- + +The following formats are supported: + +| Format name | Disk Type | File Size (bytes) | +| -------------- | ----------------------------------- | ----------------- | +| `northstar87` | Single-Sided, Single-Density (SSSD) | 89,600 | +| `northstar175` | Single-Sided, Double-Density (SSDD) | 179,200 | +| `northstar350` | Double-Sided, Double-Density (DSDD) | 358,400 | Useful references ----------------- diff --git a/mkninja.sh b/mkninja.sh index 15db04a5..2470e77f 100644 --- a/mkninja.sh +++ b/mkninja.sh @@ -404,7 +404,8 @@ FORMATS="\ ibm360_525 \ ibm720 \ ibm720_525 \ - macintosh \ + mac400 \ + mac800 \ micropolis \ mx \ northstar87 \