Move man pages for section 1 to man1/ directory.
[metastore.git] / man1 / metastore.1
blob950360c96b3307a3f4722eb5f36628ffe7df38c9
1 .TH metastore "1" "September 2015"
2 .\"
3 .SH NAME
4 metastore \- stores and restores filesystem metadata
5 .\"
6 .SH SYNOPSIS
7 \fBmetastore\fR \fIACTION\fR [\fIOPTION...\fR] [\fIPATH...\fR]
8 .\"
9 .SH DESCRIPTION
10 Stores or restores metadata (owner, group, permissions, xattrs and optionally
11 mtime) for a filesystem tree. This can be used to preserve the metadata in
12 situations where it is usually not stored (git and tar for example) or as
13 a tripwire like mechanism to detect any changes to metadata. Note that e.g.
14 SELinux stores its labels in xattrs so care should be taken when applying
15 stored metadata to make sure that system security is not compromised.
16 .\"
17 .SH ACTIONS
18 .TP
19 .B \-c, \-\-compare
20 Shows the difference between the stored and real metadata.
21 .TP
22 .B \-s, \-\-save
23 Saves the current metadata to ./.metadata or to the specified file
24 (see \-\-file option below).
25 .TP
26 .B \-a, \-\-apply
27 Attempts to apply the stored metadata to the file system.
28 .TP
29 .B \-d, \-\-dump
30 Dumps stored (if no \fIPATH\fR is given) or real metadata (if \fIPATH\fR is
31 present, e.g. \fB./\fR) in human-readable form.
33 This action is meant only as a helpful debugging facility or merge conflict
34 helper. Do not ever compare its output generated using different metastore
35 version. Do not rely on current output format (especially in batch scripts),
36 because it may change in future without prior notice.
37 .TP
38 .B \-h, \-\-help
39 Prints a help message and exits.
40 .\"
41 .SH OPTIONS
42 .TP
43 .B \-v, \-\-verbose
44 Causes metastore to print more verbose messages. Can be repeated more than
45 once for even more verbosity.
46 .TP
47 .B \-q, \-\-quiet
48 Causes metastore to print less verbose messages. Can be repeated more than
49 once for even less verbosity.
50 .TP
51 .B \-m, \-\-mtime
52 Causes metastore to also take mtime into account for the compare or apply actions.
53 .TP
54 .B \-e, \-\-empty\-dirs
55 Also attempts to recreate missing empty directories. May be useful where
56 empty directories are not tracked (e.g. by git or cvs).
57 Only works in combination with the \fBapply\fR option.
58 .TP
59 .B -E, --remove-empty-dirs
60 Also attempts to remove empty directories missing from the metadata. May be
61 useful where empty directories are not tracked (e.g. by git or cvs).  Only
62 works in combination with the \fBapply\fR option.
63 .TP
64 .B \-g, \-\-git
65 Prevents metastore from omitting .git directories.
66 .TP
67 .B \-f <file>, \-\-file <file>
68 Causes the metadata to be saved, read from the specified file rather
69 than ./.metadata.
70 .\"
71 .SH PATHS
72 If no path is specified, metastore will use the current directory as the basis
73 for the actions. This is the recommended way of executing metastore.
74 Alternatively, one or more paths can be specified and they will each be
75 examined. Later invocations should be made using the exact same paths to
76 ensure that the stored metadata is interpreted correctly.
77 .\"
78 .SH AUTHOR
79 Written by David Härdeman <david@hardeman.nu>