utils/docs/schdiff.1.in

   1 .TH schdiff 1 "@DATE@" "gEDA Project" @VERSION@
   2
   3 .SH NAME
   4 .B schdiff
   5 \- Graphical diff tool for schematics
   6
   7 .SH SYNOPSIS
   8 .B schdiff
   9 .I infile1.sch infile2.sch
  10
  11
  12 .SH DESCRIPTION
  13
  14 The
  15 .B schdiff
  16 program will use
  17 .B ImageMagick(1)
  18 to display a graphical diff of two gschem schematic files.  It's most useful
  19 when combined with a revision control system so it can compare two revisions of
  20 the same file, review changes, etc.  However, it is limited in that it can only
  21 compare two files at a time; it cannot diff entire directories nor can it diff
  22 an entire revision (unless that revision affected only one file).  It can
  23 easily be configured to work with most revision control systems.  Here are
  24 instructions for three:
  25
  26 .B git:
  27 Use the
  28 .B difftool
  29 command exactly as you would use
  30 .B diff
  31 , but supply the
  32 .B \-x schdiff
  33 option.
  34
  35 .B mercurial:
  36 Use the
  37 .B schdiff
  38 command exactly as you would use
  39 .B diff
  40 , but add the following lines to your .hgrc:
  41
  42 .RS
  43   [extensions]
  44   hgext.extdiff =
  45   [extdiff]
  46   cmd.schdiff = schdiff
  47 .RE
  48
  49 .B subversion:
  50 Use the
  51 .B diff
  52 command like normal, but supply the
  53 .B --diff-cmd schdiff
  54 option.
  55
  56 .SH EXAMPLES
  57
  58 .TP
  59 Use git to view the changes to a file between two revisions
  60 git difftool \-x schdiff 182110f690c51eb53ea1799fd022e87322d742e3 039e012397f2638d1577dd7c80fb862a5503dbfd cpu.sch
  61
  62 .TP
  63 Use mercurial to see all the changes since a specific revision
  64 hg schdiff \-r 8442880f9835 cpld.sch
  65
  66 .TP
  67 Use subversion to review a specific revision
  68 svn diff \-\-diff-cmd schdiff \-c 49 power.sch
  69
  70 .SH BUGS
  71
  72 If you find one, please report it at https://bugs.launchpad.net/geda
  73
  74 .SH AUTHOR
  75
  76 Alan Somers
  77
  78 .SH SEE ALSO
  79
  80 .B composite(1), display(1), git(1), gschem(1), hg(1), svn(1)