monotone

monotone Mtn Source Tree

Root/mtn.1

1.TH "monotone" 1
2.SH NAME
3monotone \- distributed version control system
4.SH SYNOPSIS
5\fBmonotone\fP \fI[options] <command> [parameters]\fP
6.P
7Options, which affect global behavior or set default values, come
8first in the argument list. A single command must follow, indicating
9the operation to perform, followed by parameters which vary depending
10on the command.
11.SS Note
12This manpage is a summary of some of the features and commands of
13\fBmonotone\fP, but it is not the most detailed source of information
14available. For a complete discussion of the concepts and a tutorial on
15its use, please refer to the texinfo manual (via the \fBinfo
16monotone\fP command, or online).
17.SS Commands
18.TP
19\fBcomment\fP \fI<id>\fP
20Write a comment cert for a revision.
21.TP
22\fBapprove\fP \fI<id>\fP
23Make a "branch" cert approving of a revision's membership in a branch.
24.TP
25\fBdisapprove\fP \fI<id1>\fP
26Disapprove of a revision, committing the inverse changes as as a
27descendant of the disapproved revision.
28.TP
29\fBtag\fP \fI<id> <tagname>\fP
30Put a symbolic tag cert on a revision.
31.TP
32\fBtestresult\fP \fI<id> (0|1|true|false|yes|no|pass|fail)\fP
33Indicate a passing or failing test result on a revision.
34.TP
35\fBdiff \fI[--revision=<id1> [--revision=<id2>] ] [<pathname>...]\fP
36Show diffs between workspace and database.
37.TP
38\fBstatus \fI[<pathname>...]\fP
39Show status of workspace.
40.TP
41\fBlog\fP \fI[id] \fP
42Show historical log of revisions, starting from workspace
43base revision, or \fI[id]\fP if given.
44.TP
45\fBcert\fP \fI<id> <certname> [certval]\fP
46Create a custom cert for a revision. Reads cert value
47from stdin if no value given on command line.
48.TP
49\fBgenkey\fP \fI<keyid>\fP
50Generate an RSA key-pair and store it in the database.
51.TP
52\chkeypass\fP \fI<keyid>\fP
53Change passphrase of the private half of a key.
54.TP
55\fBlist certs\fP \fI<id>\fP
56List certs associated with revision.
57.TP
58\fBlist keys\fP \fI[partial-id]\fP
59List keys matching glob, or list all keys if no glob given.
60.TP
61\fBlist branches\fP
62List all branches.
63.TP
64\fBlist tags\fP
65List all tags.
66.TP
67\fBlist vars \fI[<domain>]\fP
68List all vars (possibly limited by domain).
69.TP
70\fBlist unknown \fI[<pathname...]\fP
71List files in workspace, but not in revision's manifest or
72work list.
73.TP
74\fBlist ignored \fI[<pathname...]\fP
75List files intentionally ignored due to the ignore_file hook.
76.TP
77\fBlist missing \fI[<pathname...]\fP
78List files in revision's manifest, but not in workspace.
79.TP
80\fBlist changed \fI[<pathname...]\fP
81List files in workspace that have changed compared to the base
82revision.
83.TP
84\fBfdata\fP \fI<id>\fP
85Write file data packet to stdout.
86.TP
87\fBfdelta\fP \fI<oldid> <newid>\fP
88Write file delta packet to stdout.
89.TP
90\fBmdata\fP \fI<id>\fP
91Write manifest data packet to stdout.
92.TP
93\fBmdelta\fP \fI<oldid> <newid>\fP
94Write manifest delta packet to stdout.
95.TP
96\fBcerts\fP \fI<id>\fP
97Write revision cert packets to stdout.
98.TP
99\fBrdata\fP \fI<id>\fP
100Write revision data packet to stdout.
101.TP
102\fBprivkey\fP \fI<id>\fP
103Write private key packet to stdout.
104.TP
105\fBpubkey\fP \fI<id>\fP
106Write public key packet to stdout.
107.TP
108\fBread\fP \fI[<file1> [<file2> [...]]]\fP
109Read packets from files or stdin.
110.TP
111\fBcvs_import\fP \fI<cvsroot>/<module>\fP
112Import all versions in CVS module. Reconstructs revisions and converts
113metadata to certificates. A private signing key must already exist in
114the database.
115.TP
116\fBrcs_import\fP \fI<rcsfile> ...\fP
117Import all file versions in RCS files. Does not reconstruct revisions
118across the entire tree. You do not want this command, it is for
119debugging; use cvs_import.
120.TP
121\fBcheckout\fP \fI[--revision=revision-id]\fP \fI[<directory>]\fP
122Check out revision from database.
123.TP
124\fBco\fP \fI[--revision=revision-id]\fP \fI[<directory>]\fP
125Check out revision from database; an alias for \fBcheckout\fP.
126.TP
127\fBcat\fP \fI(file|manifest) <id>\fP
128Write file or manifest from database to stdout.
129.TP
130\fBheads\fP
131Show unmerged heads of branch, or report when branch is merged.
132.TP
133\fBmerge\fP
134Merge unmerged heads of branch.
135.TP
136\fBadd\fP \fI<pathname> [...]\fP
137Add files to workspace. adding a file does not copy it into the database,
138merely adds it to the work list. You must \fBcommit\fP your changes in order
139to copy added files to the database.
140.TP
141\fBdrop\fP \fI<pathname> [...]\fP
142Drop files from workspace. Files are not deleted from workspace,
143merely noted as removals in the work list.
144.TP
145\fBrename\fP \fI<src> \fI<dst>\fP
146Rename files from \fI<src> \fP to \fI<dst> \fP in workspace.
147.TP
148\fBcommit\fP \fI[(--message=<log message>|--message-file=<file>)] [<pathname>...]\fP
149Commit workspace to database. Each commit has a changelog message
150associated with it. If --message is provided on the command line, it
151is used; if --message-file is provided, the content of the
152named file will be used as a commit message. If the filename is '-'
153the commit message will be read from standard input. Otherwise a log
154message editor will be invoked. If the file _MTN/log exists
155and is non-empty, its content is used to prefill the editor. You
156cannot specify both --message and --message-file at the same time, and
157if _MTN/log exists and is non-empty, you can cannot specify either of them
158at all.
159.TP
160\fBupdate\fP \fI[revision-id]\fP
161Update workspace.
162.TP
163\fBrefresh_inodeprints\fP
164Turn on inodeprints mode, and force a cache refresh.
165.TP
166\fBpush\fP \fI[<host> [<glob>]]\fP
167Push contents of \fI<glob>\fP to database on \fI<host>\fP.
168.TP
169\fBpull\fP \fI[<host> [<glob>]]\fP
170Push contents of \fI<glob>\fP from database on \fI<host>\fP.
171.TP
172\fBsync\fP \fI<host> <glob>\fP
173Sync contents of \fI<glob>\fP with database on \fI<host>\fP.
174.TP
175\fBserve\fP \fI[--pid-file=<path>] [--bind=[<host>][:<port>]] <glob> [--exclude=<exclude-glob>]\fP
176Serve contents of \fI<glob>\fP at network address \fI<host>\fP, on the
177port \fI<port>\fP. If \fI<port>\fP isn't given, 4691 is used. If a
178--pid-file option is provided on the command line, monotone will store
179the process id of the server in the specified file.
180.TP
181\fBset\fP \fI<domain> <name> <value>\fP
182Set the db var \fI<name>\fP in domain \fI<domain>\fP to value
183\fI<value>\fP.
184.TP
185\fBunset\fP \fI<domain> <name>\fP
186Delete any setting for db var \fI<name>\fP in domain \fI<domain>\fP.
187.TP
188\fBautomate\fP \fI(interface_version|heads|ancestors|attributes|parents|descendents|children|graph|erase_ancestors|toposort|ancestry_difference|leaves|inventory|stdio|certs|select)\fP
189Scripting interface.
190.TP
191\fBdb\fP \fI(init|info|version|dump|load|migrate|rebuild|execute|check)\fP
192Manipulate database state.
193.SH DESCRIPTION
194Monotone is a version control system, which allows you to keep old
195versions of files, as well as special \fImanifest files\fP which
196describe the location of files in a tree. Unlike other systems,
197versions in monotone are \fIidentified\fP by cryptographic hash, and
198operations are authenticated by individual users' evaluating
199cryptographic signatures on meta-data, rather than any central
200authority.
201
202Monotone keeps a collection of versions in a single-file relational
203database. It is essentially serverless, using network servers only as
204untrusted communication facilities. A monotone database is a regular
205file, which contains all the information needed to extract previous
206versions of files, verify signatures, merge and modify versions, and
207communicate with network servers.
208.SH OPTIONS
209.TP
210\fB--help\fP
211Print help message.
212.TP
213\fB--debug\fP
214Turn on debugging log on standard error stream. This is very
215verbose. Default is to be silent, unless an error occurs, in which
216case failure log is dumped.
217.TP
218\fB--quiet\fP
219Turn off normal progress messages.
220.TP
221\fB--dump=\fP\fI<file>\fP
222Dump debugging log to \fIfile\fP on failure.
223.TP
224\fB--nostd\fP
225Do not evaluate "standard" lua hooks compiled into \fBmonotone\fP.
226.TP
227\fB--norc\fP
228Do not load lua hooks from user's \fB~/.monotonerc\fP file.
229.TP
230\fB--rcfile=\fP\fI<file>\fP
231Load extra lua hooks from \fIfile\fP (may be given multiple times).
232.TP
233\fB--db=\fP\fI<file>\fP
234Use database in \fIfile\fP.
235.TP
236\fB--key=\fP\fI<keyid>\fP
237Use \fIkeyid\fP for operations which produce RSA signatures. Default
238is inferred from presence of unique private key in database. Can also
239be customized on a per-branch basis with hook function
240\fBget_branch_key(branchname)\fP.
241.TP
242\fB-k\fP \fI<keyid>\fP
243An alias for \fB--key=\fP\fI<keyid>\fP
244.TP
245\fB--branch=\fP\fI<branchname>\fP
246Use \fIbranchname\fP for operations on a branch. Default is inferred
247in operations on existing branches (commit, update, etc).
248.TP
249\fB-b\fP \fI<branchname>\fP
250An alias for \fB--branch=\fP\fI<branchname>\fP
251.TP
252\fB--ticket=\fP\fIdot|count|none\fP
253Use the given method to print tickers. The \fBcount\fP method prints
254the count for each ticker on one line, incrementing the numbers in
255place, while the \fBdot\fP method prints a continuous string of
256characters (like some programs provide a progress line of dots).
257\fBnone\fP prints nothing. The default is \fBcount\fP.
258.TP
259\fB--revision=\fP\fI<id>\fP
260Used to specify one or more revision ids to various commands.
261.TP
262\fB-r\fP \fI<id>\fP
263An alias for \fB--revision=\fP\fI<id>\fP
264.TP
265\fB--message=\fI<log message>\fP
266Use the given message as the changelog when committing a new revision
267rather than invoking the log message editor. Currently this option only
268applies to the commit command but it may also apply to the comment
269command in the future.
270This option is alternative to --message-file
271.TP
272\fB-m \fI<log message>\fP
273An alias for \fB--message=\fI<log message>\fP
274.TP
275\fB--message-file=\fI<message file>\fP
276Use the content of the given file as the changelog when committing a
277new revision rather than invoking the log message editor. If the passed filename is '-' the changelog message will be read from standard input.
278Currently this option only applies to the commit command but it may also apply
279to the comment command in the future.
280This option is alternative to --message.
281.TP
282\fB--author=\fI<author email>\fP
283Use the given author as the value of the "author" cert when committing
284a new revision, rather than the default author. Useful when
285committing a patch on behalf of someone else, or when importing
286history from another version control system.
287.TP
288\fB--date=\fI<date and time>\fP
289Use the given given date and time as value of the "date" cert when
290committing a new revision, rather than the current time. Useful when
291importing history from another version control system.
292.TP
293\fB--root=\fI<root dir>\fP
294Stop the search for a workspace (containing the _MTN directory)
295at the specified root directory rather than at the physical root of the
296filesystem.
297.TP
298\fB--xargs=\fI<file>\fP
299Inject the contents of the file in place among the command line
300arguments. This may be useful in case the command line would
301otherwise become too long for your system. This option can be used
302more than once if needed.
303.TP
304\fB-@ \fI<file>\fP
305An alias for \fB--xargs=\fI<file>\fP
306.TP
307
308.SH ENVIRONMENT
309.TP
310\fBEDITOR\fP
311Used to edit comments, log messages, etc.
312.TP
313\fBVISUAL\fP
314Used in preference to \fBEDITOR\fP, if set.
315.SH FILES
316.TP
317\fB$HOME/.monotonerc\fP
318A lua script, used as a customization file.
319.SH NOTES
320.IP \(bu
321Command line options override environment variables and
322settings in lua scripts (such as \fB.monotonerc\fP)
323.SH "SEE ALSO"
324\fBinfo monotone\fP
325.SH BUGS
326see http://savannah.nongnu.org/bugs/?group=monotone
327.SH AUTHOR
328graydon hoare <graydon@pobox.com>

Archive Download this file

Branches

Tags

Quick Links:     www.monotone.ca    -     Downloads    -     Documentation    -     Wiki    -     Code Forge    -     Build Status