/usr/share/doc/monotone/html/Automation.html

<html lang="en">
<head>
<title>Automation - monotone documentation</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="monotone documentation">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Command-Reference.html#Command-Reference" title="Command Reference">
<link rel="prev" href="Database.html#Database" title="Database">
<link rel="next" href="VCS.html#VCS" title="VCS">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
<link rel="stylesheet" type="text/css" href="texinfo.css">
</head>
<body>
<div class="node">
<a name="Automation"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="VCS.html#VCS">VCS</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Database.html#Database">Database</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Command-Reference.html#Command-Reference">Command Reference</a>
<hr>
</div>

<h3 class="section">4.11 Automation</h3>

<p>This section contains subcommands of the <samp><span class="command">mtn automate</span></samp> command,
used for scripting monotone.  All give output on <code>stdout</code>; they may
also give useful chatter on <code>stderr</code>, including warnings and error
messages.

<p>When run under <a href="mtn-automate-stdio.html#mtn-automate-stdio">mtn automate stdio</a>, there are five output streams
available; main, error, warning, progress, and ticker. When run under
<samp><span class="command">mtn automate</span></samp>, the main stream goes to stdout, and the error,
warning, progress, and ticker streams all go to stderr.

<p>Many commands produce output in a format called basic_io; for more
information, see <a href="Formats.html#Formats">Formats</a>.

<p>Revision arguments to automate commands must be hex ids, not
selectors.

     <dl>
<a name="mtn-automate-ancestors"></a><dt><samp><span class="command">mtn automate ancestors </span><var>rev...</var></samp><a name="index-mtn-automate-ancestors-_0040var_007brev_002e_002e_002e_007d-192"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One or more revision IDs.

          <br><dt><strong>Added in:</strong><dd>
0.2

          <br><dt><strong>Purpose:</strong><dd>
Prints the ancestors of one or more revisions.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one ancestor of the given
revisions.  Each line consists of a revision ID, in hexadecimal,
followed by a newline.  The lines are printed in alphabetically sorted
order.

          <p>The output does not include the specified revisions, except if
one of them is an ancestor of another.

          <br><dt><strong>Error conditions:</strong><dd>
If any of the revisions do not exist, prints nothing to stdout, prints
an error message to stderr, and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate ancestry_difference </span><var>new</var><span class="command"> [</span><var>old...</var><span class="command">]</span></samp><a name="index-mtn-automate-ancestry_005fdifference-_0040var_007bnew_007d-_005b_0040var_007bold_002e_002e_002e_007d_005d-193"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A &ldquo;new&rdquo; revision ID <var>new</var>, followed by zero or more &ldquo;old&rdquo;
revision IDs <var>old...</var>.

          <br><dt><strong>Added in:</strong><dd>
0.1

          <br><dt><strong>Purpose:</strong><dd>
Prints all ancestors of the new revision, that are not also ancestors
of one of the old revisions.  For purposes of this command,
&ldquo;ancestor&rdquo; is an inclusive term; each revision is an ancestor of
itself. For example, if <var>new</var> is an ancestor of any of
<var>old...</var>, <var>new</var> will not be printed; but if <var>new</var> is not
an ancestor of any of the &ldquo;old&rdquo; revisions, then it will be. 
Similarly, none of <var>old...</var> will be printed.

          <p>The reason for the names <var>new</var> and <var>old</var> is that if <var>new</var>
is a newer revision than <var>old...</var>, then this command tells you
which all revisions that are newer than <var>old...</var>, and are also
ancestors of <var>new</var>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
A list of revision IDs, in hexadecimal, each followed by a newline. 
Revisions are printed in topologically sorted order.

          <br><dt><strong>Error conditions:</strong><dd>
If any of the revisions do not exist, prints nothing to stdout, prints
an error message to stderr, and exits with status 1.

     </dl>

     <p><a name="mtn-automate-branches"></a><br><dt><samp><span class="command">mtn automate branches</span></samp><a name="index-mtn-automate-branches-194"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
2.2

          <br><dt><strong>Purpose:</strong><dd>
Prints all branch certs present in the revision graph, that are not
excluded by the Lua hook <code><a href="ignore_005fbranch.html#ignore_005fbranch">ignore_branch</a></code>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          net.venge.monotone
          net.venge.monotone.win32
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each the name of a branch. The lines are printed
in alphabetically sorted order.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <br><dt><samp><span class="command">mtn automate cert </span><var>revision</var> <var>name</var> <var>value</var></samp><a name="index-mtn-automate-cert-_0040var_007brevision_007d-_0040var_007bname_007d-_0040var_007bvalue_007d-195"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
<var>revision</var> is an existing revision, <var>name</var> is the certificate name
and <var>value</var> its value.

          <br><dt><strong>Added in:</strong><dd>
4.1

          <br><dt><strong>Purpose:</strong><dd>
<samp><span class="command">automate</span></samp> variant of <samp><span class="command"><a href="mtn-cert.html#mtn-cert">mtn cert</a></span></samp>.

          <br><dt><strong>Sample usage:</strong><dd>
<pre class="verbatim">          mtn automate cert 4c2c1d846fa561601254200918fba1fd71e6795d author tester@test.net
     </pre>

          <br><dt><strong>Output format:</strong><dd>
No output.

          <br><dt><strong>Error conditions:</strong><dd>
If the revision is invalid prints an error message to stderr and
exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate certs </span><var>id</var></samp><a name="index-mtn-automate-certs-_0040var_007bid_007d-196"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A revision ID <var>id</var>, for which any certificates will be printed.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>11.0 &ndash; Keys are now listed by hash instead of name. 
<li>1.0 &ndash; Added. 
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Prints all certificates associated with the given revision ID. 
Each certificate is contained in a basic IO stanza. For each certificate,
the following values are provided:
<pre class="verbatim">          'key'
                the hex-encoded hash of the key used to sign this certificate.
          'signature'
                a string indicating the status of the signature. Possible
                values of this string are:
                      'ok'        : the signature is correct
                      'bad'       : the signature is invalid
                      'unknown'   : signature was made with an unknown key
          'name'
                the name of this certificate
          'value'
                the value of this certificate
          'trust'
                is this certificate trusted by the defined trust metric?
                Possible values of this string are:
                      'trusted'   : this certificate is trusted
                      'untrusted' : this certificate is not trusted
     </pre>

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">                key [5cd3b3a7ad2e8645e8887af193ee522dc59112e4]
          signature "ok"
               name "author"
              value "emile@alumni.reed.edu"
              trust "trusted"
          
                key [5cd3b3a7ad2e8645e8887af193ee522dc59112e4]
          signature "ok"
               name "branch"
              value "net.venge.monotone"
              trust "trusted"
          
                key [5cd3b3a7ad2e8645e8887af193ee522dc59112e4]
          signature "ok"
               name "changelog"
              value "propagate from branch 'net.venge.monotone.annotate' (head 76a886ef7c8ae12a4bba5fc2bd252557bf863aff)
                      to branch 'net.venge.monotone' (head 2490479a4e4e99243fead6d627d78291fde592f0)
          "
              trust "trusted"
          
                key [5cd3b3a7ad2e8645e8887af193ee522dc59112e4]
          signature "ok"
               name "date"
              value "2005-05-20T20:19:25"
              trust "trusted"
     </pre>

          <br><dt><strong>Output format:</strong><dd>
All stanzas are formatted by basic_io. Stanzas are separated
by a blank line. Values will be escaped, '\' to '\\' and
'"' to '\"'.

          <br><dt><strong>Error conditions:</strong><dd>
If a certificate is signed with an unknown public key, a warning
message is printed to stderr. If the revision specified is unknown or
invalid prints an error message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate checkout [--[no-]move-conflicting-paths] [--revision=</span><var>id</var><span class="command">] [--branch=</span><var>branchname</var><span class="command">] </span><var>directory</var></samp><a name="index-mtn-automate-checkout-_005b_002d_002d_005bno_002d_005dmove_002dconflicting_002dpaths_005d-_005b_002d_002drevision_003d_0040var_007bid_007d_005d-_005b_002d_002dbranch_003d_0040var_007bbranchname_007d_005d-_0040var_007bdirectory_007d-197"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
Options and arguments are the same as <samp><span class="command"><a href="mtn-checkout.html#mtn-checkout">mtn checkout</a></span></samp>.

          <br><dt><strong>Changes:</strong><dd>
13.0 &ndash; initial

          <br><dt><strong>Purpose:</strong><dd>
Create a new workspace containing the given revision; see
<samp><span class="command"><a href="mtn-checkout.html#mtn-checkout">mtn checkout</a></span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
None.

          <br><dt><strong>Output format:</strong><dd>
None.

          <br><dt><strong>Error conditions:</strong><dd>
see <samp><span class="command"><a href="mtn-checkout.html#mtn-checkout">mtn checkout</a></span></samp>.

     </dl>

     <br><dt><samp><span class="command">mtn automate children </span><var>rev</var></samp><a name="index-mtn-automate-children-_0040var_007brev_007d-198"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One revision ID, <var>rev</var>.

          <br><dt><strong>Added in:</strong><dd>
0.2

          <br><dt><strong>Purpose:</strong><dd>
Prints the immediate children of a revision.  This is like a
non-recursive version of <samp><span class="command"><a href="mtn-automate-descendents.html#mtn-automate-descendents">mtn automate descendents</a></span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one child of the given
revision.  Each line consists of a revision ID, in hexadecimal,
followed by a newline.  The lines are printed in alphabetically sorted
order.

          <br><dt><strong>Error conditions:</strong><dd>
If the given revision <var>rev</var> does not exist, prints nothing to
stdout, prints an error message to stderr, and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate common_ancestors </span><var>rev...</var></samp><a name="index-mtn-automate-common_005fancestors-_0040var_007brev_002e_002e_002e_007d-199"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One or more revision IDs.

          <br><dt><strong>Added in:</strong><dd>
2.1

          <br><dt><strong>Purpose:</strong><dd>
Prints all revisions which are ancestors of all of the revisions given as
arguments.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one common ancestor of all the given
revisions.  Each line consists of a revision ID, in hexadecimal,
followed by a newline.  The lines are printed in alphabetically sorted
order.

          <p>The output will include one of the argument revisions only if that revision is
an ancestor of all other revisions given as arguments.

          <br><dt><strong>Error conditions:</strong><dd>
If any of the revisions do not exist, prints nothing to stdout, prints
an error message to stderr, and exits with status 1.

     </dl>

     <p><a name="mtn-automate-content_005fdiff"></a><br><dt><samp><span class="command">mtn automate content_diff [--revision=</span><var>id1</var><span class="command"> [--revision=</span><var>id2</var><span class="command">]] [--reverse] [</span><var>file...</var><span class="command">]</span></samp><a name="index-mtn-automate-content_005fdiff-_005b_002d_002drevision_003d_0040var_007bid1_007d-_005b_002d_002drevision_003d_0040var_007bid2_007d_005d_005d-_005b_002d_002dreverse_005d-_005b_0040var_007bfile_002e_002e_002e_007d_005d-200"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>See the online help for more options.

          <p>One or more <var>file</var> arguments restrict the diff output to these files,
otherwise all changed files in the given revision(s) and/or current workspace
are considered.

          <p>If zero or more revisions are given, the command behaves as follows:

               <ul>
<li>no revision: the diff is done from the parent (base) revision of this
workspace to the workspace revision. 
<li>one revision: the diff is done from the given revision <samp><span class="option">id1</span></samp> to
the workspace revision. If <samp><span class="option">--reverse</span></samp> is given, the order is
reversed. 
<li>two revisions: the diff is done from <samp><span class="option">id1</span></samp> to <samp><span class="option">id2</span></samp>; no
workspace is needed in this case. 
</ul>

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>9.0 &ndash; added <samp><span class="option">--with-header</span></samp> option
<li>4.0 &ndash; initial
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Prints the content changes between two revisions or a revision and the
current workspace. This command differs from <samp><span class="command">mtn diff</span></samp> in
that it only outputs content changes and keeps quiet on renames or
drops by default, as the header of <samp><span class="command">mtn diff</span></samp> is omitted
unless <samp><span class="option">--with-header</span></samp> is given and is omitted regardless if
there are no changes.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          ============================================================
          --- guitone/res/i18n/guitone_de.ts      9857927823e1d6a0339b531c120dcaadd22d25e9
          +++ guitone/res/i18n/guitone_de.ts      0b4715dc296b1955b0707923d45d79ca7769dd3f
          @@ -1,6 +1,14 @@
           &lt;?xml version="1.0" encoding="utf-8"?>
           &lt;!DOCTYPE TS>&lt;TS version="1.1">
           &lt;context>
          +    &lt;name>AncestryGraph&lt;/name>
          +    &lt;message>
          [...]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The GNU unified diff format. If there have been no content changes, the output
is empty.

          <br><dt><strong>Error conditions:</strong><dd>
If more than two revisions are given or a workspace is required, but
not found, prints to stderr and exits with status 1. If one or more file
restrictions can't be applied, the command prints to stderr and exits as well.

     </dl>

     <p><a name="mtn-automate-descendents"></a><br><dt><samp><span class="command">mtn automate descendents </span><var>rev...</var></samp><a name="index-mtn-automate-descendents-_0040var_007brev_002e_002e_002e_007d-201"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One or more revision IDs.

          <br><dt><strong>Added in:</strong><dd>
0.1

          <br><dt><strong>Purpose:</strong><dd>
Prints the descendants of one or more revisions.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one descendant of the given
revisions.  Each line consists of a revision ID, in hexadecimal,
followed by a newline.  The lines are printed in alphabetically sorted
order.

          <p>The output does not include <var>rev...</var>, unless one of them is a
descendent of another.

          <br><dt><strong>Error conditions:</strong><dd>
If any of the revisions do not exist, prints nothing to stdout, prints
an error message to stderr, and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate drop_attribute </span><var>path</var><span class="command"> [</span><var>key</var><span class="command">]</span></samp><a name="index-mtn-automate-drop_005fattribute-_0040var_007bpath_007d-_005b_0040var_007bkey_007d_005d-202"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A path and an attribute key (optional).

          <br><dt><strong>Added in:</strong><dd>
5.0

          <br><dt><strong>Purpose:</strong><dd>
Automate variant of <samp><span class="command"><a href="mtn-attr-drop.html#mtn-attr-drop">mtn attr drop</a></span></samp>.

          <p>Removes an attribute from the current workspace revision for the specified path. 
If no attribute key is given, all attributes of this path are removed. Note that
this change is not committed.

          <br><dt><strong>Output format:</strong><dd>
This command does not print out anything if successful.

          <br><dt><strong>Error conditions:</strong><dd>
If the path specified is unknown in the new workspace revision or the attribute
key is not found for this path, prints an error message to stderr and exits with
status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate drop_db_variables </span><var>domain</var><span class="command"> [</span><var>name</var><span class="command">]</span></samp><a name="index-mtn-automate-drop_005fdb_005fvariables-_0040var_007bdomain_007d-_005b_0040var_007bname_007d_005d-203"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>domain</var> and <var>name</var> specify the database variable
which should be dropped. If <var>name</var> is ommitted, all database
variables in the <var>domain</var> are dropped.

          <br><dt><strong>Added in:</strong><dd>
