salfter/fluxengine
1
0
Fork 0
mirror of https://github.com/davidgiven/fluxengine.git synced 2025-10-24 11:11:02 -07:00
Code Issues Packages Projects Releases Wiki Activity

Fix some documentation from the global options change.

Browse Source
This commit is contained in:
David Given
2025-08-21 19:14:26 +02:00
parent 1def87fdc3
commit 07ebed83bf
5 changed files with 27 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/disk-40track_drive.md
View File

@@ -1,15 +0,0 @@
40track_drive
====
## Adjust configuration for a 40-track drive
<!-- This file is automatically generated. Do not edit. -->
This is an extension profile; adding this to the command line will configure
FluxEngine to read from 40-track, 48tpi 5.25" drives. You have to tell it because there is
no way to detect this automatically.
For example:
```
fluxengine read ibm --180 40track_drive
```

16
doc/disk-apple2_drive.md
View File

@@ -1,16 +0,0 @@
apple2_drive
====
## Adjust configuration for a 40-track Apple II drive
<!-- This file is automatically generated. Do not edit. -->
This is an extension profile; adding this to the command line will configure
FluxEngine to adjust the pinout and track spacing to work with an Apple II
drive. This only works on Greaseweazle hardware and requires a custom
connector.
For example:
```
fluxengine read apple2 --160 apple2_drive
```

15
doc/disk-shugart_drive.md
View File

@@ -1,15 +0,0 @@
shugart_drive
====
## Adjust configuration for a Shugart drive
<!-- This file is automatically generated. Do not edit. -->
This is an extension profile; adding this to the command line will configure
FluxEngine to adjust the pinout to work with a Shugart drive. This only works
on Greaseweazle hardware.
For example:
```
fluxengine read ibm --720 shugart_drive
```

48
doc/drives.md
View File

@@ -36,10 +36,10 @@ Forty track formats on a forty track drive
------------------------------------------ ------------------------------------------
If you actually have a forty track drive, you need to tell FluxEngine. This is If you actually have a forty track drive, you need to tell FluxEngine. This is
done by adding the special profile `40track_drive`: done by adding `--drivetype=40`:
``` ```
fluxengine write ibm --360 40track_drive -i image.img -d drive:0 fluxengine write -c ibm --360 --drivetype=40 -i image.img -d drive:0
``` ```
It should then Just Work. This is supported by both FluxEngine and Greaseweazle It should then Just Work. This is supported by both FluxEngine and Greaseweazle
@@ -47,24 +47,6 @@ hardware.
Obviously you can't write an eighty-track format using a forty-track drive! Obviously you can't write an eighty-track format using a forty-track drive!
Apple II drives
---------------
The Apple II had special drives which supported microstepping: when commanded
to move the head, then instead of moving in single-track steps as is done in
most other drives, the Apple II drive would move in quarter-track steps. This
allowed much less precise head alignment, as small errors could be corrected in
software. (The Brother word processor drives were similar.) The bus interface
is different from normal PC drives.
The FluxEngine client supports these with the `apple2_drive` profile:
```
fluxengine write apple2 apple2_drive -i image.img -d drive:0
```
This is supported only by Greaseweazle hardware.
Shugart drives Shugart drives
-------------- --------------
@@ -77,14 +59,32 @@ the drives must be jumpered to configure them. This was mostly used by older
3.5" drives, such as those on the Atari ST. [the How It Works 3.5" drives, such as those on the Atari ST. [the How It Works
page](technical.md) for the pinout. page](technical.md) for the pinout.
The FluxEngine client supports these with the `shugart_drive` profile: The FluxEngine client supports these with `--bus=shugart`:
``` ```
fluxengine write atarist720 shugart_drive -i image.img -d drive:0 fluxengine write -c atarist720 --bus=shugart -i image.img -d drive:0
``` ```
(If you have a 40-track Shugart drive, use _both_ `shugart_drive` and (If you have a 40-track Shugart drive, use _both_ `--bus=shugart` and
`40track_drive`.) `--drivetype=40`.)
This is supported only by Greaseweazle hardware.
Apple II drives
---------------
The Apple II had special drives which supported microstepping: when commanded
to move the head, then instead of moving in single-track steps as is done in
most other drives, the Apple II drive would move in quarter-track steps. This
allowed much less precise head alignment, as small errors could be corrected in
software. (The Brother word processor drives were similar.) The bus interface
is different from normal PC drives.
The FluxEngine client supports these with `--drivetype=160 --bus=appleii`.
```
fluxengine write -c apple2 --drivetype=160 --bus=appleii -i image.img -d drive:0
```
This is supported only by Greaseweazle hardware. This is supported only by Greaseweazle hardware.

6
doc/using.md
View File

@@ -108,13 +108,13 @@ encoder {
} }
} }
} }
$ fluxengine write ibm --1440 config.textpb -i image.img $ fluxengine write -c ibm --1440 -c config.textpb -i image.img
``` ```
...or you can specify them on the command line: ...or you can specify them on the command line:
``` ```
$ fluxengine write ibm --1440 -i image.img --encoder.ibm.trackdata.emit_iam=false $ fluxengine write -c ibm --1440 -i image.img --encoder.ibm.trackdata.emit_iam=false
``` ```
Both the above invocations are equivalent. The text files use [Google's Both the above invocations are equivalent. The text files use [Google's
@@ -128,7 +128,7 @@ files as you wish; they are all merged left to right. You can see all these
settings by doing: settings by doing:
``` ```
$ fluxengine write ibm --1440 --config $ fluxengine write -c ibm --1440 --show-config
``` ```
The `--config` option will cause the current configuration to be dumped to the The `--config` option will cause the current configuration to be dumped to the