README

   1 BlackBox diffutils
   2 --------------------
   3
   4 Clone of diff and diff3 utilites from *nix for BlackBox and its binary Compound Document format.
   5
   6
   7 Commands
   8 --------------------
   9
  10 To use tools within Blackbox just compile DiffBase and DiffUtils.
  11
  12 DiffUtils.Compare (guard TextCmds.FocusGuard)
  13
  14         Compare texts from two windows.
  15         You can directly replace DevSearch.Compare with DiffUtils.Compare in Dev/Rsrc/Menus.odc.
  16
  17
  18 ^Q DiffUtils.CompareThis <old> <new> [">" <outfile>]
  19
  20         Compare two files and produce patch in unified diff format.
  21
  22
  23 ^Q DiffUtils.MergeThis <my> <old> <your> [">" <outfile>]
  24
  25         Read three files and do three-way merge like diff3.
  26
  27
  28 Dedicated tool
  29 --------------------
  30
  31 You can read, create diffs and merge documents from command line using odctool.
  32 To build it, open DiffMain and execute commanders at the end of document.
  33 Call `odctool help` to learn how to use it.
  34
  35
  36 Integration with git
  37 --------------------
  38
  39 1. Compile odctool.
  40
  41 2. Create script odctool-gitdiff:
  42
  43         #! /bin/sh
  44         odctool diff -C -p "$1" "$2" "$5"
  45
  46 3. Add to .git/config:
  47
  48         [merge "odctool"]
  49                 name = BlackBox Compound Document merge driver
  50                 driver = odctool merge -p %P -o %A %A %O %B
  51         [diff "odctool"]
  52                 name = BlackBox Compound Document diff driver
  53                 command = odctool-gitdiff
  54
  55 4. Add to .git/info/attributes:
  56
  57         *.odc merge=odctool diff=odctool
  58
  59
  60 5. Optionally you can ignore some BlackBox related files if add to .git/info/exclude:
  61
  62         *.ocf
  63         *.osf
  64         odc[0-9][0-9][0-9][0-9][0-9]
  65
  66
  67 Now you can see diffs using `git diff' and resolve conflicts without converting odc to text.
  68
  69
  70 Integration with ranger
  71 -----------------------
  72
  73 1. To preview documents add to $HOME/.config/ranger/scope.sh:
  74
  75         handle_extension() {
  76                 case "${FILE_EXTENSION_LOWER}" in
  77
  78                         ...
  79
  80                         # BlackBox Compound Document
  81                         odc)
  82                                 odctool -C cat "${FILE_PATH}" && exit 5
  83                                 exit 1;;
  84                 esac
  85         }
  86
  87 2. To open/read documents add to $HOME/.config/ranger/rifle.conf:
  88
  89         ext odc, has odctool, terminal, file = odctool -C cat "$1" | less --tabs=2 -S
  90
  91
  92 Current state
  93 --------------------
  94
  95 This is NOT final version of subsustem Diff and odctool. It is NOT well tested, you are warned!
  96 Also, program and user interfaces are not stable yet, so it can be changed in future.