use signed offsets
[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 read-only
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 of
12 other files as a contiguous concatenation. It bind mounts a driver on
13 top of the file mountpoint to present the nominated file fragments as
14 a single, contiguous file.
15
16 The fragment arguments include the filename of a source file, and
17 optionally start and end byte positions. All in all there five
18 variations:
19 .TP
20 \fIfilename\fR
21 include all of the file.
22 .TP
23 \fIfilename/\fR
24 include all of the file named with "/" in the pathname. This case
25 requires a final "/", since the last "/" separates the filename from
26 the position details.
27 .TP
28 \fIfilename/from\fR
29 include the file from the given start position, to end.
30 .TP
31 \fIfilename/-to\fR
32 include the file from beginning to the given end position (not
33 included).
34 .TP
35 \fIfilename/from-to\fR
36 include the file from the given start position, up to the given end
37 position (not included).
38
39 .SH EXAMPLES
40
41 Insert file "y" into file "x" at position 1200:
42 .RS
43 \fB$ fusefile -ononempty x x/-1200 y x/1200\fR
44 .RE
45 The bind mount shadows the original file "x", and presents the
46 composite instead.
47
48 Make file y be a swap of the beginning and end of file "x", at position 2442:
49 .RS
50 \fB$ fusefile y x/2442 x/-2442\fR
51 .RE
52
53 .SH NOTES
54
55 Note that \fBfusefile\fR opens the nominated source file(s) before bind
56 mounting. With the fuse option \fI-ononempty\fR it will bind over an
57 non-empty file, which may be useful. The source file descriptors
58 remain open, but the source fragments are not recomputed. If a source
59 file changes or reduces in size, anything may happen.
60
61 If the mountpoint file doesn't exist, then \fBfusefile\fR creates it,
62 and removes it when unmounted.
63
64 .SH AUTHOR
65
66 Ralph Rönnquist <ralph.ronnquist@gmail.com>