7.0

          <br><dt><strong>Purpose:</strong><dd>
Drops one or more database variables; see <a href="Vars.html#Vars">Vars</a>.

          <br><dt><strong>Sample usage:</strong><dd>
<pre class="verbatim">          mtn automate drop_db_variables known-servers
     </pre>

          <br><dt><strong>Output format:</strong><dd>
No output.

          <br><dt><strong>Error conditions:</strong><dd>
If the specific variable or any variables in the given domain are not found,
prints to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate drop_public_key </span><var>keyid</var></samp><a name="index-mtn-automate-drop_005fpublic_005fkey-_0040var_007bkeyid_007d-204"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
<var>keyid</var> identifies the key to drop, by name or hash.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>13.0 &ndash; initial

          </ul>

          <br><dt><strong>Purpose:</strong><dd>
Drop a public key from the database (<em>not</em> the private key from
the keystore). Signatures made with the key can no longer be verified.

          <p>This command should be used with caution as changes are irreversible
without a backup of the key(s) that were dropped. You may wish to use
the <samp><span class="command">k:</span></samp> selector to check if the key is used in a signature.

          <p>Note that public keys that are used to sign a revision may be
restored to the database by a future sync.

          <p>Keys in the keystore are not dropped because that is very dangerous on
a server. The only way to drop private keys on a server is via the
command <samp><span class="command"><a href="mtn-dropkey.html#mtn-dropkey">mtn dropkey</a></span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
None.

          <br><dt><strong>Output format:</strong><dd>
None on the main stream; progress message on the progress stream.

          <br><dt><strong>Error conditions:</strong><dd>
If the key does not exist, an error message is printed on the error stream.

     </dl>

     <br><dt><samp><span class="command">mtn automate erase_ancestors [</span><var>rev...</var><span class="command">]</span></samp><a name="index-mtn-automate-erase_005fancestors-_005b_0040var_007brev_002e_002e_002e_007d_005d-205"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One or more revision IDs.

          <br><dt><strong>Added in:</strong><dd>
0.1

          <br><dt><strong>Purpose:</strong><dd>
Prints all arguments, except those that are an ancestor of some other
argument.

          <p>One way to think about this is that it prints the minimal elements of
the given set, under the ordering imposed by the &ldquo;child of&rdquo;
relation.  Another way to think of it is if the arguments formed a
branch, then we would print the heads of that branch.  If there are no
arguments, prints nothing.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one of the given revisions. 
Each line consists of a revision ID, in hexadecimal, followed by a
newline.  The lines are printed in alphabetically sorted order.

          <br><dt><strong>Error conditions:</strong><dd>
If any of the revisions do not exist, prints nothing to stdout, prints
an error message to stderr, and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate file_merge </span><var>left-rid</var> <var>left-path</var> <var>right-rid</var> <var>right-path</var></samp><a name="index-mtn-automate-file_005fmerge-_0040var_007bleft_002drid_007d-_0040var_007bleft_002dpath_007d-_0040var_007bright_002drid_007d-_0040var_007bright_002dpath_007d-206"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
<var>left-rid</var>, <var>left-fid</var>, <var>right-rid</var>, <var>right-fid</var>
specify two files to merge, by revision and file path.

          <br><dt><strong>Added in:</strong><dd>
9.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the result of the internal line merge on the contents of the
specified files.

          <p>This command does not just take two file ids, because the revision ids
and paths are needed to check for manual merge and file encoding
attributes.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          If you've downloaded a release, see INSTALL for installation
          instructions.  If you've checked this out, the generated files are not
          included, and you must use "autoreconf --install" to create them.
          
          "make html" for docs, or read the .info file and / or man page.
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The file merge results are output without modification.

          <br><dt><strong>Error conditions:</strong><dd>
If either revision id is unknown or invalid, or if either path does
not exist, or if the internal line merger fails, prints an error
message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate generate_key </span><var>name</var> <var>passphrase</var></samp><a name="index-mtn-automate-generate_005fkey-_0040var_007bname_007d-_0040var_007bpassphrase_007d-207"></a><dd>
          <dl>
<dt><strong>Aguments</strong><dd>
<var>name</var> is the name to associate with the new key, and <var>passphrase</var> is
the passphrase that will be used to encrypt the private half.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>13.0 &ndash; renamed from <samp><span class="command">genkey</span></samp> to <samp><span class="command">generate_key</span></samp>
<li>10.0 &ndash; The separate hashes for the private half of a key really didn't
make much sense; have one <code>hash [...]</code> line instead of separate
<code>public_hash [...]</code> and <code>private_hash [...]</code> lines. 
<li>3.1 &ndash; initial
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Generate a key with the given name and passphrase.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">                      name "tbrownaw@gmail.com"
                      hash [475055ec71ad48f5dfaf875b0fea597b5cbbee64]
           public_location "database" "keystore"
          private_location "keystore"
          
     </pre>

          <br><dt><strong>Output format:</strong><dd>
A basic_io stanza. The public_location and private_location items may have
multiple values as shown above for public_location, one value for each place
that the key is stored.

          <br><dt><strong>Error conditions:</strong><dd>
Error conditions: If the passphrase is empty or the key already exists,
prints an error message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_attributes </span><var>path</var></samp><a name="index-mtn-automate-get_005fattributes-_0040var_007bpath_007d-208"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The argument <var>path</var> determines which path's attributes should be printed.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>11.0 &ndash; removed the <samp><span class="command">format_version</span></samp> stanza
<li>5.0 &ndash; renamed from <samp><span class="command">attributes</span></samp> to <samp><span class="command">get_attributes</span></samp>
<li>3.0 &ndash; initial
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Prints all attributes of the given file in the current workspace, and
the attribute states.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">           attr "foo" "bar"
          state "added"
          
           attr "baz" "bat"
          state "dropped"
          
           attr "foobar" "foobat"
          state "unchanged"
     </pre>

          <br><dt><strong>Output format:</strong><dd>
There is one basic_io stanza for each attribute of the given file.

          <p>All stanzas are formatted by basic_io. Stanzas are separated
by a blank line and ordered by attribute name. Values will be
escaped, '\' to '\\' and '"' to '\"'.

          <p>Each attribute stanza also contains another entry which tells the status
of attribute. This entry can have one of the following four values:

               <ul>
<li>'added': the attribute has just been added to the file
<li>'dropped': the attribute has just been dropped from the file
<li>'unchanged': the attribute has not been changed since the last revision
<li>'changed': the attribute has been changed since the last revision
</ul>

          <p>The status 'changed' can come up if an attribute foo has been dropped and
added afterwards with another value, like

          <pre class="verbatim">          $ mtn attr drop file.txt foo ; mtn attr set file.txt foo baz
     </pre>

          <p>If an attribute has been dropped, the output will still return the previously
set value of the dropped attribute for convenience (obviously this is no longer
recorded in the current workspace).

          <p>The complete format:

          <pre class="verbatim">          'attr':
                represents an attribute.
                format: ('attr', key, value), ('state', [unchanged|changed|added|dropped])
                occurs: zero or more times
     </pre>

          <br><dt><strong>Error conditions:</strong><dd>
If the path specified is unknown in the workspace, prints an error
message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_base_revision_id</span></samp><a name="index-mtn-automate-get_005fbase_005frevision_005fid-209"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
2.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the base revision id of the current workspace. This is the
&ldquo;old_revision&rdquo; value stored in <samp><span class="file">_MTN/revision</span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
     </pre>

          <br><dt><strong>Output format:</strong><dd>
One line containing the base revision ID of the current workspace.

          <br><dt><strong>Error conditions:</strong><dd>
If no workspace is found, prints an error message to stderr, and exits
with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_content_changed </span><var>rev</var> <var>file</var></samp><a name="index-mtn-automate-get_005fcontent_005fchanged-_0040var_007brev_007d-_0040var_007bfile_007d-210"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>rev</var> specifies a revision ID, from which content change calculations will be based. 
and <var>file</var> specifies the file for which to calculate revisions in which it was last changed.

          <br><dt><strong>Added in:</strong><dd>
4.0

          <br><dt><strong>Purpose:</strong><dd>
Returns a list of revision IDs in which the content was most recently changed,
relative to the revision ID specified as <var>rev</var>. This equates to a content mark
following the *-merge algorithm.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">            content_mark [276264b0b3f1e70fc1835a700e6e61bdbe4c3f2f]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more basic_io stanzas, each specifying a revision ID in which a content
mark is set:

               <ul>
<li>No content mark is returned if <var>file</var> is a directory. 
<li>One content mark is returned if <var>file</var> is a file and has recently been
changed exclusively in one revision (be it by a commit or merge). 
<li>Multiple content marks are returned if <var>file</var> is a file and has recently
been part of a clean merge case. 
A clean merge happens when the same change to <var>file</var> is made on both sides
of the particular merge, together with other unrelated changes, which make the
resulting revisions not collapse into one revision. 
</ul>

          <br><dt><strong>Error conditions:</strong><dd>
If <var>rev</var> or <var>file</var> is unknown or invalid prints an error
message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_corresponding_path </span><var>source_id</var> <var>file</var> <var>target_id</var></samp><a name="index-mtn-automate-get_005fcorresponding_005fpath-_0040var_007bsource_005fid_007d-_0040var_007bfile_007d-_0040var_007btarget_005fid_007d-211"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>source_id</var> specifies a revision ID in which <var>file</var> is extant. 
and <var>file</var> specifies the file whose name in <var>target_id</var> is to be determined;
<var>target_id</var> specifies a revision ID.

          <br><dt><strong>Added in:</strong><dd>
4.0

          <br><dt><strong>Purpose:</strong><dd>
Given a the file name <var>file</var> in the source revision <var>source_id</var>, a filename
will if possible be returned naming the file in the target revision <var>target_id</var>. 
This allows the same file to be matched between revisions, accounting
for renames and other changes.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          file "foo"
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or one basic_io lines. Zero lines will be output if the file
does not exist within the target revision; this is not considered an
error. If the file does exist in the target revision, a single line
is output.

          <br><dt><strong>Error conditions:</strong><dd>
If the revision IDs <var>source_id</var> or <var>target_id</var> are unknown or invalid prints an error
message to stderr and exits with status 1. If the file path <var>file</var> does not exist in the
revision <var>source_id</var> or is invalid, prints an error message to stderr and exits with status
1. Note that <var>file</var> not existing in the revision <var>target_id</var> is not an error.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_current_revision [--exclude </span><var>excl</var><span class="command">] [--depth=</span><var>depth</var><span class="command">] [</span><var>path...</var><span class="command">]</span></samp><a name="index-mtn-automate-get_005fcurrent_005frevision-_005b_002d_002dexclude-_0040var_007bexcl_007d_005d-_005b_002d_002ddepth_003d_0040var_007bdepth_007d_005d-_005b_0040var_007bpath_002e_002e_002e_007d_005d-212"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One or more <var>path</var> arguments restrict the revision to these paths,
otherwise all changes in workspace are taken into account.

          <p>See online help for more options.

          <br><dt><strong>Added in:</strong><dd>
7.0

          <br><dt><strong>Purpose:</strong><dd>
Prints change information for the current workspace, optionally restricted by
one or more paths.

          <br><dt><strong>Sample output:</strong><dd>
See <samp><span class="command"><a href="mtn-automate-get_005frevision.html#mtn-automate-get_005frevision">mtn automate get_revision</a></span></samp>

          <br><dt><strong>Output format:</strong><dd>
See <samp><span class="command"><a href="mtn-automate-get_005frevision.html#mtn-automate-get_005frevision">mtn automate get_revision</a></span></samp>

          <br><dt><strong>Error conditions:</strong><dd>
If the command is executed outside of a workspace, or the restriction is
invalid, prints an error message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_current_revision_id</span></samp><a name="index-mtn-automate-get_005fcurrent_005frevision_005fid-213"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
2.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the revision id of the current workspace. This is the id
of the revision that would be committed by an unrestricted commit
in the workspace.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
     </pre>

          <br><dt><strong>Output format:</strong><dd>
One line containing the current revision id ID of the current workspace.

          <br><dt><strong>Error conditions:</strong><dd>
If no workspace is found, prints an error message to stderr, and exits
with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_db_variables [</span><var>domain</var><span class="command">]</span></samp><a name="index-mtn-automate-get_005fdb_005fvariables-_005b_0040var_007bdomain_007d_005d-214"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The optional <var>domain</var> restricts the output to variables only within
this domain.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>7.0 &ndash; converted output to basic_io, renamed to 'get_db_variables'
<li>4.1 &ndash; added as 'db_get'
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Outputs database variable domains, names and values. For more
information about variables, see <a href="Vars.html#Vars">Vars</a>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          domain "database"
           entry "default-exclude-pattern" ""
           entry "default-include-pattern" "net.venge.monotone*"
           entry "default-server" "mtn://code.monotone.ca/monotone"
          
          domain "known-servers"
           entry "mtn://code.monotone.ca/monotone" "2c88403f0ed546df96ccec57ab3072aa73a05e71"
     </pre>

          <br><dt><strong>Output format:</strong><dd>
basic_io-formatted stanzas. Each stanza starts with a 'domain', followed by one
or more 'entry' lines. Each 'entry' contains the <var>name</var> and the <var>value</var>
of the respective database variable.

          <br><dt><strong>Error conditions:</strong><dd>
If the domain is unknown or no variables where found, prints an error message
to stderr and exits with status 1.

     </dl>

     <p><a name="mtn-automate-get_005fextended_005fmanifest_005fof"></a><br><dt><samp><span class="command">mtn automate get_extended_manifest_of </span><var>revid</var></samp><a name="index-mtn-automate-get_005fextended_005fmanifest_005fof-_0040var_007brevid_007d-215"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>revid</var> specifies the revision for which the extended manifest
should be printed.

          <br><dt><strong>Changes:</strong><dd>
13.0 &ndash; initial

          <br><dt><strong>Purpose:</strong><dd>
Prints the contents of the extended manifest associated with the given revision.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">                dir ""
              birth [0cd607d6dda3a2df18f777112947f3c70811581e]
          path_mark [0cd607d6dda3a2df18f777112947f3c70811581e]
          
                   dir "dir"
          dormant_attr "dirprop"
                 birth [0cd607d6dda3a2df18f777112947f3c70811581e]
             path_mark [0cd607d6dda3a2df18f777112947f3c70811581e]
             attr_mark "dirprop" [a7a71d7cc0d526165e7362b8a87393d8609f40c2]
          
                  file "file"
               content [d3395867d05cc4c27f013d6e6f48d644e96d8241]
                  size "8"
                  attr "fileprop" "value"
                 birth [0cd607d6dda3a2df18f777112947f3c70811581e]
             path_mark [0cd607d6dda3a2df18f777112947f3c70811581e]
          content_mark [a7a71d7cc0d526165e7362b8a87393d8609f40c2]
             attr_mark "fileprop" [a7a71d7cc0d526165e7362b8a87393d8609f40c2]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
There is one basic_io stanza for each file or directory in the
extended manifest.

          <p>The 'dir' and 'file' lines are the first in every stanza and
