monotone

monotone Mtn Source Tree

Root/mtn.1

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

Archive Download this file

Branches

Tags

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