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