/usr/share/doc/git-annex/html/metadata.html is in git-annex 5.20140412ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>metadata</title>
<link rel="stylesheet" href="style.css" type="text/css" />
<link rel="stylesheet" href="local.css" type="text/css" />
</head>
<body>
<div class="page">
<div class="pageheader">
<div class="header">
<span>
<span class="parentlinks">
<a href="./index.html">git-annex</a>/
</span>
<span class="title">
metadata
</span>
</span>
</div>
</div>
<div class="sidebar">
<p><img src="./logo_small.png" width="150" height="142" class="img" /></p>
<ul>
<li><a href="./install.html">install</a></li>
<li><a href="./assistant.html">assistant</a></li>
<li><a href="./walkthrough.html">walkthrough</a></li>
<li><a href="./tips.html">tips</a></li>
<li><span class="createlink">bugs</span></li>
<li><span class="createlink">todo</span></li>
<li><span class="createlink">forum</span></li>
<li><a href="./comments.html">comments</a></li>
<li><a href="./contact.html">contact</a></li>
<li><a href="http://flattr.com/thing/84843/git-annex">Flattr this</a></li>
</ul>
</div>
<div id="pagebody">
<div id="content">
<p>git-annex allows you to store arbitrary metadata about the content of files
stored in the git-annex repository. The metadata is stored in the
<code>git-annex</code> branch, and so is automatically kept in sync with the rest of
git-annex's state, such as <a href="./location_tracking.html">location tracking</a> information.</p>
<p>Some of the things you can do with metadata include:</p>
<ul>
<li>Using <code>git annex metadata file</code> to show all
the metadata associated with a file.</li>
<li><a href="./tips/metadata_driven_views.html">metadata driven views</a></li>
<li>Limiting the files git-annex commands act on to those with
or without particular metadata.
For example <code>git annex find --metadata tag=foo --or --metadata tag=bar</code></li>
<li>Using it in <a href="./preferred_content.html">preferred content</a> expressions.
For example "metadata=tag=important or not metadata=author=me"</li>
</ul>
<p>Each file (actually the underlying key) can have any number of metadata
fields, which each can have any number of values. For example, to tag
files, the <code>tag</code> field is typically used, with values set to each tag that
applies to the file.</p>
<p>The field names are limited to alphanumerics (and <code>[_-.]</code>), and are case
insensitive. The metadata values can contain absolutely anything you
like -- but you're recommended to keep it simple and reasonably short.</p>
<p>Here are some metadata fields that git-annex has special support for:</p>
<ul>
<li><code>tag</code> - With each tag being a different value.</li>
<li><code>year</code>, <code>month</code> - When this particular version of the file came into
being.</li>
<li><code>$field-lastchanged</code> - This is automatically maintained for each
field that's set, and gives the date and time of the most recent
change to the field. It cannot be modified directly.</li>
<li><code>lastchanged</code> - This is automatically maintained, giving the data and time
of the last change to any of the metadata of a file.</li>
</ul>
<p>To make git-annex automatically set the year and month when adding files,
run <code>git config annex.genmetadata true</code>. Also, see
<a href="./tips/automatically_adding_metadata.html">automatically adding metadata</a>.</p>
<p>git-annex's metadata can be updated in a distributed fashion. For example,
two users, each with their own clone of a repository, can set and unset
metadata at the same time, even for the same field of the same file.
When they push their changes, <code>git annex merge</code> will combine their
metadata changes in a consistent and (probably) intuitive way.</p>
<p>See <a href="./design/metadata.html">the metadata design page</a> for more details.</p>
</div>
<div id="comments">
<div class="feedlink">
</div>
<div class="comment" id="comment-0a7ea47f7a1a44a33391a00daecca485">
<div class="comment-subject">
<a href="/metadata.html#comment-0a7ea47f7a1a44a33391a00daecca485">access metadata by key?</a>
</div>
<div class="inlinecontent">
<p>I'm hacking around with using metadata from an external special remote. Those work with keys, not files, so one option would be to add a GETMETADATA to the protocol. It also seems like it would not be too hard to add
an option to "git annex metadata" to take a key rather than a file.</p>
</div>
<div class="comment-header">
Comment by
<span class="author" title="Signed in">
<a href="?page=bremner&do=goto">bremner</a>
</span>
— <span class="date">Mon Mar 17 01:26:44 2014</span>
</div>
<div style="clear: both"></div>
</div>
<div class="comment" id="comment-1e123600d76868ae0e6d145b6c1b4cac">
<div class="comment-subject">
<a href="/metadata.html#comment-1e123600d76868ae0e6d145b6c1b4cac">comment 2</a>
</div>
<div class="inlinecontent">
<p>I've made <code>git annex metadata --key</code> work.</p>
<p>I'll wait and see what you come up with your special remote and add something to the protocol later if it makes sense.</p>
</div>
<div class="comment-header">
Comment by
<span class="author" title="Signed in">
<a href="?do=goto&page=http%3A%2F%2Fjoeyh.name%2F">http://joeyh.name/</a>
</span>
— <span class="date">Mon Mar 17 19:32:39 2014</span>
</div>
<div style="clear: both"></div>
</div>
<div class="addcomment">Comments on this page are closed.</div>
</div>
</div>
<div id="footer" class="pagefooter">
<div id="pageinfo">
<div id="backlinks">
Links:
<a href="./tips/automatically_adding_metadata.html">tips/automatically adding metadata</a>
<a href="./tips/metadata_driven_views.html">tips/metadata driven views</a>
</div>
<div class="pagedate">
Last edited <span class="date">Fri Apr 11 22:12:28 2014</span>
<!-- Created <span class="date">Fri Apr 11 22:12:28 2014</span> -->
</div>
</div>
<!-- from git-annex -->
</div>
</div>
</body>
</html>
|