utils/docs/pcb_backannotate.1.in

   1 .TH pcb_backannotate 1 "@DATE@" "gEDA Project" @VERSION@
   2
   3 .SH NAME
   4 .B pcb_backannotate
   5 \- backannotates changes from a PCB annotation file to schematic
   6
   7 .SH SYNOPSIS
   8 .B pcb_backannotate \-h\||\-\-help
   9
  10 .B pcb_backannotate \-V\||\-\-version
  11
  12 .B pcb_backannotate
  13 [options]
  14 .I ecofile.eco infile1.sch [infile2.sch ...]
  15
  16
  17 .SH DESCRIPTION
  18
  19 The
  20 .I pcb_backannotate
  21 program reads an engineering change order (ECO) file generated by the PCB program
  22 and backannotates the requested changes to a gschem schematic or schematics.
  23 Refer to the PCB manual for a complete description of the ECO file format.
  24
  25 .SH OPTIONS
  26 .TP
  27 \-h, \-\-help
  28 prints help message and exits
  29 .TP
  30 \-n, \-\-nocopy
  31 Leave the modified schematic files in new files
  32 whose names are generated by appending
  33 .I ".new"
  34 to the
  35 original file names.  The default is to overwrite the original.
  36 .TP
  37 \-v, \-\-verbose
  38 operate verbosely
  39 .TP
  40 \-V, \-\-version
  41 prints version information and exits
  42
  43 .SH EXIT STATUS
  44 .I pcb_backannotate
  45 will return
  46 .B 0
  47 if all files processed successfully,
  48 .B non-zero
  49 if the command did not complete successfully.
  50
  51 .SH BUGS
  52 Rather than parsing and processing schematic files directly, this utility should
  53 be rewritten using the gEDA scheme API.  This would take advantage of the existing
  54 parsers for the schematic files.
  55
  56 .SH SEE ALSO
  57 gnetlist(1), gschem(1), pcb(1)
  58
  59
  60