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 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.
  11
  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.
  15
  16
  17 Stored metadata
  18 ---------------
  19
  20 metastore stores following metadata in its files:
  21
  22 - owner,
  23 - group,
  24 - permissions,
  25 - xattrs,
  26 - mtime - optionally.
  27
  28
  29 Usage
  30 -----
  31
  32 See metastore.txt file, which is plain-text version of the manual page.
  33
  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.
  42
  43
  44 File format
  45 -----------
  46
  47 See FILEFORMAT file, which describes internals of metastore file.
  48
  49
  50 Requirements
  51 ------------
  52
  53 - Linux
  54 - GNU make
  55 - C99 compiler, like gcc or clang
  56 - libbsd
  57
  58
  59 Download
  60 --------
  61
  62 You can obtain any released version (tarball and signature) from:
  63
  64     ftp://ftp.przemoc.net/pub/software/utils/metastore/
  65     http://ftp.przemoc.net/pub/software/utils/metastore/
  66
  67 Signer should be the current maintainer, see AUTHORS file.
  68
  69 Alternatively, you can get it from:
  70
  71     https://github.com/przemoc/metastore/releases/
  72
  73 If you want to see the latest source code, then git clone following URL:
  74
  75     https://github.com/przemoc/metastore
  76
  77
  78 Building
  79 --------
  80
  81 Simply run `make` from project's root directory.
  82
  83 Building out-of-tree is supported out-of-the-box. Go to your chosen
  84 build directory and run there:
  85
  86     $ make -f path/to/metastore/Makefile
  87
  88
  89 Installation
  90 ------------
  91
  92 Run `make install`.  Default settings for installation are:
  93
  94      PREFIX      = /usr/local
  95
  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)
 106
 107 You can always change them, e.g.:
 108
 109     $ make install PREFIX=/usr
 110
 111 DESTDIR is also supported.
 112
 113
 114 Reporting issues
 115 ----------------
 116
 117 Please use the issue tracker provided by GitHub to send bug reports
 118 or feature requests.
 119
 120 https://github.com/przemoc/metastore/issues
 121
 122 If you're sending a bug report, then please provide some basic info:
 123
 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}')`)
 135
 136
 137 Mailing list
 138 ------------
 139
 140 metastore has one official read-only mailing list dedicated to
 141 announcements like new version releases or other important updates.
 142
 143 You can subscribe it using following web page:
 144 https://www.freelists.org/list/metastore-announce
 145
 146 or by sending email to metastore-announce-request@freelists.org
 147 with `subscribe` in the Subject field.
 148
 149 Archive for metastore-announce mailing list is available at:
 150 https://www.freelists.org/archive/metastore-announce
 151
 152
 153 License
 154 -------
 155
 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.