Merge pull request #590 from davidgiven/options

Add a feature where configs can add simple command line options.

Author: davidgiven

doc/disk-apple2.md

@@ -40,15 +40,17 @@ Just do:
 fluxengine read apple2
 ```
 
-You should end up with an `apple2.img` which is 143360 bytes long.
-It will be in physical sector ordering. You can specify a sector ordering,
-`appledos` or `prodos` to get an image intended for use in an emulator,
-due to the logical sector mapping issue described above:
+You should end up with an `apple2.img` which is 143360 bytes long. It will be in
+physical sector ordering. You can specify a sector ordering, `--appledos` or
+`--prodos` to get an image intended for use in an emulator, due to the logical
+sector mapping issue described above:
 
 ```
-fluxengine read apple2 prodos
+fluxengine read apple2 --prodos
 ```
 
+You will also need this for filesystem access.
+
 Writing discs
 -------------
 
@@ -58,10 +60,10 @@ fluxengine write apple2 -i apple2.img
 ```
 
 If your image is in logical sector ordering (images intended for emulators
-usually are), specify a modifier of `appledos` or `prodos`:
+usually are), specify a modifier of `--appledos` or `--prodos`:
 
 ```
-fluxengine write apple2 prodos -i apple2.img
+fluxengine write apple2 --prodos -i apple2.img
 ```
 
 

doc/disk-micropolis.md

@@ -42,13 +42,13 @@ logically followed the first side (e.g., tracks 77-153). Micropolis disks
 tended to be the latter.
 
 It's also possible to output to VGI, which retains OS-specific "user data" and
-machine-specific ECC. Add "vgi" to the command line after the chosen Micropolis
-profile:
+machine-specific ECC. Add `--vgi` to the command line after the chosen
+Micropolis profile:
 ```
-fluxengine read micropolis143 vgi # single-sided Mod I
-fluxengine read micropolis287 vgi # double-sided Mod I
-fluxengine read micropolis315 vgi # single-sided Mod II
-fluxengine read micropolis630 vgi # double-sided Mod II
+fluxengine read micropolis143 --vgi # single-sided Mod I
+fluxengine read micropolis287 --vgi # double-sided Mod I
+fluxengine read micropolis315 --vgi # single-sided Mod II
+fluxengine read micropolis630 --vgi # double-sided Mod II
 ```
 
 You should end up with a `micropolis.vgi` instead. The format is well-defined
@@ -77,10 +77,10 @@ fluxengine write micropolis287 # double-sided Mod I
 fluxengine write micropolis315 # single-sided Mod II
 fluxengine write micropolis630 # double-sided Mod II
 
-fluxengine write micropolis143 vgi # single-sided Mod I
-fluxengine write micropolis287 vgi # double-sided Mod I
-fluxengine write micropolis315 vgi # single-sided Mod II
-fluxengine write micropolis630 vgi # double-sided Mod II
+fluxengine write micropolis143 --vgi # single-sided Mod I
+fluxengine write micropolis287 --vgi # double-sided Mod I
+fluxengine write micropolis315 --vgi # single-sided Mod II
+fluxengine write micropolis630 --vgi # double-sided Mod II
 ```
 
 Useful references

lib/config.proto

@@ -12,7 +12,7 @@ import "lib/drive.proto";
 import "lib/common.proto";
 import "lib/layout.proto";
 
-// NEXT_TAG: 19
+// NEXT_TAG: 21
 message ConfigProto {
 	optional string comment = 8;
 	optional bool is_extension = 13;
@@ -36,5 +36,14 @@ message ConfigProto {
 	optional int32 tpi = 16 [ (help) = "TPI of image; if 0, use TPI of drive" ];
 
 	optional FilesystemProto filesystem = 17;
+	
+	repeated OptionProto option = 20;
+}
+
+message OptionProto {
+	optional string name = 1 [(help) = "Option name" ];
+	optional string comment = 2 [(help) = "Help text for option" ];
+	optional string message = 3 [(help) = "Message to display when option is in use" ];
+	optional ConfigProto config = 4 [(help) = "Option data" ];
 }