specify its type as follows:

          <pre class="verbatim">          'dir':
                Represents a directory.  The path "" (the empty string) is used
                to represent the root of the tree.
                format: ('dir', pathname)
                occurs: one or more times
          'file':
                Represents a file.
                format: ('file', pathname)
                occurs: zero or more times
     </pre>

          <p>In addition, both 'dir' and 'file' stanzas include more information
on the particular node:

          <pre class="verbatim">          'birth':
                The revision id in which the node was added ("born").
                format: ('birth', revision id)
                occurs: once per node
          'path_mark':
                The revision id in which the node was last renamed.
                format: ('path_mark', revision id)
                occurs: once per node
          'content':
                The id of the file node, i.e. the hash of its contents.
                format: ('content', file id)
                occurs: once per file node
          'content_mark':
                The revision id in which the node's content was changed at last.
                format: ('content_mark', revision id)
                occurs: once per file node
          'size':
                The recorded file size, in bytes.
                format: ('size', size in bytes)
                occurs: once per file node
     </pre>

          <p>Finally, attributes are also part of the format:

          <pre class="verbatim">          'attr':
                The name and the value of a specific attribute.
                format: ('attr', attribute name, attribute value)
                occurs: zero or more times per node
          'dormant_attr':
                The name of a previously deleted attribute.
                format: ('dormant_attr', attribute name)
                occurs: zero or more times per node
          'attr_mark':
                The revision id in which a particular attribute's value was
                changed at last.
                format: ('attr_mark', attribute name, revision id)
                occurs: zero or more times per node
     </pre>

          <p>All stanzas are sorted by the path string.

          <br><dt><strong>Error conditions:</strong><dd>
If the revision ID specified is unknown or invalid prints an error
message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_file </span><var>id</var></samp><a name="index-mtn-automate-get_005ffile-_0040var_007bid_007d-216"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>id</var> argument specifies the file hash of the file to be output.

          <br><dt><strong>Added in:</strong><dd>
1.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the contents of the specified file.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          If you've downloaded a release, see INSTALL for installation
          instructions.  If you've checked this out, the generated files are not
          included, and you must use "autoreconf --install" to create them.
          
          "make html" for docs, or read the .info file and / or man page.
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The file contents are output without modification.

          <br><dt><strong>Error conditions:</strong><dd>
If the file id specified is unknown or invalid prints an error message
to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_file_of </span><var>filename</var><span class="command"> [--revision=</span><var>id</var><span class="command">]</span></samp><a name="index-mtn-automate-get_005ffile_005fof-_0040var_007bfilename_007d-_005b_002d_002drevision_003d_0040var_007bid_007d_005d-217"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>filename</var> argument specifies the filename of the file to be output.

          <p>If a revision <var>id</var> is given, the file's contents in that specific revision
are printed. If no revision is given, the workspace base revision is used.

          <br><dt><strong>Added in:</strong><dd>
4.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the contents of the specified file.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          If you've downloaded a release, see INSTALL for installation
          instructions.  If you've checked this out, the generated files are not
          included, and you must use "autoreconf --install" to create them.
          
          "make html" for docs, or read the .info file and / or man page.
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The file contents are output without modification.

          <br><dt><strong>Error conditions:</strong><dd>
If the filename specified is unknown in the given revision or invalid, or
if the given revision is unknown, prints an error message to stderr and exits
with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_file_size </span><var>id</var></samp><a name="index-mtn-automate-get_005ffile_005fsize-_0040var_007bid_007d-218"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>id</var> argument specifies the file hash of the file for which
the size should be printed.

          <br><dt><strong>Changes:</strong><dd>
13.0 &ndash; initial

          <br><dt><strong>Purpose:</strong><dd>
Prints the recorded file size of the specified file.

          <p>If you need to know the file sizes of multiple files of the same revision,
its usually faster to use the <samp><span class="command"><a href="mtn-automate-get_005fextended_005fmanifest_005fof.html#mtn-automate-get_005fextended_005fmanifest_005fof">mtn automate get_extended_manifest_of</a></span></samp>
command.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          1241
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The size of the file in bytes followed by a linefeed character ('\n').

          <br><dt><strong>Error conditions:</strong><dd>
If the file id specified is unknown or invalid prints an error message
to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_manifest_of [</span><var>revid</var><span class="command">]</span></samp><a name="index-mtn-automate-get_005fmanifest_005fof-_005b_0040var_007brevid_007d_005d-219"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
Specifying the optional <var>revid</var> argument outputs the manifest for the
revision with the specified ID. Otherwise, outputs the manifest for the
current workspace.

          <br><dt><strong>Added in:</strong><dd>
2.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the contents of the manifest associated with the given revision.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          format_version "1"
          
          dir ""
          
             file ".htaccess"
          content [e3915658cb464d05f21332e03d30dca5d94fe776]
          
             file "AUTHORS"
          content [80d8f3f75c9b517ec462233e155f7dfb93379f67]
          
             file "ChangeLog"
          content [fc74a48c7f73eedcbe1ea709755fbe819b29736c]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
There is one basic_io stanza for each file or directory in the
manifest.

          <pre class="verbatim">          'format_version'
                used in case this format ever needs to change.
                format: ('format_version', the string "1")
                occurs: exactly once
          'dir':
                represents a directory.  The path "" (the empty string) is used
                to represent the root of the tree.
                format: ('dir', pathname)
                occurs: one or more times
          'file':
                represents a file.
                format: ('file', pathname), ('content', file id)
                occurs: zero or more times
     </pre>

          <p>In addition, 'dir' and 'file' stanzas may have attr information
included.  These are appended to the stanza below the basic dir/file
information, with one line describing each attr.  These lines take the
form ('attr', attr name, attr value).

          <p>Stanzas are sorted by the path string.

          <br><dt><strong>Error conditions:</strong><dd>
If the revision ID specified is unknown or invalid prints an error
message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_option </span><var>option</var></samp><a name="index-mtn-automate-get_005foption-_0040var_007boption_007d-220"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>option</var> argument specifies the option name of the option to be output.

          <br><dt><strong>Added in:</strong><dd>
3.1

          <br><dt><strong>Purpose:</strong><dd>
Prints an option from <samp><span class="file">_MTN/option</span></samp> of the current workspace.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          net.venge.monotone
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The option value is written out without modification.

          <br><dt><strong>Error conditions:</strong><dd>
If the option is unknown, prints an error message to stderr and exits
with status 1.

     </dl>

     <p><a name="mtn-automate-get_005fpublic_005fkey"></a><br><dt><samp><span class="command">mtn automate get_public_key </span><var>keyid</var></samp><a name="index-mtn-automate-get_005fpublic_005fkey-_0040var_007bkeyid_007d-221"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
<var>keyid</var> identifies the key to display, by name or hash.

          <br><dt><strong>Added in:</strong><dd>13.0

          <br><dt><strong>Purpose:</strong><dd>
Same as <samp><span class="command"><a href="mtn-pubkey.html#mtn-pubkey">mtn pubkey</a></span></samp>; print the key in packet format,
suitable for reading by <samp><span class="command"><a href="mtn-automate-put_005fpublic_005fkey.html#mtn-automate-put_005fpublic_005fkey">mtn automate put_public_key</a></span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          [pubkey foo@bar.com]
          MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDQs4OEcqULwepphO5Rsb/aSLpiEryGtEkQRNQPNFxvcu1rwVnNKRxep1KCDrwV3se9f4hUQ8zz73NQggS82guSI/YuyXZDZHrw+v3YgAMV/mKGnAjgYnyRNUL1xCywV7fnqTduBBqkDEVSCqphWlii/gFB/PVo4sbJ4Hk7O6ujWwIDAQAB
          [end]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
See example.

          <br><dt><strong>Error conditions:</strong><dd>
If the key does not exist, an error message is printed on the error stream.

     </dl>

     <p><a name="mtn-automate-get_005frevision"></a><br><dt><samp><span class="command">mtn automate get_revision </span><var>id</var></samp><a name="index-mtn-automate-get_005frevision-_0040var_007bid_007d-222"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The argument <var>id</var> specifies the revision id for which the changeset
information should be printed.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>7.0 &ndash; <var>id</var> is now mandatory
<li>1.0 &ndash; initial
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Prints change information for the specified revision id.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          format_version "1"
          
          new_manifest [bfe2df785c07bebeb369e537116ab9bb7a4b5e19]
          
          old_revision [429fea55e9e819a046843f618d90674486695745]
          
          patch "ChangeLog"
           from [7dc21d3a46c6ecd94685ab21e67b131b32002f12]
             to [234513e3838d423b24d5d6c98f70ce995c8bab6e]
          
          patch "std_hooks.lua"
           from [0408707bb6b97eae7f8da61af7b35364dbd5a189]
             to [d7bd0756c48ace573926197709e53eb24dae5f5f]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
