-*- mode:org -*-
This is Org Merge Driver, a program for merging changes to Org mode files.
This project is currently being developed under Google Summer of Code 2012 for the Gnu organization.
The source code may be obtained from the GIT repository hosted at Orgmode.org.
git clone git://orgmode.org/org-merge-driver.git
Compiling this program requires that you have autotools installed. To compile this program, you should only have to run:
autoreconf --install && ./configure && make
If this fails because of missing dependencies, please see dependencies below.
[merge "merge-orgmode"] name = Org Mode merge driver driver = /usr/local/bin/org-merge-driver -- %O %A %B %A
(See "man 5 gitattributes" for more info.)
external_merge = org-merge-driver -- %b %T %o %T
bzr extmerge --all --verbose
[merge-patterns] ,**.org = org-merge-driver
[merge-tools] org-merge-driver.executable = /usr/local/bin/org-merge-driver org-merge-driver.args = -- $base $local $other $local
See Configuration files for Mercurial, section merge-tools for reference.
This program currently supports the following options:
|-m,||--rmargin=COLUMN||Set the right margin of headings|
|-N,||--notabs||Use only spaces in the output|
|-p,||--priority=PRIORITY||Specify an accepted prority|
|-t,||--todo=STATE||Specify an accepted todo state.|
|-T,||--usetabs||Use tabs in the output, unused.|
|-W,||--tabwidth=WIDTH||The width of tabs in spaces, unused|
|-?,||--help||Give this help list|
|--usage||Give a short usage message|
|-V,||--version||Print program version|
If you have defined TODO states, you can describe them with this command. The defaults are set to "TODO" and "DONE". Declaring a single todo state causes the default set of todo states to be discarded. Because of this, you must declare all TODO states used.
At this time, Todo states can only be configured on the command line.
org-merge-driver -tDONE --todo=TODO
If you have defined more priority states system-wide, you can describe them with this command. The defaults are set to 'A', 'B', and 'C'. You must declare all priority states used (all defaults are immediately overridden). Currently, priority cookies may only be a single ASCII character.
org-merge-driver -pA -pB --priority=C
Org-merge-driver will attempt to minimize reformatting, but it is sometimes necessary for org-merge-driver to realign text on the right margin of the text. This can happen after merging lists of heading TAGS.
You can set the preferred right margin value (in spaces) with the =--rmargin== command. If the margin is not large enough to fit a line of text, it will extend past the margin. The default margin value is 77 spaces.
To perform a merge, org-merge-driver requires three files -- your copy of a file, a remotely updated file, and a common ancestor file. These are given to org-merge-driver in the order ancestor, local, remote.
To ensure that the file names are not confused with command line options, you can seperate them from the rest of the arguments with =--=.
By default, org-merge-driver prints the merged file to stdout. To have the output printed to a file, specify a fourth file on the command line.
org-merge-driver -- ancestor.org local-update.org remote-update.org output.org
To compile org-merge-driver, you may need: Gnulib, Flex (not lex) and GNU Autotools installed. Install Flex and autotools using your desired package manager. To obtain gnulib follow the instructions below.
You must obtain Gnulib by it's source code, there is no binary distribution. Through git or cvs:
git clone git://git.savannah.gnu.org/gnulib.git # or cvs -d :pserver:firstname.lastname@example.org:/gnulib.git co -d gnulib HEAD
cd $(top_srcdir) /PATH/TO/GNULIB/gnulib-tool --add-import
To compile, run:
autoreconf -i ./configure && make