mirror of
https://github.com/davidgiven/fluxengine.git
synced 2025-10-31 11:17:01 -07:00
Update documentation.
This commit is contained in:
@@ -11,7 +11,7 @@ Reading disks
|
|||||||
|
|
||||||
Just do:
|
Just do:
|
||||||
|
|
||||||
fluxengine read atarist
|
fluxengine read <format>
|
||||||
|
|
||||||
...and you'll end up with an `atarist.st` file. The size of the disk image will
|
...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
|
vary depending on the format. This is an alias for `fluxengine read ibm` with
|
||||||
@@ -30,6 +30,9 @@ The syntax is:
|
|||||||
|
|
||||||
fluxengine write <format> -i input.st
|
fluxengine write <format> -i input.st
|
||||||
|
|
||||||
|
Available formats
|
||||||
|
-----------------
|
||||||
|
|
||||||
`<format>` can be one of these:
|
`<format>` can be one of these:
|
||||||
|
|
||||||
- `atarist360`: a 360kB 3.5" disk, with 80 cylinders, 1 side, and 9 sectors
|
- `atarist360`: a 360kB 3.5" disk, with 80 cylinders, 1 side, and 9 sectors
|
||||||
|
|||||||
@@ -38,11 +38,11 @@ Reading disks
|
|||||||
Just do:
|
Just do:
|
||||||
|
|
||||||
```
|
```
|
||||||
fluxengine read brother
|
fluxengine read `<format>`
|
||||||
```
|
```
|
||||||
|
|
||||||
You should end up with a `brother.img` which is either 119808 or 239616 bytes
|
... where `<format>` can be `brother120` or `brother240`. You should end up
|
||||||
long.
|
with a `brother.img` which is either 119808 or 239616 bytes long.
|
||||||
|
|
||||||
Writing disks
|
Writing disks
|
||||||
-------------
|
-------------
|
||||||
|
|||||||
@@ -33,12 +33,17 @@ Reading disks
|
|||||||
|
|
||||||
Just do:
|
Just do:
|
||||||
|
|
||||||
fluxengine read ibm
|
fluxengine read `<format>`
|
||||||
|
|
||||||
...and you'll end up with an `ibm.img` file. This should work on most PC disks
|
...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
|
(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.
|
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:
|
Configuration options you'll want include:
|
||||||
|
|
||||||
- `--decoder.ibm.sector_id_base=N`: specifies the ID of the first sector;
|
- `--decoder.ibm.sector_id_base=N`: specifies the ID of the first sector;
|
||||||
|
|||||||
@@ -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:
|
To read a double-sided North Star floppy, run:
|
||||||
|
|
||||||
```
|
```
|
||||||
fluxengine read northstar
|
fluxengine read <format>
|
||||||
```
|
```
|
||||||
|
|
||||||
To read a single-sided North Star floppy, run:
|
...where `<format>` is one of the formats listed below.
|
||||||
|
|
||||||
```
|
|
||||||
fluxengine read northstar -heads 0
|
|
||||||
```
|
|
||||||
|
|
||||||
You should end up with a `northstar.nsi` with a file size dependent on the floppy
|
You should end up with a `northstar.nsi` with a file size dependent on the floppy
|
||||||
disk type:
|
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 |
|
|
||||||
|
|
||||||
Writing disks
|
Writing disks
|
||||||
-------------
|
-------------
|
||||||
@@ -56,8 +46,18 @@ To write a double-sided North Star floppy, run:
|
|||||||
fluxengine write <format> -i image_to_write.nsi
|
fluxengine write <format> -i image_to_write.nsi
|
||||||
```
|
```
|
||||||
|
|
||||||
...where `<format>` is `northstar87`, `northstar175` or `northstar350`
|
...where `<format>` is one of the formats listed below.
|
||||||
depending on the format you want to write.
|
|
||||||
|
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
|
Useful references
|
||||||
-----------------
|
-----------------
|
||||||
|
|||||||
@@ -404,7 +404,8 @@ FORMATS="\
|
|||||||
ibm360_525 \
|
ibm360_525 \
|
||||||
ibm720 \
|
ibm720 \
|
||||||
ibm720_525 \
|
ibm720_525 \
|
||||||
macintosh \
|
mac400 \
|
||||||
|
mac800 \
|
||||||
micropolis \
|
micropolis \
|
||||||
mx \
|
mx \
|
||||||
northstar87 \
|
northstar87 \
|
||||||
|
|||||||
Reference in New Issue
Block a user