editorial 0.4
authorRalph Ronnquist <ralph.ronnquist@gmail.com>
Sun, 31 Jul 2022 23:39:43 +0000 (09:39 +1000)
committerRalph Ronnquist <ralph.ronnquist@gmail.com>
Sun, 31 Jul 2022 23:39:43 +0000 (09:39 +1000)
README.adoc

index 00ce11b9ed4a6414f35624391431c93acb1e71b6..500e81bb528e3abffbff7e2c968a738ec75b5fc4 100644 (file)
@@ -9,7 +9,10 @@ only for parts files that are writable upon first access.
 FUSE file mount for combining file fragments.
  
 == SYNOPSIS
- *fusefile* [_fuse options_] *mountpoint* _filename/from-to_ ...
+
+====
+*fusefile* [ _fuse options_ ] *mountpoint*  +_filename_/from:to+ ...
+====
 
 ## DESCRIPTION
 
@@ -30,20 +33,35 @@ variations:
 
  * __filename/-to__ include the file from beginning to the given end position (not included).
 
- * __filename/from-to__ include the file from the given start position, up to the given end position (not included). 
+ * __filename/from:to__ include the file from the given start position, up to the given end position (not included). 
 
 ## EXAMPLES
 
-Insert file "y" into file "x" at position 1200:
+.Insert file "y" into file "x" at position 1200:
   
-    $ fusefile -ononempty x x/-1200 y x/1200
-The bind mount shadows the original file "x", and presents the
-composite instead.
+    $ fusefile -ononempty x x/:1200 y x/1200:
+
+That mount will shadow the original file "x", and presents the
+fused file instead.
+
+.Make file y be a swap of the beginning and end of file "x", at position 2442:
 
-Make file y be a swap of the beginning and end of file "x", at
-position 2442:
+    $ fusefile y x/2442: x/:2442
+
+.Replace a partition in an image file with a different file
+
+    $ partx -oNR,START,SECTORS disk.raw
+    NR   START  SECTORS
+     1    2048  2097152
+     2 2099200   409600
+     3 2508800 14268383
+    # Replace partition 2 of 409600 sectors from 2099200 with
+    # the file "insert.fat" clipped to 409600 sectors.
+    $ fusefile -ononempty disk.raw \
+         disk.raw/0:$(( 2099200*512 )) \
+         insert.fat/0:$(( 409600*512 )) \
+         disk.raw/$(( (2099200+409600)*512 )):
 
-    $ fusefile y x/2442 x/-2442
 
 ## NOTES
 
@@ -51,10 +69,13 @@ Note that **fusefile** opens the nominated source file(s) before bind
 mounting. With the fuse option __-ononempty__ it will bind over an
 non-empty file, which may be useful. The source file descriptors
 remain open, but the source fragments are not recomputed. If a source
-file changes or reduces in size, anything may happen.
+file changes or reduces in size "behind" the fused file, then anything
+may happen.
+
+If the mountpoint file doesn't exist, then **fusefile** creates it and
+removes it when unmounted.
 
-If the mountpoint file doesn't exist, then **fusefile** creates it,
-and removes it when unmounted.
+Unmounting is done with "fusermount -u __fused file__" as usual.
 
 ## AUTHOR