utils/docs/README.grenum

   1 This  is  grenum,  an advanced refdes renumber utility for gEDA's
   2 gschem.
   3
   4
   5 INTRODUCTION
   6
   7 This program renumbers the refdes  definitions  read  from  input
   8 file.
   9
  10 GOALS
  11
  12 There  is  another  script  called  refdes_renum comes with geda-
  13 utyls, but it does not care about slotted elements.  grenum  will
  14 not  renumber all refdeses, only, if a "?" is found in the refdes
  15 definition. After the first run, you have to edit the  refdes  of
  16 multi  slotted  elements, but after it, they won't be renumbered.
  17 Moreover, the text after the refdes numbers are ignored. This  is
  18 useful,  if  you  want  to have e.g. IC3a, IC3b components on the
  19 schematic. Unfortunately, the next layer, the gsch2pcb  does  not
  20 ignore this, and will create a new component (am I right?).
  21
  22 As  it was mentioned grenum does not renumber refdeses which were
  23 already renumbered. However, it detects gaps between  the  refdes
  24 numbers.  For  example, if you have IC3 and IC6, it'll start num-
  25 bering new components from IC1 to IC2, and IC4-IC5 and after IC7.
  26 This  is essential, because gsch2pcb does not care about refdeses
  27 (which is good), and if  the  refdeses  gets  totally  renumbered
  28 (gaps filled totally), then all your components will shifted, and
  29 you have to move everything on your board.
  30
  31 COMPILATION
  32
  33 This is very very tiny program, needs no external libraries, just
  34 a  working C compiler. If your C compiler is not gcc, you have to
  35 edit the Makefile in the src directory.
  36
  37 To untar the package, issue the command
  38
  39 $ tar -jxvf grenum.tar.bz2
  40
  41 Note that you need bunzip2 and the tar utility.
  42
  43 To compile the code cd to the grenum directory and make the  exe-
  44 cutable
  45
  46 $ cd grenum $ make
  47
  48 To install the compiled executable (as root) issue
  49
  50 # make install
  51
  52 USAGE
  53
  54 To renumber your gschem file issue
  55
  56 $ grenum yourfile.sch
  57
  58 for  more  information,  see the manpage, and read the documenta-
  59 tion, which you can't since I had no time  write  it.  But  it'll
  60 come... :-)
  61
  62 CONTACT
  63
  64 Please send comments to
  65
  66         - levente.kovacs@interware.hu