1gnetlist(1) 1.4.0.20080127 gnetlist(1)
2
6 gnetlist - gEDA/gaf Netlist extraction/generation
7
9 gnetlist [-e] [-i] [-I] [-q] [-s] [-v] [-l schem_file] [-m schem_file ]
10 [-n] [ -O option ] [-h | --help] [-g guile_procedure] [-c scheme_string
11 ] [-o output_filename] schematic1 [... schematicN]
12
14 gnetlist is the netlist extraction/generation program which is part
15 gEDA (GPL Electronic Design Automation) toolset. This program takes a
16 schematic for its input and outputs a netlist.
17 gnetlist depends heavily on guile (a scheme based scripting language).
19 It uses guile to define the output format. Basically gnetlist reads a
20 schematic, creates an internal representation of the various connec‐
21 tions, and then a guile script extracts the connections into some
22 netlist format.
23 gnetlist is very much so a work in progress. Currently it supports the
25 following backends:
26 · Allegro netlist format (-g allegro)
29 · BOM / BOM2 - Bill of Materials (-g bom and -g bom2)
31 · Partslist 1,2,3 - More Bill of Materials (-g partslist[1-3])
33 · DRC - Start of a design rule checker (-g drc)
35 · DRC2 - A second design rule checker (-g drc2)
37 · gEDA - native format, mainly used for testing (-g geda)
39 · Gossip netlist format (-g gossip)
41 · PADS netlist format (-g pads)
43 · PCB / PCBboard (-g PCB and -g PCBboard)
45 · PCB actions file for forward annotating pin/pad names from schematic
47 to layout (-g pcbpins)
48 · gsch2pcb backend (-g gsch2pcb)
50 · ProtelII netlist format (-g protelII)
52 · Spice compatible netlist format (-g spice)
54 · Enhanced spice compatible netlist format (-g spice-sdb)
56 · Tango netlist format (-g tango)
58 · Verilog code (-g verilog)
60 · VHDL code (-g vhdl)
62 · VIPEC netlist format (-g vipec)
64 · Bartels Autoengineer netlist format (-g bae)
66 · GOSSIP system simulation system netlist format (-g gossip)
68 · MAXASCII netlist format (-g maxascii)
70 · VHDL-AMS netlist format (-g vams)
72 · Futurenet2 netlist format (-g futurenet2 )
74 · SWITCAP switched capacitor simulator netlist format (-g switcap )
76 · RF Cascade netlist format (-g cascade )
78 · RACAL-REDAC netlist format (-g redac )
80 · SystemC netlist backend (-g systemc)
82 · Calay format netlist backend (-g calay)
84 · Osmond format netlist backend (-g osmond)
86 · Eagle netlist format (-g eagle)
88 · Netlister for symbolic circuit analysis using Mathematica (-g mathe‐
90 matica)
91 For more info on these formats please look at the README.*
93 Please read the official documentation on how to use gnetlist, since
95 this man page just describes the command line arguments and a few
96 examples on how to run gnetlist.
97
100 gnelist accepts the following options:
101 -q Quiet mode on. This mode turns off all warnings/notes/mes‐
103 sages. (optional)
104 -v Verbose mode on. This mode gives as much feedback to the user
106 as possible. (optional)
107 -g guile_procedure
109 Specify the guile procedure which is executed to create the
110 netlist. Use "-g help" to display a list of available backends.
111 -o output_filename
113 Specify the filename which will contain the netlist generated
114 by gnetlist. If this option is not specified the default file‐
115 name is "output.net".
116 -l scheme_file
118 Specify a filename which contains scheme code to be loaded and
119 execute before any backend is loaded or any guile procedure
120 (using -g flag) is executed. This flag can be specified multi‐
121 ple times and can be used to pass information to backends.
122 -e, --embed
124 Force embedding contents of .include file when using the spice-
125 sdb backend.
126 -O string
128 Pass the given option to the specified backend
129 -m scheme_file
131 Specify a filename which contains scheme code to be loaded and
132 execute after the backend is loaded but still before any guile
133 procedure (using -g flag) is executed. This flag can be speci‐
134 fied multiple times and can be used to pass information to
135 backends. This flag, for example, allows the user to override
136 variables inside of the backends (such as paths).
137 -n --nomunge
139 Do not autocorrect the refdes attributes. Only applies to the
140 spice-sdb backend.
141 -c string
143 Pass the specified string to the guile interpreter. This
144 allows you to execute arbitrary guile scripts from the command
145 line. Be sure to surround the string with either single or
146 double quotes to satisfy your shell. The string is execute
147 before any init or netlist backend scheme code is loaded or
148 executed.
149 -I --include
151 Put .INCLUDE <filename> in output file instead of model file's
152 contents.
153 -h --help
155 Print out short command line help.
156 -i Interactive mode. After the schematic is read in and parsed
158 then go into interactive mode. Interactive mode allows the
159 user to execute guile procedures directly.
160 -s Sort output netlist (for Gnucap)
162 schematic1 [... schematicN]
164 At least one schematic file must be specified. If multiple
165 schematics are specified then they are sequentially read in and
166 parsed with the assumption that they are all part of the same
167 design. It is important that the schematic(s) follow all the
168 options (ie last).
169
172 These examples assume that you have a stack_1.sch in the current direc‐
173 tory.
174 gnetlist requires that at least one schematic to be specified on the
176 command line:
177 ./gnetlist stack_1.sch
179 This is not very useful since it does not direct gnetlist to do
181 anything.
182 Specify a guile procedure name to get gnetlist to output a netlist:
184 ./gnetlist -g geda stack_1.sch
186 The netlist output will be written to a file called "output.net"
188 in the current working directory.
189 You can specify the output filename by using the -o flag:
191 ./gnetlist -g geda stack_1.sch -o stack.netlist
193 The spice backend is run against the schematic(s) if you specify
195 -g spice and the tango backend is run if you specify -g tango.
196 To interact with the guile interpreter:
198 ./gnetlist -i stack_1.sch
200 You will get a prompt where you can execute guile procedures.
202 To get a more verbose feedback as to what gnetlist is doing run
204 with the -v flag:
205 ./gnetlist -v -g geda stack_1.sch
207
210 gnetlist respects the following environment variable:
211 GEDADATA
213 specifies where the various required scheme and rc files are
214 located (the default is ${prefix}/share/gEDA). This environ‐
215 ment variables does not need to be set by the end user unless
216 they are moving the executables to a new install ${prefix}.
217
220 Ales Hvezda and many others
221
224 gschem(1), gsymcheck(1)
225
227 Copyright © 1999-2008 Ales Hvezda
228 This document can be freely redistributed according to the terms of the
230 GNU General Public License version 2.0
231Version January 27th, 2008 gnetlist(1)