| blob | 02b05455662ece90782c9cec7ab127a91ccc7139 |
1 metastore
2 =========
4 metastore is a tool to store the metadata of files/directories/links in
5 a file tree to a separate file and to later compare and apply the stored
6 metadata to said file tree.
8 It was originally written as a supplement to git, which does not store
9 all metadata, making it unsuitable for e.g. storing /etc in a
10 repository.
12 metastore can also be helpful if you want to create a tarball of a file
13 tree and make sure that "everything" (e.g. xattrs, mtime, owner, group)
14 is stored along with the files.
17 Stored metadata
18 ---------------
20 metastore stores following metadata in its files:
22 - owner,
23 - group,
24 - permissions,
25 - xattrs,
26 - mtime - optionally.
29 Usage
30 -----
32 See metastore.txt file, which is plain-text version of the manual page.
34 If you want to use metastore within git repository, then consider
35 copying exemplary scripts from examples/hooks/ directory to hooks
36 subdirectory in your git directory, and make them executable.
37 You can also tune them if it's necessary. But.
38 Before using, please read the warning in the comments of pre-commit hook.
39 Mind that merge conflicts can only be solved manually, because metastore
40 file is binary in its current form (there's a plan to fix it in future).
41 Dump action can be really helpful in such cases.
44 File format
45 -----------
47 See FILEFORMAT file, which describes internals of metastore file.
50 Requirements
51 ------------
53 - Linux
54 - GNU make
55 - C99 compiler, like gcc or clang
56 - libbsd
59 Download
60 --------
62 You can obtain any released version (tarball and signature) from:
64 ftp://ftp.przemoc.net/pub/software/utils/metastore/
65 http://ftp.przemoc.net/pub/software/utils/metastore/
67 Signer should be the current maintainer, see AUTHORS file.
69 Alternatively, you can get it from:
71 https://github.com/przemoc/metastore/releases/
73 If you want to see the latest source code, then git clone following URL:
75 https://github.com/przemoc/metastore
78 Building
79 --------
81 Simply run `make` from project's root directory.
83 Building out-of-tree is supported out-of-the-box. Go to your chosen
84 build directory and run there:
86 $ make -f path/to/metastore/Makefile
89 Installation
90 ------------
92 Run `make install`. Default settings for installation are:
94 PREFIX = /usr/local
96 EXECPREFIX = ${PREFIX}
97 (/usr/local)
98 BINDIR = ${EXECPREFIX}/bin
99 (/usr/local/bin)
100 DATAROOTDIR = ${PREFIX}/share
101 (/usr/local/share)
102 DOCDIR = ${DATAROOTDIR}/doc/metastore
103 (/usr/local/share/doc/metastore)
104 MANDIR = ${DATAROOTDIR}/man
105 (/usr/local/share/man)
107 You can always change them, e.g.:
109 $ make install PREFIX=/usr
111 DESTDIR is also supported.
114 Reporting issues
115 ----------------
117 Please use the issue tracker provided by GitHub to send bug reports
118 or feature requests.
120 https://github.com/przemoc/metastore/issues
122 If you're sending a bug report, then please provide some basic info:
124 - What system do you have?
125 (`uname -a`, `lsb_release -drc`)
126 - What gcc version have you used for building metastore?
127 (`gcc -v`)
128 - Do you use any custom FLAGS during build?
129 (`set | grep FLAGS=`)
130 - What libc implementation and version are you using?
131 - What metastore version are you using?
132 (`metastore -V`)
133 - What filesystem do you use and how it is mounted?
134 (`mount | grep $(df . | awk 'NR==2{print$1}')`)
137 Mailing list
138 ------------
140 metastore has one official read-only mailing list dedicated to
141 announcements like new version releases or other important updates.
143 You can subscribe it using following web page:
144 https://www.freelists.org/list/metastore-announce
146 or by sending email to metastore-announce-request@freelists.org
147 with `subscribe` in the Subject field.
149 Archive for metastore-announce mailing list is available at:
150 https://www.freelists.org/archive/metastore-announce
153 License
154 -------
156 The project is licensed under the terms of the GNU GPL v2 only license.
157 See LICENSE.GPLv2 file for the full license text.