/usr/share/doc/monotone/html/Global-Options.html

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

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


</head>

<body lang="en">
<a name="Global-Options"></a>
<div class="header">
<p>
Next: <a href="Common-Options.html#Common-Options" accesskey="n" rel="next">Common Options</a>, Previous: <a href="Global-and-Common-Options.html#Global-and-Common-Options" accesskey="p" rel="prev">Global and Common Options</a>, Up: <a href="Global-and-Common-Options.html#Global-and-Common-Options" accesskey="u" rel="up">Global and Common Options</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="General-Index.html#General-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Global-Options-1"></a>
<h4 class="subsection">4.1.1 Global Options</h4>
<p>These options are available on all commands.
</p>
<dl compact="compact">
<dd><a name="g_t_002d_002dconfdir"></a></dd>
<dt><code>--confdir &lt;arg&gt;</code>
<a name="index-_002d_002dconfdir-_003carg_003e"></a>
</dt>
<dd><p>Set the location of the configuration directory (default
<samp>$HOME/.monotone</samp> on Unix and Cygwin, <samp>%APPDATA%\monotone%</samp> on
Windows MinGW). In this manual, references to these specific directories are
actually references to the directory specified by
<samp>--confdir</samp>.
</p>
<p>The configuration directory is where monotone finds:
</p>
<dl compact="compact">
<dt><code>keys</code></dt>
<dd><p>in <samp>confdir/keys</samp>; see <a href="Certificates.html#Certificates">Certificates</a>, <a href="Generating-Keys.html#Generating-Keys">Generating Keys</a>. The location of the keys directory can be overridden separately
with the <samp>--keydir</samp> option.
</p>
</dd>
<dt><code>monotonerc</code></dt>
<dd><p>which is a per-user configuration file containing Lua code
(see <a href="Lua-Reference.html#rcfiles">rcfiles</a>) that is run each time monotone starts up.
</p>
</dd>
<dt><code>default database</code></dt>
<dd><p>In file <samp>confdir/databases/default.mtn</samp>; see <a href="Managed-Databases.html#Managed-Databases">Managed Databases</a>.
</p>
</dd>
</dl>

<p>In addition, monotone may write a dump file to the configuration
directory when it fails (if it can&rsquo;t write to <samp>_MTN</samp> in a
workspace).
</p>
</dd>
<dt><code>--date-format &lt;arg&gt;</code>
<a name="index-_002d_002ddate_002dformat-_003carg_003e"></a>
</dt>
<dd><p><code>strftime(3)</code> format specification for printing dates. The
default format is given by the <code><a href="User-Defaults.html#get_005fdate_005fformat_005fspec">get_date_format_spec</a></code> hook;
the default hook returns <code>%x</code> for dates, <code>%X</code> for times,
<code>%x %X</code> for both.
</p>
</dd>
<dt><code>--db &lt;arg&gt;</code>
<a name="index-_002d_002ddb-_003carg_003e"></a>
</dt>
<dd><p>Set the database to use; defaults to the database specified in the
current workspace (stored in <samp>_MTN/options</samp>; see <a href="Storage-and-workflow.html#Storage-and-workflow">Storage and workflow</a>), or to nothing if not in a workspace. However, some
commands default to a <a href="Managed-Databases.html#Managed-Databases">Managed Databases</a>; that is specified in
those commands.
</p>
<p>An argument of <code>:memory:</code> specifies a memory-only database; any
changes are not saved to a file. One use for this is on the client
side of a remote automate connection to the server, if you are
executing commands that don&rsquo;t actually need a local database but the
automate command requires one.
</p>
</dd>
<dt><code>--dump &lt;arg&gt;</code>
<a name="index-_002d_002ddump-_003carg_003e"></a>
</dt>
<dd><p>File to dump debugging log to, on failure; default
<samp>confdir/dump</samp> if not in a workspace, <samp>_MTN/debug</samp> if in a
workspace.
</p>
</dd>
<dt><code>--help</code>
<a name="index-_002d_002dhelp"></a>
</dt>
<dd><p>Display help information. This is the same as the <code>mtn help</code>
command, but note that it can be placed at the end of a command line,
while <code>mtn help</code> must be the first non-option on the command line.
</p>
</dd>
<dt><code>--ignore-suspend-certs</code>
<a name="index-_002d_002dignore_002dsuspend_002dcerts"></a>
</dt>
<dt><code>--no-ignore-suspend-certs</code>
<a name="index-_002d_002dno_002dignore_002dsuspend_002dcerts"></a>
</dt>
<dd><p>Do not ignore revisions marked as suspended; see the <code>mtn
suspend</code> command.
</p>
<a name="g_t_002d_002dkey"></a></dd>
<dt><code>--key &lt;arg&gt;</code>
<a name="index-_002d_002dkey-_003carg_003e"></a>
</dt>
<dt><code>--use-default-key</code>
<a name="index-_002d_002duse_002ddefault_002dkey"></a>
</dt>
<dd><p>Set the key for signatures or network authentication, using either the
key name or the key hash (see <a href="Generating-Keys.html#Generating-Keys">Generating Keys</a>).
</p>
<p>monotone determines the key to use as follows:
</p>
<ol>
<li> If <samp>--key</samp> is given, that is the key.

