gnetlist

gEDA(1)                            19990705                            gEDA(1)



NAME
       gnetlist - GPL Netlist extraction/generation

SYNOPSIS
       gnetlist [-i] [-v] [-r rcfilename] [-g guile_procedure] [-o
       output_filename] schematic1 [... schematicN]

DESCRIPTION
       gnetlist is the netlist extraction/generation program which is part
       gEDA (GPL Electronic Design Automation) toolset.  This program takes a
       schematic for its input and outputs a netlist.  As of the writing of
       this man page a test netlist format is the only existing output format
       ("ales-netlist").

       gnetlist depends heavily on guile (a scheme based scripting language).
       It uses guile to define the output format.  Basically gnetlist reads a
       schematic, creates an internal representation of the various
       connections, and then a guile script extracts the connections into some
       netlist format.

       gnetlist is very much so a work in progress.  Currently it supports the
       following backends:

               1) PCB / PCBboard (-g PCB and -g PCBboard)
               2) Allegro netlist format (-g allegro)
               3) BAE netlist format (-g bae)
               4) BOM / BOM2 - Bill of Materials (-g bom and -g bom2)
               5) DRC - Start of a design rule checker (-g drc)
               6) gEDA - native format, mainly used for testing (-g geda)
               7) Gossip netlist format (-g gossip)
               8) PADS netlist format (-g pads)
               9) ProtelII netlist format (-g protelII)
               10) Spice compatible netlist format (-g spice)
               11) Tango netlist format (-g tango)
               12) Verilog code (-g verilog)
               13) VHDL code (-g vhdl)
               14) VIPEC netlist format (-g vipec)

       For more info on these formats please look at the README.*

       Please read the official (non-existant) documentation on how to use
       gnetlist, since this man page just describes the command line arguments
       and a few examples on how to run gnetlist.


OPTIONS
       gnelist accepts the following options:

       -q      Quiet mode on.  This mode turns off all
               warnings/notes/messages. (optional)

       -v      Verbose mode on.  This mode gives as much feedback to the user
               as possible. (optional)

       -g guile_procedure
               Specify the guile procedure which is executed to create the
               netlist.

       -o output_filename
               Specify the filename which will contain the netlist generated
               by gnetlist.  If this option is not specified the default
               filename is "output.net".

       -c string
               Pass the specified string to the guile interpreter.  This
               allows you to execute arbitrary guile scripts from the command
               line.  Be sure to surround the string with either single or
               double quotes to satisfy your shell.  The string is execute
               before any init or netlist backend scheme code is executed.

       -i      Interactive mode.  After the schematic is read in and parsed
               and, if specified, the guile_procedure is execute then go into
               interactive mode.  Interactive mode allows the user to execute
               guile procedures directly.

       schematic1 [... schematicN]
               At least one schematic file must be specified.  If multiple
               schematics are specified then they are sequentially read in and
               parsed with the assumption that they are all part of the same
               design.  It is important that the schematic(s) follow all the
               options (ie last).


EXAMPLES
       These examples assume that you have a stack_1.sch in the current
       directory.

       gnetlist requires that at least one schematic to be specified on the
       command line:

            ./gnetlist stack_1.sch

       This is not very useful since it does not direct gnetlist to do
       anything.

       Specify a guile procedure name to get gnetlist to output a netlist:

            ./gnetlist -g geda stack_1.sch

       The netlist output will be written to a file called "output.net"
       in the current working directory.

       You can specify the output filename by using the -o flag:

            ./gnetlist -g geda stack_1.sch -o stack.netlist

       The spice backend is run against the schematic(s) if you specify
       -g spice and the tango backend is run if you specify -g tango.

       To interact with the guile interpreter:

            ./gnetlist -i stack_1.sch

       You will get a prompt where you can execute guile procedures.

       To get a more verbose feedback as to what gnetlist is doing run
       with the -v flag:

            ./gnetlist -v -g geda stack_1.sch


ENVIRONMENT
       No environment variables are used.


AUTHOR
       Ales V. Hvezda and many others


SEE ALSO
       geda(1), gnetlist(1), gnetlist(1), gsymbol(1)

COPYRIGHT
       Copyright ©  1999 Ales V Hvezda

       This document can be freely redistributed according to the terms of the
       GNU General Public License version 2.0




Version                         July 5th, 1999                         gEDA(1)