utils/docs/refdes_renum.1.in

   1 .TH refdes_renum 1 "@DATE@" "gEDA Project" @VERSION@
   2
   3 .SH NAME
   4 refdes_renum \- gEDA/gaf refdes renumbering utility
   5 .SH SYNOPSIS
   6 .B refdes_renum [\-\-nocopy] [\-\-pgskip [
   7 .I number
   8 .B ] ]
   9 .I file1
  10 .B ...
  11 .PP
  12 .B refdes_renum
  13 .BR \-\-help | \-h
  14 .PP
  15 .B refdes_renum \-\-version
  16 .SH DESCRIPTION
  17 .B refdes_renum
  18 reads a gschem schematic file or files and renumbers all reference
  19 designators.  The reference designators are numbered starting with 1 and the
  20 old schematic file is replaced by the modified schematic file.
  21 .SH OPTIONS
  22 .TP
  23 .BR \-\-help ", " \-h
  24 Display a help message.
  25 .TP
  26 .B \-\-nocopy
  27 If given, this flag leaves the modified files in new files
  28 whose names are generated by appending a `.renum' to the
  29 original file names.  The default is to overwrite the original.
  30 .TP
  31 .B \-\-pgskip
  32 When this flag is used, components on the first schematic sheet
  33 are numbered starting with 101.  On the second sheet, they start
  34 with 201, etc  Specifying a value gives the step between pages.
  35 For example \-\-pgskip 10 will start with 11, 21, 31, etc.
  36 .TP
  37 .B \-\-gentle
  38 This flag tells refdes_renum to leave any refdeses
  39 alone if they already have numbers.  Use this option to number
  40 new components in a schematic which has already been numbered.
  41 Note that \-\-gentle is set by default!
  42 .TP
  43 .B \-\-force
  44 Set this flag to renumber all refdeses, whether they are already
  45 numbered or not.
  46 .TP
  47 .B \-\-verbose
  48 Enables verbose output.
  49 .TP
  50 .B \-\-version
  51 Shows the version of this program.
  52 .SH RETURN CODES
  53 .B refdes_renum
  54 returns the following codes to the shell upon completion:
  55 .TP
  56 0
  57 Program ran successfully.
  58 .TP
  59 1
  60 Error opening or reading input file.
  61 .TP
  62 2
  63 Error opening or writing output file.
  64 .TP
  65 3
  66 Too many components for \-\-pgskip setting.
  67 .TP
  68 4
  69 Internal error (program bug encountered).
  70 .SH EXAMPLES
  71 To renumber the reference designators in a single page schematic mysch.sch:
  72 .IP
  73 refdes_renum mysch.sch
  74 .PP
  75 To renumber the reference designators in schematic pages pg1.sch, pg2.sch and
  76 pg3.sch, with the reference designators on pg1.sch beginning at 101, the
  77 designators on pg2.sch beginning at 201, and the designators on pg3.sch
  78 beginning at 301:
  79 .IP
  80 refdes_renum \-\-pgskip pg1.sch pg2.sch pg3.sch
  81 .SH AUTHOR
  82 Dan McMahill <danmcmahill@netbsd.org>
  83 .SH SEE ALSO
  84 .BR grenum (1)
  85 .SH COPYRIGHT
  86 .nf
  87 Copyright \(co 1999-@YEAR@ gEDA Contributors.  License GPLv2+: GNU GPL
  88 version 2 or later.  Please see the `COPYING' file included with this
  89 program for full details.
  90 .PP
  91 This is free software: you are free to change and redistribute it.
  92 There is NO WARRANTY, to the extent permitted by law.