There are several changes that are described; each of these is described by
a different basic_io stanza. The first string pair of each stanza indicates the
type of change represented.

          <pre class="verbatim">          'format_version'
                used in case this format ever needs to change.
                format: ('format_version', the string "1")
                occurs: exactly once
          'new_manifest'
                represents the new manifest associated with the revision.
                format: ('new_manifest', manifest id)
                occurs: exactly one
          'old_revision'
                represents a parent revision.
                format: ('old_revision', revision id)
                occurs: either one or two times
          'delete
                represents a file or directory that was deleted.
                format: ('delete', path)
                occurs: zero or more times
          'rename'
                represents a file or directory that was renamed.
                format: ('rename, old filename), ('to', new filename)
                occurs: zero or more times
          'add_dir'
                represents a directory that was added.
                format: ('add_dir, path)
                occurs: zero or more times
          'add_file'
                represents a file that was added.
                format: ('add_file', path), ('content', file id)
                occurs: zero or more times
          'patch'
                represents a file that was modified.
                format: ('patch', filename), ('from', file id), ('to', file id)
                occurs: zero or more times
          'clear'
                represents an attr that was removed.
                format: ('clear', filename), ('attr', attr name)
                occurs: zero or more times
          'set'
                represents an attr whose value was changed.
                format: ('set', filename), ('attr', attr name), ('value', attr value)
                occurs: zero or more times
     </pre>

          <p>These stanzas will always occur in the order listed here; stanzas of
the same type will be sorted by the filename they refer to. The 'delete'
and following stanzas will be grouped under the corresponding 'old_revision'
one.

          <br><dt><strong>Error conditions:</strong><dd>
If the revision specified is unknown or invalid prints an error message
to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate get_workspace_root</span></samp><a name="index-mtn-automate-get_005fworkspace_005froot-223"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
8.0

          <br><dt><strong>Purpose:</strong><dd>
Print the path of the workspace root for the current directory.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          /home/jim/juice
     </pre>

          <br><dt><strong>Output format:</strong><dd>
A path.

          <br><dt><strong>Error conditions:</strong><dd>
If the current directory isn't part of a workspace, prints an error to
stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate graph</span></samp><a name="index-mtn-automate-graph-224"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
0.2

          <br><dt><strong>Purpose:</strong><dd>
Prints out the complete ancestry graph of this database.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          0c05e8ec9c6af4224672c7cc4c9ef05ae8bdb794
          27ebcae50e1814e35274cb89b5031a423c29f95a 5830984dec5c41d994bcadfeab4bf1bf67747b89
          4e284617c80bec7da03925062a84f715c1b042bd 27ebcae50e1814e35274cb89b5031a423c29f95a 657c756d24fb65213d59f4ae07e117d830dcc95b
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving ancestry information for one revision. 
Each line begins with a revision ID.  Following this are zero or more
space-prefixed revision IDs.  Each revision ID after the first is a
parent (in the sense of <samp><span class="command"><a href="mtn-automate-parents.html#mtn-automate-parents">mtn automate parents</a></span></samp>) of the first.  For
instance, in the above sample output,
0c05e8ec9c6af4224672c7cc4c9ef05ae8bdb794 is a root node,
27ebcae50e1814e35274cb89b5031a423c29f95a has one parent, and
4e284617c80bec7da03925062a84f715c1b042bd has two parents, i.e., is a
merge node.

          <p>The output as a whole is alphabetically sorted by line; additionally,
the parents within each line are alphabetically sorted.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <p><a name="mtn-automate-heads"></a><br><dt><samp><span class="command">mtn automate heads [</span><var>branch</var><span class="command">]</span></samp><a name="index-mtn-automate-heads-_005b_0040var_007bbranch_007d_005d-225"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One branch name. If none is given, the workspace branch is used.

          <br><dt><strong>Added in:</strong><dd>
0.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the heads of branch <var>branch</var>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one head of the given branch. 
Each line consists of a revision ID, in hexadecimal, followed by a
newline.  The lines are printed in alphabetically sorted order.

          <br><dt><strong>Error conditions:</strong><dd>
If the given branch does not exist, an error message is printed.

     </dl>

     <br><dt><samp><span class="command">mtn automate identify </span><var>path</var></samp><a name="index-mtn-automate-identify-_0040var_007bpath_007d-226"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A file path.

          <br><dt><strong>Added in:</strong><dd>
4.3

          <br><dt><strong>Purpose:</strong><dd>
Prints the file ID (aka hash) of the given file.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          6265ab1312fbe38bdc3aafa92441139cb2b779b0
     </pre>

          <br><dt><strong>Output format:</strong><dd>
A single line with the file's ID, in hexadecimal, followed by a newline.

          <br><dt><strong>Error conditions:</strong><dd>
If the file does not exist, is a special file or not readable, prints an
error message to stderr and exits with status 1. A single file path only
consisting of "-" is disallowed since it collides with the UNIX stdin
marker.

     </dl>

     <br><dt><samp><span class="command">mtn automate interface_version</span></samp><a name="index-mtn-automate-interface_005fversion-227"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
0.0

          <br><dt><strong>Purpose:</strong><dd>
Prints version of the automation interface.  Major number increments
whenever a backwards incompatible change is made to any automate
command; minor number increments whenever any change is made (but is
reset when major number increments).

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          1.2
     </pre>

          <br><dt><strong>Output format:</strong><dd>
A decimal number, followed by &ldquo;.&rdquo; (full stop/period), followed by a
decimal number, followed by a newline.  The first decimal number is
the major version, the second is the minor version.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <br><dt><samp><span class="command">mtn automate inventory [</span><samp><span class="option">options...</span></samp><span class="command">] [</span><var>files...</var><span class="command">]</span></samp><a name="index-mtn-automate-inventory-_005b_0040option_007boptions_002e_002e_002e_007d_005d-_005b_0040var_007bfiles_002e_002e_002e_007d_005d-228"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One or more file paths (optional). If present, only show an inventory for the
given files or directories (and their sub-directories); otherwise,
show an inventory for the current workspace.

               <dl>
<dt><samp><span class="option">--depth=</span><var>n</var></samp><dd>Maximum number of directories to descend.

               <br><dt><samp><span class="option">--exclude=</span><var>exclude-glob</var></samp><dd>File or directory to exclude.

               <br><dt><samp><span class="option">--[no-]corresponding-renames</span></samp><dd>If restricted to a renamed path, do not output the corresponding old / new
paths for this restriction.

               <br><dt><samp><span class="option">--[no-]ignored</span></samp><dd>Don't output ignored files or directories.

               <br><dt><samp><span class="option">--[no-]unchanged</span></samp><dd>Don't output files that are known but not changed in any way.

               <br><dt><samp><span class="option">--[no-]unknown</span></samp><dd>Don't output unknown directories.

          </dl>

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>8.0 &ndash; added the output of the <code>birth</code> key
<li>7.0 &ndash; added options <samp><span class="option">--no-ignored</span></samp>, <samp><span class="option">--no-unknown</span></samp>,
<samp><span class="option">--no-unchanged</span></samp> and <samp><span class="option">--no-corresponding-renames</span></samp>
<li>6.0 &ndash; converted to basic_io format (restriction support, various fixes)
<li>1.0 &ndash; initial, line-based format
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Prints information on every file found in the workspace or its
associated base and revision manifests.

          <br><dt><strong>Sample output:</strong><dd>
All basic status cases:
<pre class="verbatim">              path "added"
          new_type "file"
           fs_type "file"
            status "added" "known"
           changes "content"
          
              path "attributes_altered"
          old_type "file"
          new_type "file"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "known"
           changes "attrs"
          
              path "dropped"
          old_type "file"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "dropped"
          
             path "ignored~"
          fs_type "file"
           status "ignored"
          
              path "missing"
          old_type "file"
          new_type "file"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "missing"
          
              path "original"
          old_type "file"
          new_path "renamed"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source"
          
              path "patched"
          old_type "file"
          new_type "file"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "known"
           changes "content"
          
              path "patched_and_attributes_altered"
          old_type "file"
          new_type "file"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "known"
           changes "content" "attrs"
          
              path "renamed"
          new_type "file"
          old_path "original"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "known"
          
              path "unchanged"
          old_type "file"
          new_type "file"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "known"
          
             path "unknown"
          fs_type "file"
           status "unknown"
     </pre>

          <p>Two files swapped in both the revision manifest and the workspace:
<pre class="verbatim">              path "original"
          old_type "file"
          new_path "unchanged"
          new_type "file"
          old_path "unchanged"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
          
              path "unchanged"
          old_type "file"
          new_path "original"
          new_type "file"
          old_path "original"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
     </pre>

          <p>Recorded in the revision manifest that two files were swapped, but
they were not actually swapped in the workspace. Thus they both appear
as patched:
<pre class="verbatim">              path "original"
          old_type "file"
          new_path "unchanged"
          new_type "file"
          old_path "unchanged"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
           changes "content"
          
              path "unchanged"
          old_type "file"
          new_path "original"
          new_type "file"
          old_path "original"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
           changes "content"
          
     </pre>

          <p>Rename (in the manifest and the workspace) <samp><span class="file">foo</span></samp> to <samp><span class="file">bar</span></samp>;
add (in the manifest and the workspace) new file <samp><span class="file">foo</span></samp>:
<pre class="verbatim">              path "foo"
          old_type "file"
          new_path "bar"
          new_type "file"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "added" "known"
          
              path "bar"
          new_type "file"
          old_path "foo"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "known"
     </pre>

          <p>Rotated files <samp><span class="file">foo</span></samp> -&gt; <samp><span class="file">bar</span></samp> -&gt; <samp><span class="file">baz</span></samp> -&gt; <samp><span class="file">foo</span></samp> (in
the manifest and the workspace):
<pre class="verbatim">              path "foo"
          old_type "file"
          new_path "bar"
          new_type "file"
          old_path "baz"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
          
              path "bar"
          old_type "file"
          new_path "baz"
          new_type "file"
          old_path "foo"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
          
              path "baz"
          old_type "file"
          new_path "foo"
          new_type "file"
          old_path "bar"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
     </pre>

          <p>Recorded in the revison manifest the rotation of files <samp><span class="file">foo</span></samp> -&gt;
<samp><span class="file">bar</span></samp> -&gt; <samp><span class="file">baz</span></samp> -&gt; <samp><span class="file">foo</span></samp>, but the actual files in the
workspace were not moved, so monotone interprets all files as having
been patched:
<pre class="verbatim">              path "foo"
          old_type "file"
          new_path "bar"
          new_type "file"
          old_path "baz"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
           changes "content"
          
              path "bar"
          old_type "file"
          new_path "baz"
          new_type "file"
          old_path "foo"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
           changes "content"
          
              path "baz"
          old_type "file"
          new_path "foo"
          new_type "file"
          old_path "bar"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "rename_target" "known"
           changes "content"
     </pre>

          <p>Dropped from the manifest but not removed in the workspace and thus
unknown:
<pre class="verbatim">              path "dropped"
          old_type "file"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "dropped" "unknown"
     </pre>

          <p>Added in the manifest but not in the workspace, and thus missing:
<pre class="verbatim">              path "added"
          new_type "file"
           fs_type "none"
            status "added" "missing"
     </pre>

          <p>Recorded a rename in the manifest, but not moved in the workspace,
and thus unknown source and missing target:
<pre class="verbatim">              path "original"
          old_type "file"
          new_path "renamed"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source" "unknown"
          
              path "renamed"
          new_type "file"
          old_path "original"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "missing"
     </pre>

          <p>Moved in the workspace but no rename recorded in the manifest, and
thus missing source and unknown target:
<pre class="verbatim">              path "original"
          old_type "file"
          new_type "file"
           fs_type "none"
            status "missing"
          
             path "renamed"
          fs_type "file"
           status "unknown"
     </pre>

          <p>Renamed in the manifest and the workspace and patched:
<pre class="verbatim">              path "original"
          old_type "file"
          new_path "renamed"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source"
          
              path "renamed"
          new_type "file"
          old_path "original"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "known"
           changes "content"
     </pre>

          <p>Renamed and restricted to <samp><span class="file">original</span></samp> or <samp><span class="file">renamed</span></samp>:
<pre class="verbatim">              path "original"
          old_type "file"
          new_path "renamed"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source"
          
              path "renamed"
          new_type "file"
          old_path "original"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "known"
           changes "content"
     </pre>

          <p>Renamed and restricted to <samp><span class="file">original</span></samp> with the <samp><span class="option">--no-corresponding-renames</span></samp> option:
<pre class="verbatim">              path "original"
          old_type "file"
          new_path "renamed"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source"
     </pre>

          <p>Renamed and restricted to <samp><span class="file">renamed</span></samp> with the <samp><span class="option">--no-corresponding-renames</span></samp> option:
<pre class="verbatim">              path "renamed"
          new_type "file"
          old_path "original"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "known"
           changes "content"
     </pre>

          <p>File is missing, an unversioned directory is in the way:
<pre class="verbatim">              path "missing_file"
          old_type "file"
          new_type "file"
           fs_type "directory"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "invalid"
           changes "content"
     </pre>

          <p>Directory is missing, an unversioned file is in the way:
<pre class="verbatim">              path "missing_directory"
          old_type "directory"
          new_type "directory"
           fs_type "file"
            status "invalid"
     </pre>

          <p>Directory <samp><span class="file">source</span></samp> renamed to <samp><span class="file">target</span></samp>, <samp><span class="file">target</span></samp> is missing, an
unversioned file is in the way:
<pre class="verbatim">              path "source"
          old_type "directory"
          new_path "target"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source"
          
              path "source/a"
          old_type "file"
          new_path "target/a"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_source"
          
              path "target"
          new_type "directory"
          old_path "source"
           fs_type "file"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "invalid"
          
              path "target/a"
          new_type "file"
          old_path "source/a"
           fs_type "none"
             birth [cb271687054afd3c2b873c8994f206f08fb240d3]
            status "rename_target" "missing"
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Each path is printed in one basic_io stanza. Stanzas are separated by
a blank line. Each stanza starts with a <code>path</code> line, and contains
up to seven lines.

               <dl>
<dt><samp><span class="option">path</span></samp><dd>The file or directory path, relative to the workspace root. The file
either exists in the workspace, or is listed in the base or revision
manifest. 
<samp><span class="option">path</span></samp> is always output.

               <br><dt><samp><span class="option">old_type</span></samp><dd>The type of the node in the base manifest. 
&ldquo;type&rdquo; is either <samp><span class="option">file</span></samp> or <samp><span class="option">directory</span></samp>. 
<samp><span class="option">old_type</span></samp> is output for all old nodes (i.e. unchanged or dropped paths
and rename sources).

               <br><dt><samp><span class="option">new_type</span></samp><dd>The type of the node in the revision manifest. 
&ldquo;type&rdquo; is either <samp><span class="option">file</span></samp> or <samp><span class="option">directory</span></samp>. 
<samp><span class="option">new_type</span></samp> is output for all new nodes (i.e. unchanged or added paths
and rename targets).

               <br><dt><samp><span class="option">fs_type</span></samp><dd>The type of the node in the workspace (also called the filesystem). 
&ldquo;type&rdquo; is either <samp><span class="option">file</span></samp>, <samp><span class="option">directory</span></samp> or <samp><span class="option">none</span></samp>
(if the path does not exist in the file system). 
<samp><span class="option">fs_type</span></samp> is always output.

               <br><dt><samp><span class="option">old_path</span></samp><dd>The old path for the node, if it has been renamed in the revision
manifest. 
<samp><span class="option">old_path</span></samp> is only output for rename targets.

               <br><dt><samp><span class="option">new_path</span></samp><dd>The new path for the node, if it has been renamed in the revision
manifest. 
<samp><span class="option">new_path</span></samp> is only output for rename sources.

               <br><dt><samp><span class="option">birth</span></samp><dd>The identify of the revision that the node was first added in. 
<samp><span class="option">birth</span></samp> is only output if it exists in a committed revision.

               <br><dt><samp><span class="option">status</span></samp><dd><samp><span class="option">status</span></samp> is always output. Its value is one or more of:

                    <dl>
<dt><samp><span class="option">rename_source</span></samp><dd><var>path</var> is part of a rename and denotes the old name of a renamed node.

                    <br><dt><samp><span class="option">rename_target</span></samp><dd><var>path</var> is part of a rename and denotes the new name of a renamed node.

                    <br><dt><samp><span class="option">added</span></samp><dd><var>path</var> has been added in the revision manifest, but not existent in the
base manifest.

                    <br><dt><samp><span class="option">dropped</span></samp><dd><var>path</var> has been deleted in the revision manifest and the workspace.

                    <br><dt><samp><span class="option">missing</span></samp><dd><var>path</var> has been deleted in the workspace, but still exists in the revision
manifest.

                    <p>A file will also be labeled <samp><span class="option">missing</span></samp> if it is in a directory
that is ignored due to a regular expression in <samp><span class="file">.mtn-ignore</span></samp>, but
is also in the revision manifest. A warning is issued in this case.

                    <br><dt><samp><span class="option">ignored</span></samp><dd><var>path</var> is ignored by monotone.

                    <br><dt><samp><span class="option">known</span></samp><dd><var>path</var> exists in the workspace, and in the revision manifest.

                    <br><dt><samp><span class="option">unknown</span></samp><dd><var>path</var> exists in the workspace, but not in the revision manifest, i.e. 
is unversioned.

                    <br><dt><samp><span class="option">invalid</span></samp><dd><var>path</var> is versioned and exists in the workspace and revision manifest, but
with incompatible types (a versioned missing file is replaced by an
unversioned directory and vice versa). 
</dl>

               <br><dt><samp><span class="option">changes</span></samp><dd>
                    <dl>
   <dt><samp><span class="option">content</span></samp><dd>   The contents of a file have been changed.

                    <br><dt><samp><span class="option">attrs</span></samp><dd>   The attributes of a path (file or directory) have been changed.

               </dl>
               </dl>

          <br><dt><strong>Error conditions:</strong><dd>
When executed from outside of a workspace directory, prints an error
message to stderr, and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate keys</span></samp><a name="index-mtn-automate-keys-229"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>11.0 &ndash; Instead of having a "name" item, there are
"given_name" and "local_name" items. 
<li>10.0 &ndash; The separate hashes for the private half of a key really didn't
make much sense; have one <code>hash [...]</code> line instead of separate
<code>public_hash [...]</code> and <code>private_hash [...]</code> lines. 
<li>1.1 &ndash; initial

          </ul>

          <br><dt><strong>Purpose:</strong><dd>
Print all keys in basic_io format.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">                      hash [475055ec71ad48f5dfaf875b0fea597b5cbbee64]
                given_name "tbrownaw@gmail.com"
                local_name "tbrownaw@gmail.com"
           public_location "database" "keystore"
          private_location "keystore"
          
                     hash [3ac4afcd86af28413b0a23b7d22b9401e15027fc]
                given_name "tomfa@debian.org"
                local_name "tomfa@debian.org"
          public_location "database"
          
                      hash [115fdc73d87a5e9901d018462b21a1f53eca33a1]
                given_name "underwater@fishtank.net"
                local_name "underwater@fishtank.net"
           public_location "keystore"
          private_location "keystore"
          
     </pre>

          <br><dt><strong>Output format:</strong><dd>
For each key, a basic_io stanza is printed. The public_location and
private_location items may have multiple values as shown above for
public_location, one value for each place that the key is stored. If
the private key does not exist, then the private_hash and
private_location items will be absent. given_name is the name provided
when the key was created, and local_name is the name returned by the
<code><a href="get_005flocal_005fkey_005fname.html#get_005flocal_005fkey_005fname">get_local_key_name</a></code> hook.

          <p>The keys are ordered by hash value.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <br><dt><samp><span class="command">mtn automate leaves</span></samp><a name="index-mtn-automate-leaves-230"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
0.1

          <br><dt><strong>Purpose:</strong><dd>
Prints the leaves of the revision graph, i.e. all revision that have
no children.

          <p>This is similar, but not identical to the functionality of
<samp><span class="command"><a href="mtn-automate-heads.html#mtn-automate-heads">mtn automate heads</a></span></samp>, which prints every revision in a
branch, that has no descendants in that branch.  If every revision in
the database was in the same branch, then they would be identical. 
Generally, every leaf is the head of some branch, but not every branch
head is a leaf.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each a leaf of the revision graph.  Each line
consists of a revision ID, in hexadecimal, followed by a newline.  The
lines are printed in alphabetically sorted order.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <p><a name="mtn-automate-log"></a><br><dt><samp><span class="command">mtn automate log [</span><var>options</var><span class="command">] [</span><var>pathname...</var><span class="command">]</span></samp><a name="index-mtn-automate-log-_005b_0040var_007boptions_007d_005d-_005b_0040var_007bpathname_002e_002e_002e_007d_005d-231"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
[&ndash;depth=<var>n</var>] [&ndash;exclude=<var>path...</var>]
[&ndash;last=<var>n</var>] [&ndash;next=<var>n</var>] [&ndash;from=<var>id...</var>]
[&ndash;clear-from] [&ndash;to=<var>id...</var>] [&ndash;clear-to]
[&ndash;[no-]merges] [<var>pathname...</var>]

          <p>Same as <samp><span class="command">mtn log</span></samp>, but without the output control options; see
<samp><span class="command"><a href="mtn-log.html#mtn-log">mtn log</a></span></samp>.

          <br><dt><strong>Added in:</strong><dd>
12.2

          <br><dt><strong>Purpose:</strong><dd>
Print the selected revisions on stdout, in topological order. The user
can then use other automate commands to retrieve additional
information about each revision.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          233afb8c4832bf33d5f5734225164de5f5a6278c
          4a368a6b217c40b2ff3b12bb7cfa00987e0f191c
          233afb8c4832bf33d5f5734225164de5f5a6278c
     </pre>

          <br><dt><strong>Output format:</strong><dd>
One revision per line.

          <br><dt><strong>Error conditions:</strong><dd>
See <samp><span class="command"><a href="mtn-log.html#mtn-log">mtn log</a></span></samp>.

     </dl>

     <p><a name="mtn-automate-lua"></a><br><dt><samp><span class="command">mtn automate lua </span><var>function_name</var><span class="command"> [</span><var>function_args...</var><span class="command">]</span></samp><a name="index-mtn-automate-lua-_0040var_007bfunction_005fname_007d-_005b_0040var_007bfunction_005fargs_002e_002e_002e_007d_005d-232"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A valid Lua function name and zero or more function arguments. Note that string
arguments need to be wrapped in another pair of quotes, i.e. <code>"foo"</code> or
<code>'foo'</code> will not work, but <code>"'foo'"</code> or <code>'"foo"'</code> will.

          <p>A function arguments can be any valid Lua expression, including nested
tables and functions, like f.e. <code>{1,true,{['func'] =
function(...) return ... end }}</code>

          <br><dt><strong>Added in:</strong><dd>
9.0

          <br><dt><strong>Purpose:</strong><dd>
Call Lua functions, like monotone hooks, in the monotone context, f.e. to
retrieve user defaults like keys, passwords, ignorable files and more.

          <br><dt><strong>Output format:</strong><dd>
A string dump of the return value of the function, in Lua code. The Lua types
<code>function</code>, <code>thread</code>, <code>userdata</code> and <code>lightuserdata</code> are not
serialized, but set to <code>nil</code> in the dump.

          <p>Please note that <code>nil</code> values in tables are not printed since Lua does not
distinguish between unset and not existing entries in a table like other
programming languages do.

          <br><dt><strong>Sample output:</strong><dd>
A single string return value:

          <pre class="verbatim">          [1] = "Output";
     </pre>

          <p>Two numeric return values:

          <pre class="verbatim">          [1] = 3;
          [2] = 4.4;
     </pre>

          <p>A nested table:

          <pre class="verbatim">          [1] = {
              ["bar"] = {
                  [1] = 1;
                  [2] = 2;
                  [3] = 3;
              };
          };
     </pre>

          <p>A callback function:

          <pre class="verbatim">          [1] = nil --[[function]];
     </pre>

          <br><dt><strong>Error conditions:</strong><dd>
This command prints an error message and exists with status 1 if the function
does not exist, one or more function arguments could not be evaluated or the
function could not be called for another reason.

     </dl>

     <p><a name="mtn-automate-packet_005ffor_005ffdata"></a><br><dt><samp><span class="command">mtn automate packet_for_fdata </span><var>id</var></samp><a name="index-mtn-automate-packet_005ffor_005ffdata-_0040var_007bid_007d-233"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>id</var> specifies the file for which to output an fdata packet.

          <br><dt><strong>Added in:</strong><dd>
2.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the file data in packet format

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          [fdata 229c7f621b65f7e4970ae5aaec993812b9daa1d4]
          H4sIAAAAAAAA/z2OO27DMBBEe51ioMaNrJzBpQAjTXKBBTW0CJPcgFw6yO1DCkG62Q/em83j
          R9vlRez6naPKzh2CwkipXFBJbO8fn7f7HV4LQq4mMYoFzdMYSnMj1xXY/lnuoHt2kB2hQpst
          PREPZhaxvvchskIKkdU6xsXWvQsk76MOUquGVolZmmmh0+xxvf7JZ5jCFXbU4KZ1muYkT+Kw
          FOez5q6uLuh9+9eoQawhez3Fp+VtHJNkfMmDHfALzWYfcAgBAAA=
          [end]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
File data in <samp><span class="command"><a href="mtn-read.html#mtn-read">mtn read</a></span></samp> compatible packet format.

          <br><dt><strong>Error conditions:</strong><dd>
If <var>id</var> is unknown or invalid prints an error message to stderr
and exits with status 1.

     </dl>

     <p><a name="mtn-automate-packet_005ffor_005ffdelta"></a><br><dt><samp><span class="command">mtn automate packet_for_fdelta </span><var>from-id</var> <var>to-id</var></samp><a name="index-mtn-automate-packet_005ffor_005ffdelta-_0040var_007bfrom_002did_007d-_0040var_007bto_002did_007d-234"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
<var>from-id</var> specifies the file to use as the base of the delta,
and <var>to-id</var> specifies the file to use as the target of the delta.

          <br><dt><strong>Added in:</strong><dd>
2.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the file delta in packet format.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          [fdelta 597049a62d0a2e6af7df0b19f4945ec7d6458727
                  229c7f621b65f7e4970ae5aaec993812b9daa1d4]
          H4sIAAAAAAAA/0WOy0oEMRBF9/mKS2/c9LQg4t5lw+BGf6BIKtNhkpSkKop/b9II7m49OOfu
          eHp5dnvEj/SHL0aQ75qFAgcQGmcm5RXKjP3t/eP1ekWUhlTVKGeyJNXNoXU/s27AP8sf7O8D
          ZEdSSLd1JMaNKzeysY8ps4Iao4oNjM99eFdQDbMOSldDV8ZC3aSxlxpxufzJF5jANx6oyS2b
          c0uhO+OwkpezZhCvK0bf8TVrMLZUo5zi0/I4j4UqPunGA+B+AfHvKEIPAQAA
          [end]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
File delta data in <samp><span class="command"><a href="mtn-read.html#mtn-read">mtn read</a></span></samp> compatible packet format.

          <br><dt><strong>Error conditions:</strong><dd>
If <var>from-id</var> or <var>to-id</var> is unknown or invalid prints an error
message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate packet_for_rdata </span><var>id</var></samp><a name="index-mtn-automate-packet_005ffor_005frdata-_0040var_007bid_007d-235"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>id</var> specifies the revision to output an rdata packet for.

          <br><dt><strong>Added in:</strong><dd>
2.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the revision data in packet format

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          [rdata bdf3b10b5df0f17cc6c1b4b3351d84701bda59ed]
          H4sIAAAAAAAA/0XQS27DMAwE0L1PIfgArb4kte62NzACg5SoJEBsF7aRurev0UVzgJl5mLas
          E+/jU9ftvsymd33Xzfo9Tjzfm267GSgGwVarz6Valx0KtFYwii9VqUFCqJQ5X7puedRx1ef9
          r2rwHlSbi+BUSrF4xn1p0RInkmxTbmwREp/BL97LzfQfN56v+rlc+860dZnMED01jhILkURJ
          Ul0KPpGN1ueUwDHyiXF66Ywx+2IGD+0Uqg8aCzikAEzZNRXPmJKlkhMxSHuNzrofx/uq2/J4
          6njV/bZsu/zMPOlbOY4XJSD5KOrwXGdwpDGdfotZayQHKTAi5fRPqUWKcAMMIQfAjOK0nkfm
          6tFacjYgBPV46X4BtlpiNYUBAAA=
          [end]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Revision data in <samp><span class="command"><a href="mtn-read.html#mtn-read">mtn read</a></span></samp> compatible packet format.

          <br><dt><strong>Error conditions:</strong><dd>
If <var>id</var> is unknown or invalid prints an error message to stderr
and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate packets_for_certs </span><var>id</var></samp><a name="index-mtn-automate-packets_005ffor_005fcerts-_0040var_007bid_007d-236"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>id</var> specifies the revision for which to output cert packets.

          <br><dt><strong>Added in:</strong><dd>
2.0

          <br><dt><strong>Purpose:</strong><dd>
Prints the certs associated with a revision in packet format

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          [rcert bdf3b10b5df0f17cc6c1b4b3351d84701bda59ed
                 branch
                 njs@pobox.com
                 bmV0LnZlbmdlLm1vbm90b25l]
          K90i1XHHmaMEMuwbPifFweLThJl0m7jigh2Qq6Z7TBwNJ6IMOjXWCizv73cacZ1CtzxFDVwQ
          SlqhNWiPQWxdcMp+Uuo+V8IFMKmvxVSTuVDukLMuNAQqpGL5S+a+tEj68NMq+KLKuL8kAAPc
          RoFD7GQlTS35S3RHWA4cnvqn+8U=
          [end]
          [rcert bdf3b10b5df0f17cc6c1b4b3351d84701bda59ed
                 date
                 njs@pobox.com
                 MjAwNi0wNC0wOFQxMTo1MDowMA==]
          araz9A8x6AlK6m6UhwnhUhk7cdyxeE2nvzj2gwaDvkaBxOq4SN23/wnaPqUXx1Ddn8smzyRY
          HN08xloYc0yNChp3wjbqx20REcsTg3XE4rN/sgCbqqw5hVT22a5ZhqkfkDeoeJvan0R0UBax
          ngKYo9eLuABNlmFX2onca75JW1E=
          [end]
          [rcert bdf3b10b5df0f17cc6c1b4b3351d84701bda59ed
                 author
                 njs@pobox.com
                 bmpzQHBvYm94LmNvbQ==]
          BLPOYhgLsAN+w7CwOsv9GfXnG3u7RNF1DTrWdn0AnYE1e+ptgTeMVWUI18H4OGL0B7wm08rv
          Pxk/hvsb8fBn1Kf5HDDO2pbjJ0xVzI9+p+TR0y5jJNZlVSTj+nvtPgvK9NzsdooYWnwlWmJv
          bOkAzQcZb8NMh8pbQkdHbR5uzMo=
          [end]
          [rcert bdf3b10b5df0f17cc6c1b4b3351d84701bda59ed
                 changelog
                 njs@pobox.com
                 MjAwNi0wNC0wOCAgTmF0aGFuaWVsIFNtaXRoICA8bmpzQHBvYm94LmNvbT4KCgkqIG5ldHh4
          L3Jlc29sdmVfZ2V0aG9zdGJ5bmFtZS5jeHggKHJlc29sdmVfaG9zdG5hbWUpOiAjaWZkZWYg
          b3V0CglXaW4zMi1pbmNvbXBhdGlibGUgZXJyb3IgcmVwb3J0aW5nIGNhbGwuCg==]
          Ncl4L/oEPctzVQixTKA6FrLceeHnLiXfeyeFDNmtUFYg9BMUcjWkeyKmaWknLvOcHortxjto
          K6pQ9E8S7zI+TpzFAhssg5a///rFL0+2GJU3t6pcHs6LC0Q4tbqzwKd/5+8GwT1gphbM1wm7
          KuzKthwqD3pp49GbgTrp8iWMTr0=
          [end]
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Cert data in <samp><span class="command"><a href="mtn-read.html#mtn-read">mtn read</a></span></samp> compatible packet format.

          <br><dt><strong>Error conditions:</strong><dd>
If <var>id</var> is unknown or invalid prints an error message to stderr
and exits with status 1.

     </dl>

     <p><a name="mtn-automate-parents"></a><br><dt><samp><span class="command">mtn automate parents </span><var>rev</var></samp><a name="index-mtn-automate-parents-_0040var_007brev_007d-237"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One revision ID.

          <br><dt><strong>Added in:</strong><dd>
0.2

          <br><dt><strong>Purpose:</strong><dd>
Prints the immediate parents of a revision.  This is like a
non-recursive version of <samp><span class="command"><a href="mtn-automate-ancestors.html#mtn-automate-ancestors">mtn automate ancestors</a></span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one parent of the given
revision.  Each line consists of a revision ID, in hexadecimal,
followed by a newline.  The lines are printed in alphabetically sorted
order.

          <br><dt><strong>Error conditions:</strong><dd>
If the given revision <var>rev</var> does not exist, prints nothing to
stdout, prints an error message to stderr, and exits with status 1.

     </dl>

     <p><a name="mtn-automate-pull"></a><br><dt><samp><span class="command">mtn automate pull [--[no-]set-default] [--dry-run] [</span><var>uri</var><span class="command">]</span></samp><a name="index-mtn-automate-pull-_005b_002d_002d_005bno_002d_005dset_002ddefault_005d-_005b_002d_002ddry_002drun_005d-_005b_0040var_007buri_007d_005d-238"></a><dt><samp><span class="command">mtn automate push [--[no-]set-default] [--dry-run] [--keys-to-push=</span><var>key</var><span class="command">] [</span><var>uri</var><span class="command">]</span></samp><a name="index-mtn-automate-push-_005b_002d_002d_005bno_002d_005dset_002ddefault_005d-_005b_002d_002ddry_002drun_005d-_005b_002d_002dkeys_002dto_002dpush_003d_0040var_007bkey_007d_005d-_005b_0040var_007buri_007d_005d-239"></a><dt><samp><span class="command">mtn automate sync [--[no-]set-default] [--dry-run] [--keys-to-push=</span><var>key</var><span class="command">] [</span><var>uri</var><span class="command">]</span></samp><a name="index-mtn-automate-sync-_005b_002d_002d_005bno_002d_005dset_002ddefault_005d-_005b_002d_002ddry_002drun_005d-_005b_002d_002dkeys_002dto_002dpush_003d_0040var_007bkey_007d_005d-_005b_0040var_007buri_007d_005d-240"></a><dt><samp><span class="command">mtn automate pull [--[no-]set-default] [</span><var>address</var><span class="command">] [</span><var>glob</var><span class="command"> [...] [--exclude=</span><var>exclude-glob</var><span class="command">]]] </span><strong>deprecated</strong></samp><a name="index-mtn-automate-pull-_005b_002d_002d_005bno_002d_005dset_002ddefault_005d-_005b_0040var_007baddress_007d_005d-_005b_0040var_007bglob_007d-_005b_002e_002e_002e_005d-_005b_002d_002dexclude_003d_0040var_007bexclude_002dglob_007d_005d_005d_005d-_0040strong_007bdeprecated_007d-241"></a><dt><samp><span class="command">mtn automate push [--[no-]set-default] [--keys-to-push=</span><var>key</var><span class="command">] [</span><var>address</var><span class="command">] [</span><var>glob</var><span class="command"> [...] [--exclude=</span><var>exclude-glob</var><span class="command">]]] </span><strong>deprecated</strong></samp><a name="index-mtn-automate-push-_005b_002d_002d_005bno_002d_005dset_002ddefault_005d-_005b_002d_002dkeys_002dto_002dpush_003d_0040var_007bkey_007d_005d-_005b_0040var_007baddress_007d_005d-_005b_0040var_007bglob_007d-_005b_002e_002e_002e_005d-_005b_002d_002dexclude_003d_0040var_007bexclude_002dglob_007d_005d_005d_005d-_0040strong_007bdeprecated_007d-242"></a><dt><samp><span class="command">mtn automate sync [--[no-]set-default] [--keys-to-push=</span><var>key</var><span class="command">] [</span><var>address</var><span class="command">] [</span><var>glob</var><span class="command"> [...] [--exclude=</span><var>exclude-glob</var><span class="command">]]] </span><strong>deprecated</strong></samp><a name="index-mtn-automate-sync-_005b_002d_002d_005bno_002d_005dset_002ddefault_005d-_005b_002d_002dkeys_002dto_002dpush_003d_0040var_007bkey_007d_005d-_005b_0040var_007baddress_007d_005d-_005b_0040var_007bglob_007d-_005b_002e_002e_002e_005d-_005b_002d_002dexclude_003d_0040var_007bexclude_002dglob_007d_005d_005d_005d-_0040strong_007bdeprecated_007d-243"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The automate versions of pull, push and sync have the same set of