</li><li> If <var>key</var> is given in <samp>_MTN/options</samp>, that is the key.

<p>Each time <samp>--key</samp> is given, it will be stored in
<samp>_MTN/options</samp> for future use.
</p>
</li><li> For a non-netsync command, the Lua hook <code><a href="User-Defaults.html#get_005fbranch_005fkey">get_branch_key</a></code> is
called.

<p>For a client-side netsync command, the Lua hook
<code><a href="User-Defaults.html#get_005fnetsync_005fclient_005fkey">get_netsync_client_key</a></code> is called.
</p>
<p>For a command that starts a monotone server, the Lua hook
<code><a href="User-Defaults.html#get_005fnetsync_005fserver_005fkey">get_netsync_server_key</a></code> is used.
</p>
<p>If any of the aforementioned hooks returns non-nil, the return value
is the name of the key.
</p>
</li><li> If there is only one key in the keydir, that is the key.

</li><li> Otherwise there is no key; an error occurs.

</li></ol>


</dd>
<dt><code>--keydir &lt;arg&gt;</code>
<a name="index-_002d_002dkeydir-_003carg_003e"></a>
</dt>
<dd><p>Set the key directory (where the &ldquo;key store&rdquo; is located); default is
<samp>confir/keys</samp>.
</p>
</dd>
<dt><code>--log &lt;arg&gt;</code>
<a name="index-_002d_002dlog-_003carg_003e"></a>
</dt>
<dd><p>Specifiy a file to which the log (consisting of all debug,
informational, and warning messages) is written; default is the
<code>stderr</code> process output.
</p>
</dd>
<dt><code>--no-builtin-rcfile</code>
<a name="index-_002d_002dno_002dbuiltin_002drcfile"></a>
</dt>
<dt><code>--builtin-rcfile</code>
<a name="index-_002d_002dbuiltin_002drcfile"></a>
</dt>
<dd><p>Do not load the built-in rcfile with the default hooks. This means
all hooks will have null definitions (unless overridden by other
<a href="Lua-Reference.html#rcfiles">rcfiles</a>).
</p>
</dd>
<dt><code>--no-default-confdir</code>
<a name="index-_002d_002dno_002ddefault_002dconfdir"></a>
</dt>
<dt><code>--allow-default-confdir</code>
<a name="index-_002d_002dallow_002ddefault_002dconfdir"></a>
</dt>
<dd><p>Don&rsquo;t use a default confdir; <samp>--confdir</samp> must be specified if
a configuration file is needed.
</p>
</dd>
<dt><code>--no-format-dates</code>
<a name="index-_002d_002dno_002dformat_002ddates"></a>
</dt>
<dd><p>Don&rsquo;t use the format provided by a previous <samp>--date-format</samp>,
nor the format returned by <code><a href="User-Defaults.html#get_005fdate_005fformat_005fspec">get_date_format_spec</a></code>; instead,
print dates in the format &ldquo;yyyy-mm-ddThh:mm:ss&rdquo;.
</p>
</dd>
<dt><code>--[no-]standard-rcfiles</code>
<a name="index-_002d_002d_005bno_002d_005dstandard_002drcfiles"></a>
</dt>
<dd><p>Do not load the standard rcfiles, which are
<samp>$HOME/.monotone/monotonerc</samp> on Unix or
<samp>%APPDATA%\monotone\monotonerc</samp> on Windows, and
<samp>_MTN/monotonerc</samp> in the current workspace. See <a href="Lua-Reference.html#rcfiles">rcfiles</a>.
</p>
</dd>
<dt><code>--no-workspace</code>
<a name="index-_002d_002dno_002dworkspace"></a>
</dt>
<dt><code>--allow-workspace</code>
<a name="index-_002d_002dallow_002dworkspace"></a>
</dt>
<dd><p>Don&rsquo;t look for a workspace; this means options that normally get their
default values from the workspace will not have those default values.
</p>
</dd>
<dt><code>--non-interactive</code>
<a name="index-_002d_002dnon_002dinteractive"></a>
</dt>
<dt><code>--interactive</code>
<a name="index-_002d_002dinteractive"></a>
</dt>
<dd><p>Do not prompt the user for input; fail instead. For example, don&rsquo;t
prompt for a key passphrase, or when doing a merge, do not start the
external merger to resolve a conflict.
</p>
</dd>
<dt><code>--quiet</code>
<a name="index-_002d_002dquiet"></a>
</dt>
<dt><code>--verbose</code>
<a name="index-_002d_002dverbose"></a>
</dt>
<dd><p>Decrease or increase verbosity. There are four levels of verbosity;
debug, information, warning, and none. The default is information.
</p>
</dd>
<dt><code>--rcfile &lt;arg&gt;</code>
<a name="index-_002d_002drcfile-_003carg_003e"></a>
</dt>
<dd><p>Specify an extra rcfile to load. See <a href="Lua-Reference.html#rcfiles">rcfiles</a>.
</p>
</dd>
<dt><code>--clear-rcfiles</code>
<a name="index-_002d_002dclear_002drcfiles"></a>
</dt>
<dd><p>Cancel all previous <samp>--rcfile</samp> options (standard rcfiles are
still loaded). See <a href="Lua-Reference.html#rcfiles">rcfiles</a>.
</p>
</dd>
<dt><code>--root &lt;arg&gt;</code>
<a name="index-_002d_002droot-_003carg_003e"></a>
</dt>
<dd><p>Limit the search for a workspace to the specified root directory
</p>
</dd>
<dt><code>--ssh-sign &lt;arg&gt;</code>
<a name="index-_002d_002dssh_002dsign-_003carg_003e"></a>
</dt>
<dd><p>Controls use of ssh-agent. Valid arguments are: &rsquo;yes&rsquo; to use ssh-agent
to make signatures if possible, &rsquo;no&rsquo; to force use of monotone&rsquo;s
internal code, &rsquo;only&rsquo; to force use of ssh-agent, &rsquo;check&rsquo; to sign with
both and compare.
</p>
</dd>
<dt><code>--ticker &lt;arg&gt;</code>
<a name="index-_002d_002dticker-_003carg_003e"></a>
</dt>
<dd><p>Set ticker style; one of &rsquo;count&rsquo;, &rsquo;dot&rsquo;, or &rsquo;none&rsquo;
</p>
</dd>
<dt><code>--timestamps</code>
<a name="index-_002d_002dtimestamps"></a>
</dt>
<dd><p>Show timestamps in front of error, warning, and progress messages.
</p>
</dd>
<dt><code>--version</code>
<a name="index-_002d_002dversion"></a>
</dt>
<dd><p>Print version number, then exit; same as <code>mtn version</code>.
</p>
</dd>
<dt><code>--xargs &lt;arg&gt;</code>
<a name="index-_002d_002dxargs-_003carg_003e"></a>
</dt>
<dt><code>-@ &lt;arg&gt;</code>
<a name="index-_002d_0040-_003carg_003e"></a>
</dt>
<dd><p>Insert command line arguments taken from the given file. A &rsquo;-&rsquo;
can be used to read the arguments from standard input.
e.g. <code>--xargs=-</code>
</p></dd>
</dl>

<hr>
<div class="header">
<p>
Next: <a href="Common-Options.html#Common-Options" accesskey="n" rel="next">Common Options</a>, Previous: <a href="Global-and-Common-Options.html#Global-and-Common-Options" accesskey="p" rel="prev">Global and Common Options</a>, Up: <a href="Global-and-Common-Options.html#Global-and-Common-Options" accesskey="u" rel="up">Global and Common Options</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="General-Index.html#General-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
monotone-doc 1.1-7 / usr / share / doc / monotone / html / Global-Options.html
