utils/README

   1 gEDA
   2
   3 GPL Electronic Design Automation
   4 ------------------------------------------------------------------------------
   5
   6 README for utilities
   7
   8
   9 - Installation
  10
  11    See the toplevel INSTALL for more instructions on general install
  12    instructions
  13
  14
  15
  16 - Utilities
  17
  18    gmk_sym
  19    Updated by Matthew Ettus, matt@ettus.com
  20
  21         Jerry's instructions below still work.  There are
  22         additional features for the first input line.
  23         See TL16C554AFN.txt for an example of the extended input
  24
  25    Written by: Jerry O'Keefe, jerryok@pacbell.net
  26
  27         This is a simple utility to convert comma separated
  28         descriptions into rectangular gschem symbols.  It should
  29         be useful for easily creating memory, processors or
  30         connector style parts. All pin positions are in normal pin
  31         spacing (300).  Pin styles supported are line, dot-line,
  32         and clock line. Pins can be placed on all sides of the
  33         symbol's box. For example to place a dot-line style pin of
  34         name INPUT at the normal pin 1 position of a IC would be:
  35
  36                 INPUT,1,dot,L,1
  37
  38         The size of the symbol's box is also in pin spacings. So
  39         a symbol with 6 inputs and 6 outputs would typically
  40         require a size of: 3 for width and 7 for height.
  41
  42         See the included 7474.txt and 8031.txt as example files.
  43
  44         This utility is not strong on error checking and slotting
  45         is not supported.
  46
  47         gmk_sym typical use:
  48
  49                 ./gmk_sym 7474.txt >7474-3.sym
  50
  51         gmk_sym is installed when make install is run.
  52
  53
  54
  55    smash_megafile
  56    Written by: Mike Jarabek, mjarabek@istop.com
  57
  58         smash_megafile is a C program that will take a viewlogic
  59         megafile and extract the contents into a directory of the same
  60         name, with one file representing each element in the library.
  61         This program should compile without any problems for anyone.
  62         This program cannot create megafiles, it can just extract all
  63         the contents. (Useful for say, extracting all the symbols from
  64         a library...)  Be aware that megafiles from PC versions of
  65         ViewDraw use PC end of line terminations, it may be necessary
  66         to use a program like dos2unix to convert the resulting text
  67         files... before doing useful things with them.
  68
  69         smash_megafile typical use:
  70
  71                  ./smash_megafile megafile
  72
  73         where megafile is the name of a viewlogic megafile whithout
  74         any extensions.  The file megafile.lib and megafile.tbl must
  75         exist in the same directory
  76
  77         smash_megafile is installed when make install is run.
  78
  79
  80    convert_sym
  81    Written by: Mike Jarabek, mjarabek@istop.com
  82
  83         convert_sym converts Viewlogic schematics and symbols into
  84         geda format.
  85
  86         This utility should be considered a work in progress.
  87         Be warned, the program has a few limitations:
  88
  89                 1) Some text spacing may be lost due to the way that I
  90                    extract the text from the viewlogic records
  91
  92                 2) Arcs in viewlogic are stored implicitly as a record
  93                    where the arc passes through three points,
  94                    the conversion from this format to geda's
  95                    center/radius/start/stop notation is not exact,
  96                    so some arcs may not render well.
  97
  98                 3) Bubbles are drawn on pins that are negated.  I believe
  99                    the code is correct, but have not tried all the
 100                    end cases.
 101
 102                 4) Rotated and mirrored components may not show up correctly,
 103                    but should be better now, thanks to patches from
 104                    Thepthai Tabtieng <tabtieng@lsil.com>.
 105
 106
 107         convert_sym (the C version) typical use:
 108
 109                 convert_sym -s viewlogic_symbol.1 > viewlogic_symbol-1.sym
 110
 111                 convert_sym viewlogic_schematic.1 > viewlogic_schematic-1.sch
 112
 113         convert_sym is installed when make install is run.
 114
 115         Thanks to Thepthai Tabtieng <tabtieng@lsil.com> for code to
 116         support rotated and mirrored components, and a fix for
 117         component instantiations.
 118
 119
 120     Sarlacc (consists of sarlacc_schem and sarlacc_sym)
 121     Written by: Matthew Ettus
 122
 123     Sarlacc is an OrCAD to gEDA format schematic converter. This software is
 124     beta, so it still has limitations.  To convert files do the following:
 125
 126       * Go into ORCAD, load up your schematic, and save it as "SDT IV format".
 127         All of the versions of ORCAD should be able to do this.  This
 128         is the old ORCAD 16 bit format.  In this process, your library parts
 129         will be converted to a new format.  Along the way, there is an
 130         intermediate format which is all text.  It is probably kept in your
 131         tmp directory (C:\windows\temp ?), and it has a .src extension.
 132         Save this file too.
 133       * To convert schematics type:  sarlacc_schem orcadfile > gedafile.sch
 134       * To convert symbols type: sarlacc_sym orcadlibrary.src
 135           This will create individual .sym files for gschem. You will need to
 136           put them somewhere gschem will find them
 137
 138
 139     olib
 140     Written by: Mario Pascucci
 141
 142     olib is a simple automated converter from OrCAD(tm) v4 (in SDT version
 143     1.10) parts library (in ASCII dump format, through "decomp" utility)
 144     to gEDA component definition in .sym format file.
 145
 146
 147     refdes_renum
 148     Dan McMahill
 149
 150     refdes_renum reads a gschem schematic file or files and renumbers
 151     all reference designators.  The reference designators are numbered
 152     starting with 1 and the old schematic file is replaced by the modified
 153     schematic file.
 154
 155     Run the program with no parameters or with --help to see usage
 156     information.
 157
 158
 159     tragesym
 160     Werner Hoch
 161
 162     tragesym is a symbol creator for gEDA/gaf.  The aim of this python
 163     script is to make it easier (and faster) to create symbols for gEDA.
 164
 165     Program features:
 166
 167     * create pins and arrange their elements (clocksign, dot, type, pinnumber,
 168       label)
 169     * sort pins alphabetical and numerical
 170     * swap words of pinlabels if wished
 171     * draw negation lines on the labels
 172     * rotate pinlabels if wished
 173     * some syntax check to the input file
 174
 175     Please see the README.tragesym and ChangeLog.tragesym for more info.
 176     Be sure to look at the examples in examples/tragesym.  There you will
 177     find the template.src file referenced in the README.tragesym file.
 178
 179
 180     pads_backannotate
 181     Dan McMahill
 182
 183     A perl program which implements backannotation from Pads PowerPCB
 184     board layouts to gschem schematics.
 185
 186     Please see the pads_backannotate.[dvi|html|ps|pdf] documentation for more
 187     details.
 188
 189
 190     gsch2pcb
 191     Bill Wilson
 192
 193     gsch2pcb is conceptually based on the gschem2pcb shell script
 194     distributed with gnetlist, but additionally handles multiple
 195     schematics, handles element file footprints, and removes pc board
 196     elements corresponding to components deleted from the schematics.
 197     It also forward annotates component value changes.
 198
 199     Please see the README.gsch2pcb file for more information.  Also see
 200     examples/gsch2pcb/project.sample for an example of a project file.
 201
 202
 203     garchive
 204     Stuart Brorson
 205
 206     This program is used to create a gEDA design archive.  It operates
 207     in two modes: archive mode and extract mode.  In archive mode it
 208     creates a project archive from a bunch of project files, and in
 209     extract mode it extracts the files from the archive and places them in
 210     the local dir.
 211
 212     garchive requires python to run.
 213     Run:  garchive -h  for help information.
 214
 215
 216 - License
 217
 218         gEDA/gaf (which includes libgeda, gschem, gnetlist, geda, setup,
 219         gsymcheck, gschcheck, gpcb, utils, docs, examples, all associated
 220         files, the component symbols, and all the file formats) is placed
 221         under the GNU Public License (GPL) version 2.0.  See the various
 222         COPYING files for more information.
 223
 224         Programs and associated files are:
 225         Copyright 1998-2006 by Ales Hvezda and the respective original
 226         authors (which are listed on the respective files)
 227
 228         mk_sym is Copyright 1999 by Jerry O'Keefe
 229         smash_megafile is Copyright 1999 by Mike Jarabek
 230         convert_sym is Copyright 1999-2002 by Mike Jarabek
 231         All of sarlacc is Copyright 1999-2002 by Matthew Ettus
 232         gschlas is Copyright 2002 by Ales Hvezda
 233         olib is Copyright 2002 by Mario Pascucci
 234         refdes_renum is Copyright 2003 by Dan McMahill
 235         tragesym is Copyright 2001-2003 by Werner Hoch
 236         pads_backannotate is Copyright 2003 by Dan McMahill
 237         gsch2pcb is Copyright 2003-2004 by Bill Wilson
 238         garchive is Copyright 2003 by Stuart Brorson
 239
 240
 241
 242 - gEDA Internet resources
 243
 244         Homepage: http://geda.seul.org
 245
 246         Mailing lists: http://geda.seul.org/mailinglist
 247
 248         For any questions related to gEDA/gaf, please subscribe and post
 249         to the "geda-user" mailing list.
 250