arguments and options as the non-automate versions. See <a href="Network.html#Network">Network</a>
for a full explanation.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>13.0 &ndash; add sent/received revision, cert, and key output; add &ndash;dry-run.

               <li>12.0 &ndash; added
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Pushes, pulls or syncs (push &amp; pull) revisions, certificates and keys of
the given database to, from or with the given netsync server.

          <br><dt><strong>Sample output:</strong><dd>The following is example main channel data, non-dry-run:
<pre class="verbatim">          receive_cert "test"
                 value "value"
                   key [05c26b6cb109ca39bc48bbbdce83564c97796155]
              revision [114f6aa58c7707bf83516d4080ca6268c36640ad]
          
          receive_revision [114f6aa58c7707bf83516d4080ca6268c36640ad]
          
           receive_cert "branch"
                  value "foo"
                    key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
               revision [114f6aa58c7707bf83516d4080ca6268c36640ad]
          
           receive_cert "changelog"
                  value "R1
          "
                    key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
               revision [114f6aa58c7707bf83516d4080ca6268c36640ad]
          
           receive_cert "date"
                  value "2010-09-01T12:00:00"
                    key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
               revision [114f6aa58c7707bf83516d4080ca6268c36640ad]
          
           receive_cert "author"
                  value "tester@test.net"
                    key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
               revision [114f6aa58c7707bf83516d4080ca6268c36640ad]
          
          receive_key [111808abc306fd7423b564f2a8ef5c09745b87d2]
          
          send_cert "test"
              value "value"
                key [05c26b6cb109ca39bc48bbbdce83564c97796155]
           revision [114f6aa58c7707bf83516d4080ca6268c36640ad]
          
          send_revision [2a46f4b909071fae756b4911a247ce3ff1c3c4ce]
          
          send_cert "branch"
              value "foo2"
                key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
           revision [2a46f4b909071fae756b4911a247ce3ff1c3c4ce]
          
          send_cert "changelog"
              value "R2
          "
                key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
           revision [2a46f4b909071fae756b4911a247ce3ff1c3c4ce]
          
          send_cert "date"
              value "2010-09-01T12:00:00"
                key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
           revision [2a46f4b909071fae756b4911a247ce3ff1c3c4ce]
          
          send_cert "author"
              value "tester@test.net"
                key [46ec58576f9e4f34a9eede521422aa5fd299dc50]
           revision [2a46f4b909071fae756b4911a247ce3ff1c3c4ce]
          
          send_key [05c26b6cb109ca39bc48bbbdce83564c97796155]
     </pre>

          <p>The following is example dry-run main channel data:
