gnetlist/docs/gnetlist.1

   1 .TH gnetlist 1 "June 19th, 2011" "gEDA Project" 1.7.1.20110619
   2 .SH NAME
   3 gnetlist - gEDA/gaf Netlist Extraction and Generation
   4 .SH SYNOPSIS
   5 .B gnetlist
   6 [\fIOPTION\fR ...] [\fB-g\fR \fIBACKEND\fR] [\fI--\fR] \fIFILE\fR ...
   7
   8 .SH DESCRIPTION
   9 .PP
  10
  11 \fBgnetlist\fR is a netlist extraction and generation tool, and is
  12 part of the gEDA (GPL Electronic Design Automation) toolset.  It takes
  13 one or electronic schematics as input, and outputs a netlist.  A
  14 netlist is a machine-interpretable description of the way that
  15 components in an electronic circuit are connected together, and is
  16 commonly used as the input to a PCB layout program such as
  17 \fBpcb\fR(1) or to a simulator such as \fBgnucap\fR(1).
  18
  19 A normal \fBgnetlist\fR run is carried out in two steps.  First, the
  20 \fBgnetlist\fR frontend loads the specified human-readable schematic
  21 \fIFILE\fRs, and compiles them to an in-memory netlist description.
  22 Next, a `backend' is used to export the connection and component data
  23 to one of many supported netlist formats.
  24
  25 \fBgnetlist\fR is extensible, using the Scheme programming language.
  26
  27 .SH GENERAL OPTIONS
  28 .TP 8
  29 \fB-q\fR
  30 Quiet mode. Turns off all warnings/notes/messages.
  31 .TP 8
  32 \fB-v\fR, \fB--verbose\fR
  33 Verbose mode.  Output all diagnostic information.
  34 .TP 8
  35 \fB-L\fR \fIDIRECTORY\fR
  36 Prepend \fIDIRECTORY\fR to the list of directories to be searched for
  37 Scheme files.
  38 .TP 8
  39 \fB-g\fR \fIBACKEND\fR
  40 Specify the netlist backend to be used.
  41 .TP 8
  42 \fB-O\fR \fISTRING\fR
  43 Pass an option string to the backend.
  44 .TP 8
  45 \fB--list-backends\fR
  46 Print a list of available netlist backends.
  47 .TP 8
  48 \fB-o\fR \fIFILE\fR
  49 Specify the filename for the generated netlist.  By default, output is
  50 directed to `output.net'.
  51 .TP 8
  52 \fB-l\fR \fIFILE\fR
  53 Specify a Scheme file to be loaded before the backend is loaded or
  54 executed.  This option can be specified multiple times.
  55 .TP 8
  56 \fB-m\fR \fIFILE\fR
  57 Specify a Scheme file to be loaded between loading the backend and
  58 executing it.  This option can be specified multiple times.
  59 .TP 8
  60 \fB-c\fR \fIEXPR\fR
  61 Specify a Scheme expression to be executed during \fBgnetlist\fR
  62 startup.  This option can be specified multiple times.
  63 .TP 8
  64 \fB-i\fR
  65 After the schematic files have been loaded and compiled, and after all
  66 Scheme files have been loaded, but before running the backend, enter a
  67 Scheme read-eval-print loop.
  68 .TP 8
  69 \fB-h\fR, \fB--help\fR
  70 Print a help message.
  71 .TP 8
  72 \fB-V\fR, \fB--version\fR
  73 Print \fBgnetlist\fR version information.
  74 .TP 8
  75 \fB--\fR
  76 Treat all remaining arguments as schematic filenames.  Use this if you
  77 have a schematic filename which begins with `-'.
  78
  79 .SH BACKENDS
  80 .PP
  81 Currently, \fBgnetlist\fR includes the following backends:
  82
  83 .TP 8
  84 \fBallegro\fR
  85 Allegro netlist format.
  86 .TP 8
  87 \fBbae\fR
  88 Bartels Autoengineer netlist format.
  89 .TP 8
  90 \fBbom\fR, \fBbom2\fR
  91 Bill of materials generation.
  92 .TP 8
  93 \fBcalay\fR
  94 Calay netlist format.
  95 .TP 8
  96 \fBcascade\fR
  97 RF Cascade netlist format
  98 .TP 8
  99 \fBdrc\fR, \fBdrc2\fR
 100 Design rule checkers (\fBdrc2\fR is recommended).
 101 .TP 8
 102 \fBeagle\fR
 103 Eagle netlist format.
 104 .TP 8
 105 \fBfuturenet2\fR
 106 Futurenet2 netlist format.
 107 .TP 8
 108 \fBgeda\fR
 109 Native gEDA netlist format (mainly used for testing and diagnostics).
 110 .TP 8
 111 \fBgossip\fR
 112 Gossip netlist format.
 113 .TP 8
 114 \fBgsch2pcb\fR
 115 Backend used for \fBpcb\fR(1) file layout generation by
 116 \fBgsch2pcb\fR(1).  It is not recommended to use this backend
 117 directly.
 118 .TP 8
 119 \fBliquidpcb\fR
 120 LiquidPCB netlist format.
 121 .TP 8
 122 \fBmathematica\fR
 123 Netlister for analytical circuit solving using Mathematica.
 124 .TP 8
 125 \fBmaxascii\fR
 126 MAXASCII netlist format.
 127 .TP 8
 128 \fBosmond\fR
 129 Osmond netlist format.
 130 .TP 8
 131 \fBpads\fR
 132 PADS netlist format.
 133 .TP 8
 134 \fBpartslist1\fR, \fBpartslist2\fR, \fBpartslist3\fR
 135 Bill of materials generation backends (alternatives to \fBbom\fR and
 136 \fBbom2\fR).
 137 .TP 8
 138 \fBPCB\fR
 139 \fBpcb\fR(1) netlist format.
 140 .TP 8
 141 \fBpcbpins\fR
 142 Generates a \fBpcb\fR(1) action file for forward annotating pin/pad
 143 names from schematic to layout.
 144 .TP 8
 145 \fBprotelII\fR
 146 Protel II netlist format.
 147 .TP 8
 148 \fBredac\fR
 149 RACAL-REDAC netlist format.
 150 .TP 8
 151 \fBspice\fR, \fBspice-sdb\fR
 152 SPICE-compatible netlist format (\fBspice-sdb\fR is recommended).
 153 Suitable for use with \fBgnucap\fR(1).
 154 .TP 8
 155 \fBswitcap\fR
 156 SWITCAP switched capacitor simulator netlist format.
 157 .TP 8
 158 \fBsystemc\fR
 159 Structural SystemC code generation.
 160 .TP 8
 161 \fBtango\fR
 162 Tango netlist format.
 163 .TP 8
 164 \fBvams\fR
 165 VHDL-AMS code generation.
 166 .TP 8
 167 \fBverilog\fR
 168 Verilog code generation.
 169 .TP 8
 170 \fBvhdl\fR
 171 VHDL code generation.
 172 .TP 8
 173 \fBvipec\fR
 174 ViPEC Network Analyser netlist format.
 175
 176
 177 .SH EXAMPLES
 178 .PP
 179 These examples assume that you have a `stack_1.sch' in the current directory.
 180 .PP
 181 \fBgnetlist\fR requires that at least one schematic to be specified on the
 182 command line:
 183
 184 .nf
 185         ./gnetlist stack_1.sch
 186 .ad b
 187
 188 .PP
 189 This is not very useful since it does not direct \fBgnetlist\fR to do
 190 anything.
 191 .PP
 192 Specify a backend name with `\-g' to get \fBgnetlist\fR to output a
 193 netlist:
 194
 195 .nf
 196         ./gnetlist \-g geda stack_1.sch
 197 .ad b
 198
 199 .PP
 200 The netlist output will be written to a file called `output.net'
 201 in the current working directory.
 202
 203 .PP
 204 You can specify the output filename by using the `\-o' option:
 205
 206 .nf
 207         ./gnetlist \-g geda stack_1.sch \-o /tmp/stack.netlist
 208 .ad b
 209
 210 .PP
 211 Output will now be directed to `/tmp/stack.netlist'.
 212
 213 .PP
 214 You could run (for example) the `spice-sdb' backend against the
 215 schematic if you specified `\-g spice-sdb', or you could generate a
 216 bill of materials for the schematic using `\-g partslist1'.
 217
 218 .PP
 219 To obtain a Scheme prompt to run Scheme expressions directly, you can
 220 use the `\-i' option.
 221
 222 .nf
 223         ./gnetlist \-i stack_1.sch
 224 .ad b
 225
 226 .PP
 227 \fBgnetlist\fR will load `stack_1.sh', and then enter an interactive
 228 Scheme read-eval-print loop.
 229
 230 .SH ENVIRONMENT
 231 .TP 8
 232 .B GEDADATA
 233 specifies the search directory for Scheme and rc files.  The default
 234 is `${prefix}/share/gEDA'.
 235 .TP 8
 236 .B GEDADATARC
 237 specifies the search directory for rc files.  The default is `$GEDADATA'.
 238
 239 .SH AUTHORS
 240 See the `AUTHORS' file included with this program.
 241
 242 .SH COPYRIGHT
 243 .nf
 244 Copyright \(co 1999-2011 gEDA Contributors.  License GPLv2+: GNU GPL
 245 version 2 or later.  Please see the `COPYING' file included with this
 246 program for full details.
 247 .PP
 248 This is free software: you are free to change and redistribute it.
 249 There is NO WARRANTY, to the extent permitted by law.
 250
 251 .SH SEE ALSO
 252 \fBgschem\fR(1), \fBgsymcheck\fR(1), \fBpcb\fR(1), \fBgnucap\fR(1)