README

   1 metastore
   2 =========
   3
   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.
   7
   8 It was written as a supplement to git which does not store all metadata,
   9 making it unsuitable for e.g. storing /etc in a repository.
  10
  11 metastore can also be helpful if you want to create a tarball of a file
  12 tree and make sure that "everything" (e.g. xattrs, mtime, owner, group)
  13 is stored along with the files.
  14
  15
  16 Stored metadata
  17 ---------------
  18
  19 metastore stores following metadata in its files:
  20
  21 - owner,
  22 - group,
  23 - permissions,
  24 - xattrs,
  25 - mtime - optionally.
  26
  27
  28 Usage
  29 -----
  30
  31 See man1/metastore.1 file, which is the manual page.
  32
  33
  34 File format
  35 -----------
  36
  37 See FILEFORMAT file, which describes internals of metastore file.
  38
  39
  40 Requirements
  41 ------------
  42
  43 - Linux
  44 - GNU make
  45 - C99 compiler, like gcc or clang
  46 - libbsd
  47
  48
  49 Building
  50 --------
  51
  52 Simply run `make` from project's root directory.
  53
  54 Building out-of-tree is supported out-of-the-box. Go to your chosen
  55 build directory and run there:
  56
  57     $ make -f path/to/metastore/Makefile
  58
  59
  60 Installation
  61 ------------
  62
  63 Run `make install`.  Default settings for installation are:
  64
  65      PREFIX      = /usr/local
  66      EXECPREFIX  = ${PREFIX}           (/usr/local)
  67      BINDIR      = ${EXECPREFIX}/bin   (/usr/local/bin)
  68      DATAROOTDIR = ${PREFIX}/share     (/usr/local/share)
  69      MANDIR      = ${DATAROOTDIR}/man  (/usr/local/share/man)
  70
  71 You can always change them, e.g.:
  72
  73     $ make install PREFIX=/usr
  74
  75 DESTDIR is also supported.
  76
  77
  78 Reporing issues
  79 ---------------
  80
  81 Please use the issue tracker provided by GitHub to send bug reports
  82 or feature requests.
  83
  84 https://github.com/przemoc/metastore/issues
  85
  86
  87 License
  88 -------
  89
  90 The project is licensed under the terms of the GNU GPL v2 only license.
  91 See LICENSE.GPLv2 file for the full license text.