<pre class="verbatim">                  estimate
          receive_revision "0"
              receive_cert "0"
               receive_key "0"
             send_revision "1"
                 send_cert "5"
                  send_key "0"
               send_branch "foo2" "1"
     </pre>

          <p>The following shows the progress and ticker data for a pull
which transferred two revisions and eight certs.

          <p><em>Note:</em> The linebreaks are not part of the actual format, but have been
added for better readability.

          <pre class="verbatim">          0:p:62:doing anonymous pull; use -kKEYNAME if you need authentication
          0:p:46:connecting to mtn://code.monotone.ca/monotone0:0:p:29:finding items to synchronize:
          0:t:34:c:certificates;k:keys;r:revisions;
          0:t:12:c=0;k=0;r=0;
          0:t:13:c#0;k#0;r#64;
          0:t:14:c#0;k#0;r#128;
          [...]
          0:t:6:c;k;r;
          0:t:44:>:bytes in;&lt;:bytes out;c:certs in;r:revs in;
          0:t:16:>=0;&lt;=0;c=0;r=0;
          0:t:21:>#420;&lt;#1344;c#0;r#0;
          0:t:22:>#1165;&lt;#1741;c#0;r#0;
          [...]
          0:t:24:>#20839;&lt;#14882;c#0;r#1;
          0:t:24:>#20839;&lt;#14882;c#3;r#1;
          0:t:24:>#20839;&lt;#14882;c#4;r#2;
          0:t:24:>#20839;&lt;#14882;c#6;r#2;
          0:t:24:>#20863;&lt;#14930;c#8;r#2;
          0:t:8:&lt;;>;c;r;
          0:p:36:successful exchange with mtn://code.monotone.ca/monotone
          0:l:1:0
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Output consists of sent and received revisions, certs, and keys in the
main stdio channel, progress messages, and ticker data for bytes,
revisions, certs and keys.

          <p>For non-dry-run, all stanzas are optional; they are only output if the
data they describe is transferred.

          <p>A partial order is imposed, that the parser can use in deciding how to
store the data. First all certs associated with revisions that are not
transferred in this sync are output, then revisions with associated
certs, then keys. All received data is output before all sent data.

          <p>For each cert not associated with a transmitted revision,
there is a stanza giving the cert name, value, key, and revision.

          <p>For each revision, there is a stanza containing the revision
id, followed by a stanza containing the cert name, value, key, and
revision id for each cert associated with the revision.

          <p>For each key, there is one stanza containing one line giving the key
id.

          <p>If run outside of <samp><span class="command">automate stdio</span></samp>, the progress and ticker
output of these commands is equal to the normal netsync command
progress and ticker output.

          <p>If these commands are run over stdio, the stdio ticker format is used
(for a description of this format, see <samp><span class="command"><a href="mtn-automate-stdio.html#mtn-automate-stdio">mtn automate stdio</a></span></samp>).

          <p>The following ticker types are printed out during the refinement phase:

               <ul>
<li><code>c</code>: The number of certs found for an upcoming synchronization
<li><code>k</code>: The number of keys found for an upcoming synchronization
<li><code>r</code>: The number of revisions found for an upcoming synchronization
</ul>

          <p>After refinement the actual synchronization between the two nodes start. The
ticker stanzas in this phase are the following:

               <ul>
<li><code>&gt;</code>: The number of incoming bytes
<li><code>&lt;</code>: The number of outgoing bytes
<li><code>c</code>: The number of incoming certs  (only pull and sync)
<li><code>C</code>: The number of outgoing certs  (only push and sync)
<li><code>r</code>: The number of incoming revisions  (only pull and sync)
<li><code>R</code>: The number of outgoing revisions  (only push and sync)
</ul>

          <p>For dry-run, one stanza is output, with optional lines giving the
revision, cert, and key counts for send and receive. Under some
circumstances, the number of keys that would be received is only an
estimate; in that case, the symbol <code>estimate</code> is output. For
send, the branch names of sent revisions are also output. Note that in
the branch list, revisions that have multiple branch certs are listed
twice, so the sum of the revision counts in the branch list may be
greater than the number of revisions transferred.

          <br><dt><strong>Error conditions:</strong><dd>
If a netsync error occurs, the command outputs an error and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate put_file [</span><var>base-id</var><span class="command">] </span><var>contents</var></samp><a name="index-mtn-automate-put_005ffile-_005b_0040var_007bbase_002did_007d_005d-_0040var_007bcontents_007d-244"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The optional <var>base-id</var> specifies a file-id on which the contents are
based. This is used for delta encoding. <var>contents</var> are the contents of
the new file.

          <p>If <var>base-id</var> is not given, the file is a new file, and no delta is
stored.

          <br><dt><strong>Added in:</strong><dd>
4.1

          <br><dt><strong>Purpose:</strong><dd>
Preparation of a workspace-less commit.  See <samp><span class="command"><a href="mtn-automate-put_005frevision.html#mtn-automate-put_005frevision">mtn automate put_revision</a></span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          70a0f283898a18815a83df37c902e5f1492e9aa2
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The sha1 sum of the contents, hex encoded.

          <br><dt><strong>Error conditions:</strong><dd>
If the optional base id is unknown prints an error message to stderr and
exits with status 1.

     </dl>

     <p><a name="mtn-automate-put_005fpublic_005fkey"></a><br><dt><samp><span class="command">mtn automate put_public_key </span><var>key-packet-data</var></samp><a name="index-mtn-automate-put_005fpublic_005fkey-_0040var_007bkey_002dpacket_002ddata_007d-245"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A data packet, <var>key-packet-data</var>, as produced by <samp><span class="command"><a href="mtn-automate-get_005fpublic_005fkey.html#mtn-automate-get_005fpublic_005fkey">mtn automate get_public_key</a></span></samp>.

          <br><dt><strong>Changes:</strong><dd>
13.0 &ndash; initial

          <br><dt><strong>Purpose:</strong><dd>
Store public keys into the database.

          <p>Note that this duplicates part of <samp><span class="command"><a href="mtn-automate-read_005fpackets.html#mtn-automate-read_005fpackets">mtn automate read_packets</a></span></samp>; the
intent is to deprecate <samp><span class="command">automate read_packets</span></samp>, and only keep
facilities for key packets.

          <br><dt><strong>Output format:</strong><dd>
No output.

          <br><dt><strong>Error conditions:</strong><dd>
An error will be produced if the argument is not a valid key packet.

     </dl>

     <p><a name="mtn-automate-put_005frevision"></a><br><dt><samp><span class="command">mtn automate put_revision </span><var>revision-data</var></samp><a name="index-mtn-automate-put_005frevision-_0040var_007brevision_002ddata_007d-246"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
<var>revision-data</var> is the new revision.

          <br><dt><strong>Added in:</strong><dd>
4.1

          <br><dt><strong>Purpose:</strong><dd>
Workspace-less commit.

          <p>Note that the new_manifest entry is ignored &ndash; <samp><span class="command">put_revision</span></samp>
will ignore whatever you put here and calculate the correct manifest
id itself.  (However, for now, you must put 40 hex digits here &ndash; it's
just that which particular digits you put are entirely irrelevant. 
All zeros is a good choice.)  Monotone will also canonicalize your
whitespace automatically.  You do not need to worry about getting just
the right amount of indentation in front of each line.  However,
everything else about your revision must be valid.

          <br><dt><strong>Sample argument:</strong><dd>
          <pre class="smallexample">          format_version "1"
          
          new_manifest [0000000000000000000000000000000000000004]
          
          old_revision []
          
          add_dir ""
          
          add_file "foo"
          content [5bf1fd927dfb8679496a2e6cf00cbe50c1c87145]
</pre>
          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          4c2c1d846fa561601254200918fba1fd71e6795d
     </pre>

          <br><dt><strong>Output format:</strong><dd>
The new revision id, hex encoded.

          <br><dt><strong>Error conditions:</strong><dd>
If the changeset is invalid prints an error message to stderr and
exits with status 1. May abort on invalid formats.  If the revision is
already present in the database, prints a message to stderr noting
this fact, but otherwise works as normal.

     </dl>

     <p><a name="mtn-automate-read_005fpackets"></a><br><dt><samp><span class="command">mtn automate read_packets </span><var>packet-data</var></samp><a name="index-mtn-automate-read_005fpackets-_0040var_007bpacket_002ddata_007d-247"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A data packet, <var>packet-data</var>, as produced by <samp><span class="command"><a href="mtn-pubkey.html#mtn-pubkey">mtn pubkey</a></span></samp>.

          <br><dt><strong>Added in:</strong><dd>
9.0

          <br><dt><strong>Purpose:</strong><dd>
Store public keys (and incidentally anything else that can be represented as
a packet) into the database.

          <br><dt><strong>Output format:</strong><dd>
No output.

          <br><dt><strong>Error conditions:</strong><dd>
An error will be produced if the argument is not a valid packet.

     </dl>

     <br><dt><samp><span class="command">mtn automate remote [--remote-stdio-host=</span><var>host</var><span class="command">] [--[no-]set-default] </span><var>command</var> <var>args-and-opts</var></samp><a name="index-mtn-automate-remote-_005b_002d_002dremote_002dstdio_002dhost_003d_0040var_007bhost_007d_005d-_005b_002d_002d_005bno_002d_005dset_002ddefault_005d-_0040var_007bcommand_007d-_0040var_007bargs_002dand_002dopts_007d-248"></a><dd>
          <dl>
<dt><strong>Arguments</strong><dd>
A command and its arguments, to execute on the remote server specified
by the <samp><span class="option">--remote-stdio-host</span></samp> option (defaults to server stored
in the database). If options are to be passed to the command, they must be
preceded by <samp><span class="option">--</span></samp> to prevent them from being interpreted as
local options.

          <p>Remote options <strong>must</strong> be given as a single token, ie
<samp><span class="option">--branch=foo</span></samp> or <samp><span class="option">-bfoo</span></samp>. This is because the local and remote
monotones may not understand exactly the same options (so the local monotone
cannot know if an option given as <samp><span class="option">--branch</span></samp> or <samp><span class="option">-b</span></samp> should be
followed by an argument), and because the server sees this as an
<code>automate remote_stdio</code> connection (so it expects the options to already
be parsed).

          <br><dt><strong>Added in</strong><dd>
12.0

          <br><dt><strong>Purpose</strong><dd>
Permit a single <code>automate</code> command to be run against a database that is
being used to serve netsync connections, without having its input and output
encoded as by <code>automate stdio</code>.

          <br><dt><strong>Input/Output Format</strong><dd>
This command does not accept input.

          <p>The output will be whatever output the remote command generates.

          <p>Remote diagnostic messages are written to standard error, prefixed either
with <code>mtn: remote error:</code>, <code>mtn: remote warning:</code> or
<code>mtn: remote message:</code> to make them distinguishable from local
diagnostics. Tickers are not supported over this interface. If you need
remote ticker support, see <samp><span class="command"><a href="mtn-automate-remote_005fstdio.html#mtn-automate-remote_005fstdio">mtn automate remote_stdio</a></span></samp>.

          <br><dt><strong>Error Conditions</strong><dd>
If the remote command returns a nonzero error code, will exit with code 1 and
print "received remote error code N" to standard error, with "N" being
the remote error code.

          <br><dt><strong>Notes</strong><dd>
If no database is specified, a <samp><span class="command">:memory:</span></samp> database is used.

          <p>On the server side the <code>get_remote_automate_permitted</code> hook has to be
configured to include every command which should be executable over this
interface.

          <p>Keyboard interaction is disabled on the server, just as if
<samp><span class="option">--non-interactive</span></samp> would have been specified on server startup. 
Actions which require operations on password-encrypted private keys will
therefor fail unless a <a href="get_005fpassphrase.html#get_005fpassphrase">get_passphrase</a> hook is set up remotely.

     </dl>

     <p><a name="mtn-automate-remote_005fstdio"></a><br><dt><samp><span class="command">mtn automate remote_stdio [</span><var>hostname</var><span class="command">]</span></samp><a name="index-mtn-automate-remote_005fstdio-_005b_0040var_007bhostname_007d_005d-249"></a><dd>
          <dl>
