e2577c195a4073653d7b64a8eb1481177f7a1ad9
[rrq/fusefile.git] / fusefile.8
1 .mso www.tmac
2 .TH fusefile 8
3 .SH NAME
4 fusefile \- FUSE file mount for combining file fragments
5
6 .SH SYNOPSIS
7 .B fusefile \fR[fuse options\fR] \fBmountpoint\fR \fIfilename/from-to\fR ...
8
9 .SH DESCRIPTION
10
11 \fBfusefile\fR is FUSE file mount that presents a series of fragments
12 of other files as a contiguous concatenation. It bind mounts a driver
13 on top of the file mountpoint to present the nominated file fragments
14 as a single, contiguous file. It accepts over-writing on the fused
15 file which gets distributed accordingly to the fragments, but cannot
16 change size.
17
18 The fragment arguments include the filename of a source file, and
19 optionally start and end byte positions. All in all there five
20 variations:
21 .TP
22 \fIfilename\fR
23 include all of the file.
24 .TP
25 \fIfilename/\fR
26 include all of the file named with "/" in the pathname. This case
27 requires a final "/", since the last "/" separates the filename from
28 the position details.
29 .TP
30 \fIfilename/from\fR
31 include the file from the given start position, to end.
32 .TP
33 \fIfilename/-to\fR
34 include the file from beginning to the given end position (not
35 included).
36 .TP
37 \fIfilename/from-to\fR
38 include the file from the given start position, up to the given end
39 position (not included).
40
41 .SH EXAMPLES
42
43 Insert file "y" into file "x" at position 1200:
44 .RS
45 \fB$ fusefile -ononempty x x/-1200 y x/1200\fR
46 .RE
47 The bind mount shadows the original file "x", and presents the
48 composite instead.
49
50 Make file y be a swap of the beginning and end of file "x", at position 2442:
51 .RS
52 \fB$ fusefile y x/2442 x/-2442\fR
53 .RE
54
55 .SH NOTES
56
57 Note that \fBfusefile\fR opens the nominated source file(s) before
58 bind mounting. With the fuse option \fI-ononempty\fR it will bind over
59 an non-empty file, which may be useful. The source file descriptors
60 remain open, but the source fragments are not recomputed. If a source
61 file changes the fused file will present the new content. If a source
62 is reduced in size, access will be inconsistent.
63
64 If the mountpoint file doesn't exist, then \fBfusefile\fR creates it,
65 and removes it when unmounted.
66
67 .SH AUTHOR
68
69 Ralph Rönnquist <ralph.ronnquist@gmail.com>