DEADSOFTWARE

Added dedicated utility - odctool
[bbdiff.git] / README
1 BlackBox diffutils
2 --------------------
4 Clone of diff, patch and diff3 utilites from *nix for BlackBox and its binary Compound Document format.
7 Commands
8 --------------------
10 To use tools within Blackbox just compile DevDiff.
12 DevDiff.Compare (guard TextCmds.FocusGuard)
14 Compare texts from two windows.
15 Can directly replace DevSearch.Compare in Dev/Rsrc/Menus.odc.
18 ^Q DevDiff.CompareThis <oldfile> <newfile> [">" <outfile>]
20 Compare two files and produce patch in unified diff format.
23 ^Q DevDiff.ApplyPatch <patchfile>
25 Read unified diff format and apply changes from it.
28 ^Q DevDiff.MergeThis <my> <old> <your> [">" <outfile>]
30 Read three files and do three-way merge like.
33 Dedicated tool
34 --------------------
36 You can read, create diffs and merge documents from command line using odctool.
37 To build open OdctoolMain and execute commanders at the end of document.
38 Call `odctoll.exe help` to learn how to use it.
40 Warning: It tested only with wine and NOT tested on windows or native linux.
43 Integration with GIT
44 --------------------
46 It is possible to integrate three-way merge with git.
48 1. Open .git/config and add this lines:
50 [merge "odctool"]
51 name = BlackBox Compound Document merge driver
52 driver = /full/path/to/odctool merge -P %P %A %O %B %A
54 2. Open/create .git/info/attributes and add this line:
56 *.odc merge=odctool
58 Now when conflict occurs, it marked like diff3 directly in odc file.
59 Checked not only text, but also views and formatting.
62 Current state
63 --------------------
65 This is NOT final version of module DevDiff and Odctool. It is NOT well tested, you are warned!
66 Also, program and user interfaces can be changed later.
67 Todo list see at the and of sources and build tools.