<dt><strong>Arguments</strong><dd>
<var>hostname</var> is the host (and optionally port) of the monotone server
process to connect to. If not given, the default server is used.

          <br><dt><strong>Added in</strong><dd>
12.0

          <br><dt><strong>Purpose</strong><dd>
Permit <code>automate</code> commands to be run against a database that is
being used to serve netsync connections.

          <br><dt><strong>Input/Output format</strong><dd>
This command takes input and produces output in exactly the
same format as <code>automate stdio</code>. Note that the commands run with
<code>automate remote_stdio</code> may conform to a different <var>interface_version</var>,
because they are handled by a remote instance of monotone.

          <p>There will be some extra chatter on stderr unless <samp><span class="option">--quiet</span></samp> is given.

          <br><dt><strong>Error Conditions</strong><dd>
If left idle for too long or there are network problems, the connection to the
server may be dropped. This will not be detected while monotone is waiting for
input. Instead, when a complete command has been entered and monotone tries to
send it to the remote server it will print a message to stderr and exit with
code 1.

          <br><dt><strong>Notes</strong><dd>
If no database is specified, a <samp><span class="command">:memory:</span></samp> database is used.

          <p>On the server side the <code>get_remote_automate_permitted</code> hook has to be
configured to include every command which should be executable over this
interface.

          <p>For both, the client and the server, keyboard interaction is disabled,
just as if <samp><span class="option">--non-interactive</span></samp> is specified. Actions which require
operations on password-encrypted private keys will therefor fail unless the
<a href="get_005fpassphrase.html#get_005fpassphrase">get_passphrase</a> hook is set up locally and / or remotely.

     </dl>

     <br><dt><samp><span class="command">mtn automate roots</span></samp><a name="index-mtn-automate-roots-250"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
None.

          <br><dt><strong>Added in:</strong><dd>
4.3

          <br><dt><strong>Purpose:</strong><dd>
Prints the roots of the revision graph, i.e. all revisions that have
no parents.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          276264b0b3f1e70fc1835a700e6e61bdbe4c3f2f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each a root of the revision graph.  Each line
consists of a revision ID, in hexadecimal, followed by a newline.  The
lines are printed in alphabetically sorted order.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <br><dt><samp><span class="command">mtn automate select </span><var>selector</var></samp><a name="index-mtn-automate-select-_0040var_007bselector_007d-251"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One selector (or combined selector).

          <br><dt><strong>Added in:</strong><dd>
0.2

          <br><dt><strong>Purpose:</strong><dd>
Print all revisions that match the given selector.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Zero or more lines, each giving the ID of one revision that matches the
given selector.  Each line consists of a revision ID, in hexadecimal,
followed by a newline.  Revision ids are printed in alphabetically
sorted order.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <br><dt><samp><span class="command">mtn automate set_attribute </span><var>path</var> <var>key</var> <var>value</var></samp><a name="index-mtn-automate-set_005fattribute-_0040var_007bpath_007d-_0040var_007bkey_007d-_0040var_007bvalue_007d-252"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A path, an attribute key and an attribute value.

          <br><dt><strong>Added in:</strong><dd>
5.0

          <br><dt><strong>Purpose:</strong><dd>
Edits the current workspace revision and inserts the given attribute key and
value for the specified path. Note that this change is not committed and
therefor behaves exactly like <samp><span class="command">mtn attr set </span><var>key</var> <var>value</var></samp>.

          <br><dt><strong>Output format:</strong><dd>
This command does not print out anything if successful.

          <br><dt><strong>Error conditions:</strong><dd>
If the path specified is unknown in the new workspace revision, prints an error
message to stderr and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate set_db_variable </span><var>domain</var> <var>name</var> <var>value</var></samp><a name="index-mtn-automate-set_005fdb_005fvariable-_0040var_007bdomain_007d-_0040var_007bname_007d-_0040var_007bvalue_007d-253"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
The <var>domain</var> and <var>name</var> specify the database variable
which is changed to <var>value</var>.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>7.0 &ndash; renamed to 'set_db_variable'
<li>4.1 &ndash; added as 'db_set'
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Change a database variable; see <a href="Vars.html#Vars">Vars</a>.

          <br><dt><strong>Sample usage:</strong><dd>
<pre class="verbatim">          mtn automate set_db_variable database default-server off.net
     </pre>

          <br><dt><strong>Output format:</strong><dd>
No output.

          <br><dt><strong>Error conditions:</strong><dd>
None.

     </dl>

     <p><a name="mtn-automate-show_005fconflicts"></a><br><dt><samp><span class="command">mtn automate show_conflicts [</span><var>&ndash;branch BRANCH</var><span class="command">] [</span><var>left_rev right_rev</var><span class="command">]</span></samp><a name="index-mtn-automate-show_005fconflicts-_005b_0040var_007b_002d_002dbranch-BRANCH_007d_005d-_005b_0040var_007bleft_005frev-right_005frev_007d_005d-254"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
Optional left and right revision ids.

          <p>If no revs are given, they default to the first two heads that would
be chosen by the <samp><span class="command">merge</span></samp> command for the current branch. If no
workspace is present, the branch may be given by the <var>&ndash;branch</var>
option.

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>11.0 &ndash; Add resolution for orphaned node conflicts. Deleted
<code>resolved_user</code> conflict resolution; use <code>resolved_*_left</code>
for single file conflicts. Add <code>resolved_keep_left,
resolved_keep_right</code> resolutions. 
<li>9.0 &ndash; Added default resolution for file content conflicts, user
resolutions for others. <code>directory_loop_created</code> changed to <code>directory_loop</code>. 
<li>8.0 &ndash; initial
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Show all conflicts between two revisions.

          <p>This is intended to be used before a <samp><span class="command">merge</span></samp>; an external tool
can guide the user thru resolving each conflict in turn, then do the
merge.

          <p>The same file format is output by the <samp><span class="command">conflicts store</span></samp>
command, which also allows specifying user conflict resolutions. The
file syntax for the resolutions is given here, so an external tool can
set them directly.

          <p>For more information on conflicts, see <a href="Merge-Conflicts.html#Merge-Conflicts">Merge Conflicts</a>.

          <p>Note that this cannot be used to show conflicts that would occur in an
<samp><span class="command">update</span></samp>, since in that case one revision is the workspace.

          <br><dt><strong>Sample output:</strong><dd>
The output starts by listing the revisions and their common ancestor:
<pre class="verbatim">              left [532ab5011ea9e64aa212d4ea52363b1b8133d5ba]
             right [b94a03a922c2c281a88d8988db64e76a32edb6a1]
          ancestor [ead03530f5fefe50c9010157c42c0ebe18086559]
     </pre>

          <p>If there are no conflicts, the ancestor revision is not output, and no
conflict stanzas are output.

          <p>Attribute changed in both branches, or dropped in one:
<pre class="verbatim">                  conflict attribute
                 node_type "file"
                 attr_name "attr1"
             ancestor_name "foo"
          ancestor_file_id [bab2022ff2ed13501a8a83bcc6bd53f5042141be]
                 left_name "foo"
              left_file_id [bab2022ff2ed13501a8a83bcc6bd53f5042141be]
           left_attr_value "valueX"
                right_name "foo"
             right_file_id [bab2022ff2ed13501a8a83bcc6bd53f5042141be]
          right_attr_value "valueZ"
          
                  conflict attribute
                 node_type "file"
                 attr_name "attr2"
             ancestor_name "foo"
          ancestor_file_id [bab2022ff2ed13501a8a83bcc6bd53f5042141be]
                 left_name "foo"
              left_file_id [bab2022ff2ed13501a8a83bcc6bd53f5042141be]
           left_attr_value "valueY"
                right_name "foo"
             right_file_id [bab2022ff2ed13501a8a83bcc6bd53f5042141be]
          right_attr_state "dropped"
     </pre>

          <p>Missing root directory:
<pre class="verbatim">               conflict missing_root
              left_type "pivoted root"
          ancestor_name "foo"
             right_type "deleted directory"
          ancestor_name "foo"
     </pre>

          <p>Directory deleted and/or renamed:
<pre class="verbatim">               conflict orphaned_directory
             right_type "deleted directory"
          ancestor_name ""
              left_type "renamed directory"
          ancestor_name ""
              left_name "bar"
          
               conflict orphaned_file
             right_type "deleted directory"
          ancestor_name "foo"
              left_type "added file"
              left_name "foo/baz"
           left_file_id [f5122a7f896cb2dd7ecaa84be89c94ab09c15101]
          
                  conflict orphaned_file
                right_type "deleted directory"
             ancestor_name "foo"
                 left_type "renamed file"
             ancestor_name "bar"
          ancestor_file_id [ac4c6d06436632e017bb7d3ea241734e8899f8ce]
                 left_name "foo/baz"
              left_file_id [ac4c6d06436632e017bb7d3ea241734e8899f8ce]
          
               conflict multiple_names
              left_type "renamed directory"
          ancestor_name ""
              left_name "aaa"
             right_type "renamed directory"
          ancestor_name ""
             right_name "bbb"
          
               conflict duplicate_name
              left_type "renamed directory"
          ancestor_name "foo"
              left_name ""
             right_type "renamed directory"
          ancestor_name "bar"
             right_name ""
          
               conflict multiple_names
              left_type "renamed directory"
          ancestor_name "foo"
              left_name "a/foo"
             right_type "renamed directory"
          ancestor_name "foo"
             right_name "b/foo"
     </pre>

          <p>Directory loop created:
<pre class="verbatim">               conflict directory_loop
              left_type "renamed directory"
          ancestor_name "foo"
              left_name "bar/foo"
             right_type "renamed directory"
          ancestor_name "bar"
             right_name "foo/bar"
     </pre>

          <p>File content changed (this may be resolvable by the internal line
merger), file also renamed:
<pre class="verbatim">                   conflict content
                  node_type "file"
              ancestor_name "bar"
           ancestor_file_id [f0ef49fe92167fe2a086588019ffcff7ea561786]
                  left_name "bar"
               left_file_id [08cd878106a93ce2ef036a32499c1432adb3ee0d]
                 right_name "bar"
              right_file_id [0cf419dd93d38b2daaaf1f5e0f3ec647745b9690]
          resolved_internal
          
                  conflict content
                 node_type "file"
             ancestor_name "foo"
          ancestor_file_id [50bf338804db2685a575124c8c8371d06b65c523]
                 left_name "bar"
              left_file_id [f1bb6fff2ad16d67143d89fc374ede7abec5d437]
                right_name "baz"
             right_file_id [b966b2d35b99e456cb0c55e4573ef0b1b155b4a9]
     </pre>
<code>resolved_internal</code> is a conflict resolution. If the file
contents in the two revs can be successfully merged by the internal
line merger, <code>resolved_internal</code> is output.

          <p>File added and/or renamed:
<pre class="verbatim">               conflict duplicate_name
              left_type "added file"
              left_name "bar"
           left_file_id [ba4637112ee3e55a6106d647d6c4e04a6643f8eb]
             right_type "added file"
             right_name "bar"
          right_file_id [fe6d523f607e2f2fc0f0defad3bda0351a95a337]
          
                  conflict duplicate_name
                 left_type "renamed file"
             ancestor_name "foo"
          ancestor_file_id [c6864a8456855c48afe83488a47501fe8b94bd57]
                 left_name "bar"
              left_file_id [c6864a8456855c48afe83488a47501fe8b94bd57]
                right_type "added file"
                right_name "bar"
             right_file_id [c809d71002ec57a2f1d10221f05993012a491436]
          
                  conflict duplicate_name
                 left_type "renamed file"
             ancestor_name "foo"
          ancestor_file_id [918f3642b57a5e2dd13ee874e3dc2518a53ab4b4]
                 left_name "abc"
              left_file_id [918f3642b57a5e2dd13ee874e3dc2518a53ab4b4]
                right_type "renamed file"
             ancestor_name "bar"
          ancestor_file_id [bdf46a521d5f1dd54c31dda15e99ff6b0c80394a]
                right_name "abc"
             right_file_id [bdf46a521d5f1dd54c31dda15e99ff6b0c80394a]
     </pre>

          <p>File renamed to different names:
<pre class="verbatim">                  conflict multiple_names
                 left_type "renamed file"
             ancestor_name "foo"
          ancestor_file_id [e80910e54d0bdea1b6d295ada320b87aaf9fdc23]
                 left_name "bar"
              left_file_id [e80910e54d0bdea1b6d295ada320b87aaf9fdc23]
                right_type "renamed file"
             ancestor_name "foo"
          ancestor_file_id [e80910e54d0bdea1b6d295ada320b87aaf9fdc23]
                right_name "baz"
             right_file_id [e80910e54d0bdea1b6d295ada320b87aaf9fdc23]
     </pre>

          <p>Invalid file name (<samp><span class="file">_MTN</span></samp> in root directory):
<pre class="verbatim">               conflict invalid_name
              left_type "pivoted root"
          ancestor_name "foo"
             right_type "added directory"
             right_name "foo/_MTN"
          
                  conflict invalid_name
                 left_type "pivoted root"
             ancestor_name "foo"
                right_type "renamed file"
             ancestor_name "bad/_MTN"
          ancestor_file_id [629d9e5d254241abf4b46f108fb53189e314e41d]
                right_name "foo/_MTN"
             right_file_id [629d9e5d254241abf4b46f108fb53189e314e41d]
     </pre>

          <p>Revisions that don't share a common ancestor:
<pre class="verbatim">              left [161e426c3b0c3f98d0be225f69d6f893ce8e0442]
             right [0e3260f51acd1e98c40666557eb6c0eefeae5f02]
          ancestor []
          
          conflict missing_root
          
            conflict duplicate_name
           left_type "added directory"
           left_name ""
          right_type "added directory"
          right_name ""
     </pre>

          <p>All possible conflict resolutions:
<pre class="verbatim">             resolved_drop_left
            resolved_drop_right
             resolved_keep_left
            resolved_keep_right
              resolved_internal
           resolved_rename_left file
          resolved_rename_right file
             resolved_user_left file
            resolved_user_right file
     </pre>
For single file conflicts, the <code>resolved_*_left</code> resolution name is used.

          <p>See <a href="Conflicts.html#Conflicts">Conflicts</a>, for more information on conflict resolutions.

          <br><dt><strong>Output format:</strong><dd>
First the revision ids of the left and right revisions, and their
common ancestor, are printed in one basic_io stanza.

          <p>Then each conflict is listed in a basic_io stanza. Stanzas are
separated by blank lines.

          <p>Each conflict stanza starts with a <code>conflict</code> line, and contains
up to eleven lines. The order of the lines is not important, and may
change in future revisions, except that the first line will always be
<code>conflict</code>.

          <p>When the conflicts involve files, the file ids are output, so the file
contents can be retrieved efficiently via <code>automate get_file</code>,
to aid in conflict resolution.

          <p>Only the <samp><span class="command">resolved_internal</span></samp> conflict resolution is output by
