revise argument processing
[rrq/fusefile.git] / fusefile.8
index 7051d94aa5277aee40ce2bf6070d685f5e5e5eb0..e2577c195a4073653d7b64a8eb1481177f7a1ad9 100644 (file)
@@ -1,17 +1,19 @@
 .mso www.tmac
 .TH fusefile 8
 .SH NAME
-fusefile \- FUSE file mount for combining file fragments read-only
+fusefile \- FUSE file mount for combining file fragments
 
 .SH SYNOPSIS
 .B fusefile \fR[fuse options\fR] \fBmountpoint\fR \fIfilename/from-to\fR ...
 
 .SH DESCRIPTION
 
-\fBfusefile\fR is FUSE file mount that presents a series of fragments of
-other files as a contiguous concatenation. It bind mounts a driver on
-top of the file mountpoint to present the nominated file fragments as
-a single, contiguous file.
+\fBfusefile\fR is FUSE file mount that presents a series of fragments
+of other files as a contiguous concatenation. It bind mounts a driver
+on top of the file mountpoint to present the nominated file fragments
+as a single, contiguous file. It accepts over-writing on the fused
+file which gets distributed accordingly to the fragments, but cannot
+change size.
 
 The fragment arguments include the filename of a source file, and
 optionally start and end byte positions. All in all there five
@@ -35,15 +37,6 @@ included).
 \fIfilename/from-to\fR
 include the file from the given start position, up to the given end
 position (not included).
-.TP
-\fBpad=\fIfilename\fR
-
-when this is given as first argument, the fused file is set up as a
-writable random-access file, where the write events are captured
-appended to the nominated "pad" file. The new content is inserted into
-the fused file but not the original files, and fragments are split up
-and adjusted as needed so as to make the write events appear as
-insertions inteo the fused file.
 
 .SH EXAMPLES
 
@@ -61,21 +54,16 @@ Make file y be a swap of the beginning and end of file "x", at position 2442:
 
 .SH NOTES
 
-Note that \fBfusefile\fR opens the nominated source file(s) before bind
-mounting. With the fuse option \fI-ononempty\fR it will bind over an
-non-empty file, which may be useful. The source file descriptors
+Note that \fBfusefile\fR opens the nominated source file(s) before
+bind mounting. With the fuse option \fI-ononempty\fR 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 the fused file will present the new content. If a source
+is reduced in size, access will be inconsistent.
 
 If the mountpoint file doesn't exist, then \fBfusefile\fR creates it,
 and removes it when unmounted.
 
-When a "pad" file is used, it is updated as an "ar" archive where each
-write event is a new member appended at the end. The "pad" member has
-two additional, newline-terminated text lines with the insertion
-position and the member size (ascii decimal digits), before the actual
-insertion event content.
-
 .SH AUTHOR
 
 Ralph Rönnquist <ralph.ronnquist@gmail.com>