1gnetlist(1) 1.6.2.20110115 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 · LiquidPCB format netlist backend (-g liquidpcb)
93 For more info on these formats please look at the README.*
95 Please read the official documentation on how to use gnetlist, since
97 this man page just describes the command line arguments and a few
98 examples on how to run gnetlist.
99
102 gnelist accepts the following options:
103 -q Quiet mode on. This mode turns off all warnings/notes/mes‐
105 sages. (optional)
106 -v Verbose mode on. This mode gives as much feedback to the user
108 as possible. (optional)
109 -g guile_procedure
111 Specify the guile procedure which is executed to create the
112 netlist. Use "-g help" to display a list of available backends.
113 -o output_filename
115 Specify the filename which will contain the netlist generated
116 by gnetlist. If this option is not specified the default file‐
117 name is "output.net".
118 -l scheme_file
120 Specify a filename which contains scheme code to be loaded and
121 execute before any backend is loaded or any guile procedure
122 (using -g flag) is executed. This flag can be specified multi‐
123 ple times and can be used to pass information to backends.
124 -e, --embed
126 Force embedding contents of .include file when using the spice-
127 sdb backend.
128 -O string
130 Pass the given option to the specified backend.
131 -m scheme_file
133 Specify a filename which contains scheme code to be loaded and
134 execute after the backend is loaded but still before any guile
135 procedure (using -g flag) is executed. This flag can be speci‐
136 fied multiple times and can be used to pass information to
137 backends. This flag, for example, allows the user to override
138 variables inside of the backends (such as paths).
139 -n, --nomunge
141 Do not autocorrect the refdes attributes. Only applies to the
142 spice-sdb backend.
143 -c string
145 Pass the specified string to the guile interpreter. This
146 allows you to execute arbitrary guile scripts from the command
147 line. Be sure to surround the string with either single or
148 double quotes to satisfy your shell. The string is execute
149 before any init or netlist backend scheme code is loaded or
150 executed.
151 -I, --include
153 Put .INCLUDE <filename> in output file instead of model file's
154 contents.
155 -h, --help
157 Print out short command line help.
158 -i Interactive mode. After the schematic is read in and parsed
160 then go into interactive mode. Interactive mode allows the
161 user to execute guile procedures directly.
162 -s Sort output netlist (for Gnucap)
164 schematic1 [... schematicN]
166 At least one schematic file must be specified. If multiple
167 schematics are specified then they are sequentially read in and
168 parsed with the assumption that they are all part of the same
169 design. It is important that the schematic(s) follow all the
170 options (ie last).
171
174 These examples assume that you have a stack_1.sch in the current direc‐
175 tory.
176 gnetlist requires that at least one schematic to be specified on the
178 command line:
179 ./gnetlist stack_1.sch
181 This is not very useful since it does not direct gnetlist to do
183 anything.
184 Specify a guile procedure name to get gnetlist to output a netlist:
186 ./gnetlist -g geda stack_1.sch
188 The netlist output will be written to a file called "output.net"
190 in the current working directory.
191 You can specify the output filename by using the -o flag:
193 ./gnetlist -g geda stack_1.sch -o stack.netlist
195 The spice backend is run against the schematic(s) if you specify
197 -g spice and the tango backend is run if you specify -g tango.
198 To interact with the guile interpreter:
200 ./gnetlist -i stack_1.sch
202 You will get a prompt where you can execute guile procedures.
204 To get a more verbose feedback as to what gnetlist is doing run
206 with the -v flag:
207 ./gnetlist -v -g geda stack_1.sch
209
212 gnetlist respects the following environment variable:
213 GEDADATA
215 Specifies where the various required scheme and rc files are
216 located (the default is ${prefix}/share/gEDA). This environ‐
217 ment variables does not need to be set by the end user unless
218 they are moving the executables to a new install ${prefix}.
219
222 Ales Hvezda and many others
223
226 gschem(1), gsymcheck(1)
227
229 Copyright © 1999-2008 Ales Hvezda
230 This document can be freely redistributed according to the terms of the
232 GNU General Public License version 2.0.
233Version January 15th, 2011 gnetlist(1)