this command; the other conflict resolutions are inserted in a
conflicts file by <samp><span class="command">conflicts resolve_first</span></samp> or an external
tool, and read by <samp><span class="command">merge</span></samp>.

          <br><dt><strong>Error conditions:</strong><dd>
If the revision IDs are given, but either is unknown or
invalid, prints an error message to stderr and exits with status 1.

     </dl>

     <p><a name="mtn-automate-stdio"></a><br><dt><samp><span class="command">mtn automate stdio</span></samp><a name="index-mtn-automate-stdio-255"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
none

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>12.0 &ndash; Introduced out of band streams ('e', 'p', 't', 'w'); the main output
    of a command now only happens in the 'm' stream; the 'l' stream now marks
    the end of all streams of a command; introduced the concept of "headers"
    which are output before the first command is issued; specific error codes
    to distinguish command from interface errors have also been introduced. 
<li>3.1 &ndash; Added the 'o' item to the recognized input. This change should not
break anything. 
<li>1.0 &ndash; Initial version. 
</ul>

          <br><dt><strong>Purpose:</strong><dd>
Allow multiple automate commands to be run from one instance of monotone.

          <br><dt><strong>Sample input:</strong><dd>
<pre class="verbatim">          l6:leavese
          l7:parents40:0e3171212f34839c2e3263e7282cdeea22fc5378e
          o3:key11:foo@bar.come l4:cert40:0e3171212f34839c2e3263e7282cdeea22fc53783:foo3:bare
     </pre>

          <br><dt><strong>Input format:</strong><dd>
<pre class="verbatim">          [ 'o' &lt;string> &lt;string> [ &lt;string> &lt;string> [ ... ] ] 'e' ]
          'l' &lt;string> [ &lt;string> [ ... ] ] 'e'
     </pre>

          <p>The input is a series of commands and options. The command name plus
arguments are provided as 'l' &lt;string&gt; [&lt;string&gt; ...] 'e', where
&lt;string&gt; = &lt;size&gt; colon &lt;data&gt; . This may optionally be preceded by a
set of key=value pairs (command options) as 'o' &lt;string&gt; &lt;string&gt;
[&lt;string&gt; &lt;string&gt; ...] 'e', where strings come in pairs, key followed
by value. For flag options that don't take values, specify the second
string as zero length; <code>0:</code>. The option names do <em>not</em>
include the leading <samp><span class="command">--</span></samp>.

          <p>The space between the ending 'e' of one group of strings and the beginning
'l' or 'o' of the next is reserved. Any characters other than whitespace
will cause an error.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          format-version: 2
          
          0:m:41:7706a422ccad41621c958affa999b1a1dd644e79
          0:l:1:0
          ...
          1:e:38:misuse: key 'test@test' already exists
          1:l:1:2
          ...
          2:w:39:skipping file '\' with unsupported name
          2:m:144:    path ""
          old_type "directory"
          new_type "directory"
           fs_type "directory"
             birth [276264b0b3f1e70fc1835a700e6e61bdbe4c3f2f]
            status "known"
          ...
          3:t:34:c:certificates;k:keys;r:revisions;
          3:t:12:c=0;k=0;r=0;
          3:t:13:c#0;k#0;r#64;
          3:t:14:c#0;k#0;r#128;
          3:t:6:c;k;r;
          ...
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Right after a stdio session has been set up, header information is
issued; to date the only header defined is <code>format-version</code>,
which denotes the version of the stdio format used throughout the
session. The original format had no such version output, so our
numbering starts with "2" here.

          <p>Headers are separated from each other by single newline character <code>'\n'</code>
and the last is separated from the following output by a pair of newline
characters.

          <p>After a command has been issued, one or more packets are returned for it. 
A packet looks like:

          <pre class="verbatim">          &lt;command number>:&lt;stream>:&lt;size>:&lt;output>
     </pre>

          <p><code>&lt;command number&gt;</code> is a decimal number specifying which command this output
is from. It is 0 for the first command, and increases by one each time.

          <p><code>&lt;stream&gt;</code> is an identifier for which output stream this packet represents,
allowing multiple streams to be multiplexed over the channel.  The following
streams are presently defined; more streams may be added later.

               <ul>
<li> <code>m</code>: this stream represents the normal ("main") stdout automate output of
 the command, formatted as described in the description for that command. 
<li> <code>e</code>: this stream represents any (unstructured) error message data.

               <p>Internally, this maps to calls to the <code>E()</code> print macros that would
 normally be written by the command to the program's stderr stream, if the
 automate sub-command had been called directly rather than via &rdquo;'stdio&rdquo;'. 
<li> <code>w</code>: this stream represents any (unstructured) warning message data.

               <p>Internally, this maps to calls to the <code>W()</code> print macro that would
 normally be written by the command to the program's stderr stream, if the
 automate sub-command had been called directly rather than via &rdquo;'stdio&rdquo;'. 
<li> <code>p</code>: this stream represents any (unstructured) progress message data.

               <p>Internally, this maps to calls to the <code>P()</code> print macro that would
 normally be written by the command to the program's stderr stream, if the
 automate sub-command had been called directly rather than via &rdquo;'stdio&rdquo;'. 
<li> <code>t</code>: this stream represents ticker updates, which may be used
 by a user interface to display the progress of a command.

               <p>The output for this channel can be described as follows:

                    <ul>
 <li> <code>&lt;output&gt;       ::= &lt;definition&gt;&lt;payload&gt;&lt;end&gt;</code>
 <li> <code>&lt;definition&gt;   ::= &lt;shortname&gt; ':' &lt;longname&gt; &lt;eol&gt;</code>
 <li> <code>&lt;payload&gt;      ::= &lt;total_count&gt;&lt;advance&gt;+</code>
 <li> <code>&lt;end&gt;          ::= &lt;shortname&gt; &lt;eol&gt;</code>
 <li> <code>&lt;total_count&gt;  ::= &lt;shortname&gt; '=' &lt;count&gt; &lt;eol&gt;</code>
 <li> <code>&lt;advance&gt;      ::= &lt;shortname&gt; '#' &lt;count&gt; &lt;eol&gt;</code>
 <li> <code>&lt;shortname&gt;    ::= "\w+"</code>
 <li> <code>&lt;longname&gt;     ::= "[^;]+"</code>
 <li> <code>&lt;count&gt;        ::= ['0'-'9']+</code>
 <li> <code>&lt;eol&gt;          ::= ';'</code>
 </ul>

               <p>The definition tells the implementor the short name and long name of
any upcoming ticker event. The names and meanings are command-specific
and are therefore explained in the sections for the particular
commands which support ticker output.

               <p>The <code>total_count</code> might be 0 right at the start and can later be
changed to a different number if the command later on knows a more
exact value. If this is the case, this stanza is output again with
this new value. A constant <code>total_count</code> of 0 means that the
command may continue to run for a undefined amount of time until the
end stanza appears.

               <p>The advance tells the implementor how much work has been done so far.

               <p>Finally, the end stanza is printed just before the ticker ends
(i.e. the work has been done).

               <p>All counts output absolute, raw values; no modulation takes place. It
is usually the case that definition, <code>total_count</code>, advance and
end are output in separate stanzas. It is also possible that two or
more parallel tickers output their stanzas at the same time, in this
case it's ensured that the output does not get intermixed; first all
definitions are output, afterwards all total_counts, and so on.

               <p><em>Note:</em> The ticker format used for stdio is fixed and cannot be
selected explicitely via the global <samp><span class="option">--ticker</span></samp> option. However,
if you run an automate command outside of stdio you can set a
different ticker type, f.e.  <var>count</var>, <var>dot</var> or <var>none</var>.

               <li> <code>l</code>: this stream marks the termination of a command and all of
 its streams and carries the return code of the command in the payload.

               <p>A return code "0" stands for success, "1" for an error which occurred within
 the stdio interface (f.e. syntax errors or missing privileges) before the
 command is run and finally "2" for any other command-specific error. 
</ul>

          <p><code>&lt;size&gt;</code> is the number of bytes in the output.

          <p><code>&lt;output&gt;</code> is a piece of the output of the command.

          <br><dt><strong>Error conditions:</strong><dd>
Errors in the commands run through this interface do not affect the exit
status of this command. Instead, if a badly formatted or invalid command
is received, or a command is given with invalid arguments or options,
an error message to the error stream is printed and and the particular
sub-command exits with return code "1". Other command-specific errors are
returned as code "2".

          <p>Trying to run the <code>automate stdio</code> or <code>automate remote_stdio</code>
sub-commands will exit the particular command with return code "1".

          <br><dt><strong>Notes:</strong><dd>
Keyboard interaction is disabled, just as if
<samp><span class="option">--non-interactive</span></samp> is specified. Actions which require
operations on password-encrypted private keys will therefore fail
unless the <samp><span class="command"><a href="get_005fpassphrase.html#get_005fpassphrase">get_passphrase</a></span></samp> hook is set up locally.

          <p>Workspace options are read before executing each command.

          <br><dt><strong>Multiple streams</strong><dd>
The multiple stream encoding allows the output of errors and warnings to be
associated with the command that generated them, allows the communication
path to always stay in sync, and offers the opportunity to add other stream
types for other useful purposes in the future as needs arise.

     </dl>

     <br><dt><samp><span class="command">mtn automate sync</span></samp><a name="index-mtn-automate-sync-256"></a><dd>See <samp><span class="command"><a href="mtn-automate-pull.html#mtn-automate-pull">mtn automate pull</a></span></samp>

     <p><a name="mtn-automate-tags"></a><br><dt><samp><span class="command">mtn automate tags [</span><var>branch_pattern</var><span class="command">]</span></samp><a name="index-mtn-automate-tags-_005b_0040var_007bbranch_005fpattern_007d_005d-257"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
A branch pattern (defaults to all).

          <br><dt><strong>Changes:</strong><dd>
               <ul>
<li>11.0 &ndash; <var>signer</var> now prints the hash of the signing key, no longer the name. 
        Also, the <var>format_version</var> stanza has been removed in favour of the
        global <var>interface_version</var>. 
<li>2.2 &ndash; added
</ul>

          <br><dt><strong>Purpose:</strong><dd>
If a branch pattern is given, prints all tags that are attached to
revisions on branches matched by the pattern; otherwise prints all
tags of the revision graph.

          <p>If a branch name is ignored by means of the Lua hook
<code><a href="ignore_005fbranch.html#ignore_005fbranch">ignore_branch</a></code>, it is neither printed, nor can it be matched by a
pattern.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">               tag "monotree-0.1"
          revision [8a121346ce2920b6f85df68b3b620de96bd14a8d]
            signer [de84b575d5e47254393eba49dce9dc4db98ed42d]
          branches "net.venge.monotone.contrib" "net.venge.monotone.contrib.monotree"
          
               tag "monotree-0.2"
          revision [5d288b39b49613b0d9dca8ece6b9a42c3773f35b]
            signer [de84b575d5e47254393eba49dce9dc4db98ed42d]
          branches "net.venge.monotone.contrib.monotree"
          
               tag "monotree-0.3"
          revision [35cff8e8ba14155f5f7ddf7965073f514fd60f61]
            signer [de84b575d5e47254393eba49dce9dc4db98ed42d]
          branches "net.venge.monotone.contrib.monotree"
          
               tag "monotree-0.4"
          revision [f1afc520474f83c58262896ede027ef77226046e]
            signer [de84b575d5e47254393eba49dce9dc4db98ed42d]
          branches "net.venge.monotone.contrib.monotree"
     </pre>

          <br><dt><strong>Output format:</strong><dd>
There is one basic_io stanza for each tag.

          <p>Each stanza has exactly the following four entries:

               <dl>
<dt><samp><span class="option">'tag'</span></samp><dd>the value of the tag cert, i.e. the name of the tag

               <br><dt><samp><span class="option">'revision'</span></samp><dd>the hexadecimal id of the revision the tag is attached to

               <br><dt><samp><span class="option">'signer'</span></samp><dd>the hexadecimal value of the key used to sign the tag cert

               <br><dt><samp><span class="option">'branches'</span></samp><dd>a (possibly empty) list of all branches the tagged revision is on
</dl>

          <p>Stanzas are printed in arbitrary order.

          <br><dt><strong>Error conditions:</strong><dd>
A run-time exception occurs if an illegal branch pattern is
specified.

     </dl>

     <br><dt><samp><span class="command">mtn automate toposort [</span><var>rev...</var><span class="command">]</span></samp><a name="index-mtn-automate-toposort-_005b_0040var_007brev_002e_002e_002e_007d_005d-258"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
One or more revision IDs.

          <br><dt><strong>Added in:</strong><dd>
0.1

          <br><dt><strong>Purpose:</strong><dd>
Prints all arguments, topologically sorted.  I.e., if <var>rev1</var> is an
ancestor of <var>rev2</var>, then <var>rev1</var> will appear before <var>rev2</var> in
the output; if <var>rev2</var> is an ancestor of <var>rev1</var>, then <var>rev2</var>
will appear before <var>rev1</var> in the output; and if neither is an
ancestor of the other, then they may appear in either order.

          <p>If there are no arguments, prints nothing.

          <br><dt><strong>Sample output:</strong><dd>
<pre class="verbatim">          28ce076c69eadb9b1ca7bdf9d40ce95fe2f29b61
          75156724e0e2e3245838f356ec373c50fa469f1f
     </pre>

          <br><dt><strong>Output format:</strong><dd>
A list of revision IDs, in hexadecimal, each followed by a newline.

          <br><dt><strong>Error conditions:</strong><dd>
If any of the revisions do not exist, prints nothing to stdout, prints
an error message to stderr, and exits with status 1.

     </dl>

     <br><dt><samp><span class="command">mtn automate update</span></samp><a name="index-mtn-automate-update-259"></a><dd>
          <dl>
<dt><strong>Arguments:</strong><dd>
Same as <samp><span class="command"><a href="mtn-update.html#mtn-update">mtn update</a></span></samp>.

          <br><dt><strong>Added in:</strong><dd>
12.1

          <br><dt><strong>Purpose:</strong><dd>
Update the current workspace to the latest or given revision; see
<samp><span class="command"><a href="mtn-update.html#mtn-update">mtn update</a></span></samp>.

          <br><dt><strong>Sample output:</strong><dd>
Nothing on the main stream. The progress stream gives messages of the form:
<pre class="verbatim">          mtn: updating along branch 'mms.work_stephe'
          mtn: selected update target 233afb8c4832bf33d5f5734225164de5f5a6278c
          mtn: [left]  4a368a6b217c40b2ff3b12bb7cfa00987e0f191c
          mtn: [right] 233afb8c4832bf33d5f5734225164de5f5a6278c
          mtn: renaming build/windows_common.make to build/utf_common.make
          mtn: adding build/x86_gnu_linux_release
     </pre>

          <br><dt><strong>Output format:</strong><dd>
Free form, prefixed by &ldquo;mtn:&rdquo;.

          <br><dt><strong>Error conditions:</strong><dd>
see <samp><span class="command"><a href="mtn-update.html#mtn-update">mtn update</a></span></samp>.

     </dl>

</dl>

</body></html>
monotone-doc 1.0-3 / usr / share / doc / monotone / html / Automation.html
