/usr/share/doc/monotone/html/File-Attributes.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
<head>
<title>monotone documentation: File Attributes</title>

<meta name="description" content="monotone documentation: File Attributes">
<meta name="keywords" content="monotone documentation: File Attributes">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="General-Index.html#General-Index" rel="index" title="General Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Advanced-Uses.html#Advanced-Uses" rel="up" title="Advanced Uses">
<link href="Migrating-and-Dumping.html#Migrating-and-Dumping" rel="next" title="Migrating and Dumping">
<link href="Naming-Conventions.html#Naming-Conventions" rel="prev" title="Naming Conventions">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="texinfo.css">


</head>

<body lang="en">
<a name="File-Attributes"></a>
<div class="header">
<p>
Next: <a href="Migrating-and-Dumping.html#Migrating-and-Dumping" accesskey="n" rel="next">Migrating and Dumping</a>, Previous: <a href="Naming-Conventions.html#Naming-Conventions" accesskey="p" rel="prev">Naming Conventions</a>, Up: <a href="Advanced-Uses.html#Advanced-Uses" accesskey="u" rel="up">Advanced Uses</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="General-Index.html#General-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="File-Attributes-1"></a>
<h3 class="section">3.14 File Attributes</h3>

<p>Monotone contains a support for storing <em>persistent attributes</em> on
files and directories, generally known as <em>attrs</em> for short.  An
attr associates a simple name/value pair with a file or directory, and
is stored in the manifest.  Attrs are first-class versioned data; they
can be changed in a workspace, and those changes will be saved when
the workspace is committed.  The merger knows how to intelligently
merge attrs.
</p>
<p>The attribute mechanism was originally motivated by the fact that some
people like to store executable programs in version control systems,
and would like the programs to remain executable when they check out a
workspace.  For example, the <code>configure</code> shell script commonly
shipped with many programs should be executable.  Similarly, some
people would like to store devices, symbolic links, read-only files,
and all manner of extra attributes of a file, not directly related to
a file&rsquo;s data content.
</p>
<p>Monotone comes with support for some attrs built-in; for instance, if
an executable file is given to <code>mtn add</code>, then it will
automatically mark the new file with a <code>mtn:execute</code> attr, and
when the file is checked out later, the executable bit will be set
automatically.  (Of course, if it is checked out on Windows, which
does not support the executable bit, then the executable bit will not
be set.  However, monotone will still know that the attr is set, and
Windows users can view and modify the attr like anyone else.)
</p>
<p>Attrs in the current workspace can be seen and modified using the
<code><a href="Workspace.html#mtn-attr">mtn attr</a></code> command.  Attrs can also be found by examining any
manifest directly.
</p>
<p>You can tell monotone to automatically take actions based on these
attributes by defining hooks; see <a href="Attribute-Handling.html#attr_005ffunctions">attr_functions</a>.  Every time
your workspace is written to, monotone will run the corresponding
hooks registered for each attr in your workspace.  This way, you can
extend the vocabulary of attrs understood by monotone simply by
writing new hooks.
</p>
<p>You can make up your own attrs for anything you find useful; the
mechanism is fully general.  (If you make up some particularly useful
ones, we may even be interested in adding support to monotone proper.)
We only ask that if you do use custom attrs, you use some prefix for
them besides <code>mtn:</code>; attrs beginning with <code>mtn:</code> are
reserved for monotone&rsquo;s own use.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Migrating-and-Dumping.html#Migrating-and-Dumping" accesskey="n" rel="next">Migrating and Dumping</a>, Previous: <a href="Naming-Conventions.html#Naming-Conventions" accesskey="p" rel="prev">Naming Conventions</a>, Up: <a href="Advanced-Uses.html#Advanced-Uses" accesskey="u" rel="up">Advanced Uses</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="General-Index.html#General-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
monotone-doc 1.1-7 / usr / share / doc / monotone / html / File-Attributes.html
