-
Notifications
You must be signed in to change notification settings - Fork 1
/
thincow.1
104 lines (75 loc) · 2.35 KB
/
thincow.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
.TH THINCOW 1
.SH NAME
thincow \- create a deduplicated, COW view of block devices as a FUSE filesystem
.SH SYNOPSIS
\fBthincow\fP \fIOPTION\fP... \fITARGET\fP
.SH DESCRIPTION
.B thincow
enables non-destructive, copy-on-write edits of block devices involving copying/moving a lot of data around, using deduplication for minimal additional disk usage.
For a detailed description, please see the full documentation:
.I https://github.com/CyberShadow/thincow#readme
.SH OPTIONS
.TP
\fITARGET\fP
Where to mount the FUSE filesystem.
.TP
\fB--upstream\fP=\fIPATH\fP
Directory containing upstream devices/symlinks.
.TP
\fB--data-dir\fP=\fIPATH\fP
Directory where to store COW blocks.
.TP
\fB--metadata-dir\fP=\fIPATH\fP
Directory where to store metadata. If unspecified, defaults to the data directory.
Specify "-" to use RAM.
.TP
\fB--temp-dir\fP=\fIPATH\fP
Directory where to store large temporary data. If unspecified, defaults to "-" (RAM).
.TP
\fB--block-size\fP=\fIBYTES\fP
Block size.
Larger blocks means smaller metadata, but writes smaller than one block will cause a read-modify-write. The default is 512.
.TP
\fB--hash-table-size\fP=\fIBYTES\fP
Hash table size.
The default is 1073741824 (1 GiB).
.TP
\fB--max-block-map-size\fP=\fIBYTES\fP
Maximum size of the block map.
.TP
\fB--max-cow-blocks\fP=\fIBLOCKS\fP
Maximum number of blocks in the COW store.
.TP
\fB--checksum-bits\fP=\fIBITS\fP
Enable integrity checking, BITS per block.
.TP
\fB--retroactive\fP
Enable retroactive deduplication (more I/O intensive).
.TP
\fB-f\fP, \fB--foreground\fP
Run in foreground.
.TP
\fB--pid-file\fP=\fIPATH\fP
Lock and write PID to this file.
.TP
\fB-R\fP, \fB--read-only\fP
Read-only mode (all writing will be disabled).
Implies --read-only-upstream.
.TP
\fB-r\fP, \fB--read-only-upstream\fP
Open upstream devices in read-only mode (flushing will be disabled).
.TP
\fB-o\fP, \fB--options\fP=\fISTR\fP
Additional FUSE options (e.g. debug).
.TP
\fB--fsck\fP
Perform data validity check on startup.
.TP
\fB--no-mount\fP
Don't actually mount the filesystem, and exit after initialization/fsck.
.SH BUGS
Please report defects and enhancement requests to the GitHub issue tracker:
.I https://github.com/CyberShadow/thincow/issues
.SH AUTHORS
\fBthincow\fR is written by Vladimir Panteleev <thincow@c\fRy.m\fRd> and contributors:
.I https://github.com/CyberShadow/thincow/graphs/contributors