<!-- Creator : groff version 1.20.1 -->
<!-- CreationDate: Fri Jan 14 23:26:00 2011 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>gnetlist</title>
</head>
<body>
<h1 align="center">gnetlist</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#OPTIONS">OPTIONS</a><br>
<a href="#EXAMPLES">EXAMPLES</a><br>
<a href="#ENVIRONMENT">ENVIRONMENT</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#COPYRIGHT">COPYRIGHT</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">gnetlist -
gEDA/gaf Netlist extraction/generation</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>gnetlist</b>
[−e] [−i] [−I] [−q] [−s]
[−v] [−l schem_file] [−m schem_file ]
[−n] [ −O option ] [−h |
−−help] [−g guile_procedure] [−c
scheme_string ] [−o output_filename] schematic1 [...
schematicN]</p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>gnetlist</i>
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.</p>
<p style="margin-left:11%; margin-top: 1em">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.</p>
<p style="margin-left:11%; margin-top: 1em">gnetlist is
very much so a work in progress. Currently it supports the
following backends:</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Allegro netlist format (−g allegro)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>BOM / BOM2 - Bill of Materials (−g bom and
−g bom2)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Partslist 1,2,3 - More Bill of Materials (−g
partslist[1-3])</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>DRC - Start of a design rule checker (−g drc)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>DRC2 - A second design rule checker (−g drc2)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>gEDA - native format, mainly used for testing (−g
geda)</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Gossip netlist format (−g gossip)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>PADS netlist format (−g pads)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>PCB / PCBboard (−g PCB and −g PCBboard)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>PCB actions file for forward annotating pin/pad names
from schematic to layout (−g pcbpins)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>gsch2pcb backend (−g gsch2pcb)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>ProtelII netlist format (−g protelII)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Spice compatible netlist format (−g spice)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Enhanced spice compatible netlist format (−g
spice-sdb)</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Tango netlist format (−g tango)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Verilog code (−g verilog)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>VHDL code (−g vhdl)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>VIPEC netlist format (−g vipec)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Bartels Autoengineer netlist format (−g bae)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>GOSSIP system simulation system netlist format (−g
gossip)</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>MAXASCII netlist format (−g maxascii)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>VHDL-AMS netlist format (−g vams)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Futurenet2 netlist format (−g futurenet2)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>SWITCAP switched capacitor simulator netlist format
(−g switcap)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>RF Cascade netlist format (−g cascade)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>RACAL-REDAC netlist format (−g redac)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>SystemC netlist backend (−g systemc)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Calay format netlist backend (−g calay)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Osmond format netlist backend (−g osmond)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Eagle netlist format (−g eagle)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>Netlister for symbolic circuit analysis using
Mathematica (−g mathematica)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p>•</p></td>
<td width="2%"></td>
<td width="86%">
<p>LiquidPCB format netlist backend (−g
liquidpcb)</p> </td></tr>
</table>
<p style="margin-left:14%; margin-top: 1em">For more info
on these formats please look at the README.*</p>
<p style="margin-left:14%; margin-top: 1em">Please read the
official 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.</p>
<h2>OPTIONS
<a name="OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>gnelist</i>
accepts the following options:</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p style="margin-top: 1em"><b>-q</b></p></td>
<td width="9%"></td>
<td width="77%">
<p style="margin-top: 1em">Quiet mode on. This mode turns
off all warnings/notes/messages. (optional)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p><b>-v</b></p></td>
<td width="9%"></td>
<td width="77%">
<p>Verbose mode on. This mode gives as much feedback to the
user as possible. (optional)</p></td></tr>
</table>
<p style="margin-left:11%;"><b>-g guile_procedure</b></p>
<p style="margin-left:23%;">Specify the guile procedure
which is executed to create the netlist. Use "−g
help" to display a list of available backends.</p>
<p style="margin-left:11%;"><b>-o output_filename</b></p>
<p style="margin-left:23%;">Specify the filename which will
contain the netlist generated by gnetlist. If this option is
not specified the default filename is
"output.net".</p>
<p style="margin-left:11%;"><b>-l scheme_file</b></p>
<p style="margin-left:23%;">Specify a filename which
contains scheme code to be loaded and execute before any
backend is loaded or any guile procedure (using −g
flag) is executed. This flag can be specified multiple times
and can be used to pass information to backends.</p>
<p style="margin-left:11%;"><b>-e, --embed</b></p>
<p style="margin-left:23%;">Force embedding contents of
.include file when using the spice-sdb backend.</p>
<p style="margin-left:11%;"><b>-O string</b></p>
<p style="margin-left:23%;">Pass the given option to the
specified backend.</p>
<p style="margin-left:11%;"><b>-m scheme_file</b></p>
<p style="margin-left:23%;">Specify a filename which
contains scheme code to be loaded and execute after the
backend is loaded but still before any guile procedure
(using −g flag) is executed. This flag can be
specified multiple times and can be used to pass information
to backends. This flag, for example, allows the user to
override variables inside of the backends (such as
paths).</p>
<p style="margin-left:11%;"><b>-n, --nomunge</b></p>
<p style="margin-left:23%;">Do not autocorrect the refdes
attributes. Only applies to the spice-sdb backend.</p>
<p style="margin-left:11%;"><b>-c string</b></p>
<p style="margin-left:23%;">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 loaded or executed.</p>
<p style="margin-left:11%;"><b>-I, --include</b></p>
<p style="margin-left:23%;">Put .INCLUDE <filename>
in output file instead of model file’s contents.</p>
<p style="margin-left:11%;"><b>-h, --help</b></p>
<p style="margin-left:23%;">Print out short command line
help.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p><b>-i</b></p></td>
<td width="9%"></td>
<td width="77%">
<p>Interactive mode. After the schematic is read in and
parsed then go into interactive mode. Interactive mode
allows the user to execute guile procedures directly.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p><b>-s</b></p></td>
<td width="9%"></td>
<td width="77%">
<p>Sort output netlist (for Gnucap)</p></td></tr>
</table>
<p style="margin-left:11%;">schematic1 [... schematicN]</p>
<p style="margin-left:23%;">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).</p>
<h2>EXAMPLES
<a name="EXAMPLES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">These examples
assume that you have a stack_1.sch in the current
directory.</p>
<p style="margin-left:11%; margin-top: 1em">gnetlist
requires that at least one schematic to be specified on the
command line:</p>
<p style="margin-left:11%; margin-top: 1em">./gnetlist
stack_1.sch</p>
<p style="margin-left:11%; margin-top: 1em">This is not
very useful since it does not direct gnetlist to do <br>
anything.</p>
<p style="margin-left:11%; margin-top: 1em">Specify a guile
procedure name to get gnetlist to output a netlist:</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="7%"></td>
<td width="85%">
<p>./gnetlist −g geda stack_1.sch</p></td></tr>
</table>
<p style="margin-left:11%; margin-top: 1em">The netlist
output will be written to a file called
"output.net" <br>
in the current working directory.</p>
<p style="margin-left:11%; margin-top: 1em">You can specify
the output filename by using the −o flag:</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="92%">
<p>./gnetlist −g geda stack_1.sch −o
stack.netlist</p> </td></tr>
</table>
<p style="margin-left:11%; margin-top: 1em">The spice
backend is run against the schematic(s) if you specify <br>
−g spice and the tango backend is run if you specify
−g tango.</p>
<p style="margin-left:11%; margin-top: 1em">To interact
with the guile interpreter:</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="92%">
<p>./gnetlist −i stack_1.sch</p></td></tr>
</table>
<p style="margin-left:11%; margin-top: 1em">You will get a
prompt where you can execute guile procedures.</p>
<p style="margin-left:11%; margin-top: 1em">To get a more
verbose feedback as to what gnetlist is doing run <br>
with the −v flag:</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="92%">
<p>./gnetlist −v −g geda stack_1.sch</p></td></tr>
</table>
<h2>ENVIRONMENT
<a name="ENVIRONMENT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>gnetlist</i>
respects the following environment variable: <b><br>
GEDADATA</b></p>
<p style="margin-left:23%;">Specifies where the various
required scheme and rc files are located (the default is
${prefix}/share/gEDA). This environment variables does not
need to be set by the end user unless they are moving the
executables to a new install ${prefix}.</p>
<h2>AUTHOR
<a name="AUTHOR"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Ales Hvezda and
many others</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>gschem</b>(1),
<b>gsymcheck</b>(1)</p>
<h2>COPYRIGHT
<a name="COPYRIGHT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Copyright
© 1999-2008 Ales Hvezda</p>
<p style="margin-left:11%; margin-top: 1em">This document
can be freely redistributed according to the terms of the
GNU General Public License version 2.0.</p>
<hr>
</body>
</html>
