Skip to content

Commit aa089d4

Browse files
zahradt1keirf
authored andcommitted
Add PRECOMP documentation for gw write
1 parent cd32523 commit aa089d4

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

src/greaseweazle/tools/util.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,13 @@ def level(letter):
9797
Defaults: period=5:phase=60 (no lowpass filter)
9898
"""
9999

100+
precompspec_desc = """\
101+
PRECOMP: Any of the following elements:
102+
type=<t> :: Precomp type (mfm, fm, gcr): Default mfm
103+
<c>=<p> :: Precompensate all cylinders >= c by p nanoseconds
104+
e.g. '40=125' to apply 125ns MFM precompensation to cylinders 40 and higher
105+
"""
106+
100107
# Returns time period in seconds (float)
101108
# Accepts rpm, ms, us, ns, scp. Naked value is assumed rpm.
102109
def period(arg):

src/greaseweazle/tools/write.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ def main(argv) -> None:
211211

212212
epilog = (util.drive_desc + "\n"
213213
+ util.speed_desc + "\n" + util.tspec_desc
214+
+ "\n" + util.precompspec_desc
214215
+ "\nFORMAT options:\n" + codec.print_formats()
215216
+ "\n\nSupported file suffixes:\n"
216217
+ util.columnify(util.image_types))

0 commit comments

Comments
 (0)