gnetlist-legacy/docs/gnetlist-legacy.1.in

   1 .TH gnetlist-legacy 1 "@DATE@" "gEDA Project" @VERSION@
   2 .SH NAME
   3 gnetlist-legacy - gEDA/gaf Netlist Extraction and Generation
   4 .SH SYNOPSIS
   5 .B gnetlist-legacy
   6 [\fIOPTION\fR ...] [\fB-g\fR \fIBACKEND\fR] [\fI--\fR] \fIFILE\fR ...
   7
   8 .SH DESCRIPTION
   9 .PP
  10
  11 \fBgnetlist-legacy\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-legacy\fR run is carried out in two steps.  First, the
  20 \fBgnetlist-legacy\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-legacy\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 If `-' is given instead of a filename, the output is directed to the
  52 standard output.
  53 .TP 8
  54 \fB-l\fR \fIFILE\fR
  55 Specify a Scheme file to be loaded before the backend is loaded or
  56 executed.  This option can be specified multiple times.
  57 .TP 8
  58 \fB-m\fR \fIFILE\fR
  59 Specify a Scheme file to be loaded between loading the backend and
  60 executing it.  This option can be specified multiple times.
  61 .TP 8
  62 \fB-c\fR \fIEXPR\fR
  63 Specify a Scheme expression to be executed during \fBgnetlist-legacy\fR
  64 startup.  This option can be specified multiple times.
  65 .TP 8
  66 \fB-i\fR
  67 After the schematic files have been loaded and compiled, and after all
  68 Scheme files have been loaded, but before running the backend, enter a
  69 Scheme read-eval-print loop.
  70 .TP 8
  71 \fB-h\fR, \fB--help\fR
  72 Print a help message.
  73 .TP 8
  74 \fB-V\fR, \fB--version\fR
  75 Print \fBgnetlist-legacy\fR version information.
  76 .TP 8
  77 \fB--\fR
  78 Treat all remaining arguments as schematic filenames.  Use this if you
  79 have a schematic filename which begins with `-'.
  80
  81 .SH BACKENDS
  82 .PP
  83 Currently, \fBgnetlist-legacy\fR includes the following backends:
  84
  85 .TP 8
  86 \fBallegro\fR
  87 Allegro netlist format.
  88 .TP 8
  89 \fBbae\fR
  90 Bartels Autoengineer netlist format.
  91 .TP 8
  92 \fBbom\fR, \fBbom2\fR
  93 Bill of materials generation.
  94 .TP 8
  95 \fBcalay\fR
  96 Calay netlist format.
  97 .TP 8
  98 \fBcascade\fR
  99 RF Cascade netlist format
 100 .TP 8
 101 \fBdrc\fR, \fBdrc2\fR
 102 Design rule checkers (\fBdrc2\fR is recommended).
 103 .TP 8
 104 \fBeagle\fR
 105 Eagle netlist format.
 106 .TP 8
 107 \fBewnet\fR
 108 Netlist format for National Instruments ULTIboard layout tool.
 109 .TP 8
 110 \fBfuturenet2\fR
 111 Futurenet2 netlist format.
 112 .TP 8
 113 \fBgeda\fR
 114 Native gEDA netlist format (mainly used for testing and diagnostics).
 115 .TP 8
 116 \fBgossip\fR
 117 Gossip netlist format.
 118 .TP 8
 119 \fBgsch2pcb\fR
 120 Backend used for \fBpcb\fR(1) file layout generation by
 121 \fBgsch2pcb\fR(1).  It is not recommended to use this backend
 122 directly.
 123 .TP 8
 124 \fBliquidpcb\fR
 125 LiquidPCB netlist format.
 126 .TP 8
 127 \fBmathematica\fR
 128 Netlister for analytical circuit solving using Mathematica.
 129 .TP 8
 130 \fBmaxascii\fR
 131 MAXASCII netlist format.
 132 .TP 8
 133 \fBosmond\fR
 134 Osmond netlist format.
 135 .TP 8
 136 \fBpads\fR
 137 PADS netlist format.
 138 .TP 8
 139 \fBpartslist1\fR, \fBpartslist2\fR, \fBpartslist3\fR
 140 Bill of materials generation backends (alternatives to \fBbom\fR and
 141 \fBbom2\fR).
 142 .TP 8
 143 \fBPCB\fR
 144 \fBpcb\fR(1) netlist format.
 145 .TP 8
 146 \fBpcbpins\fR
 147 Generates a \fBpcb\fR(1) action file for forward annotating pin/pad
 148 names from schematic to layout.
 149 .TP 8
 150 \fBprotelII\fR
 151 Protel II netlist format.
 152 .TP 8
 153 \fBredac\fR
 154 RACAL-REDAC netlist format.
 155 .TP 8
 156 \fBspice\fR, \fBspice-sdb\fR
 157 SPICE-compatible netlist format (\fBspice-sdb\fR is recommended).
 158 Suitable for use with \fBgnucap\fR(1).
 159 .TP 8
 160 \fBswitcap\fR
 161 SWITCAP switched capacitor simulator netlist format.
 162 .TP 8
 163 \fBsystemc\fR
 164 Structural SystemC code generation.
 165 .TP 8
 166 \fBtango\fR
 167 Tango netlist format.
 168 .TP 8
 169 \fBvams\fR
 170 VHDL-AMS code generation.
 171 .TP 8
 172 \fBverilog\fR
 173 Verilog code generation.
 174 .TP 8
 175 \fBvhdl\fR
 176 VHDL code generation.
 177 .TP 8
 178 \fBvipec\fR
 179 ViPEC Network Analyser netlist format.
 180
 181
 182 .SH EXAMPLES
 183 .PP
 184 These examples assume that you have a `stack_1.sch' in the current directory.
 185 .PP
 186 \fBgnetlist-legacy\fR requires that at least one schematic to be specified on the
 187 command line:
 188
 189 .nf
 190         ./gnetlist-legacy stack_1.sch
 191 .ad b
 192
 193 .PP
 194 This is not very useful since it does not direct \fBgnetlist-legacy\fR to do
 195 anything.
 196 .PP
 197 Specify a backend name with `\-g' to get \fBgnetlist-legacy\fR to output a
 198 netlist:
 199
 200 .nf
 201         ./gnetlist-legacy \-g geda stack_1.sch
 202 .ad b
 203
 204 .PP
 205 The netlist output will be written to a file called `output.net'
 206 in the current working directory.
 207
 208 .PP
 209 You can specify the output filename by using the `\-o' option:
 210
 211 .nf
 212         ./gnetlist-legacy \-g geda stack_1.sch \-o /tmp/stack.netlist
 213 .ad b
 214
 215 .PP
 216 Output will now be directed to `/tmp/stack.netlist'.
 217
 218 .PP
 219 You could run (for example) the `spice-sdb' backend against the
 220 schematic if you specified `\-g spice-sdb', or you could generate a
 221 bill of materials for the schematic using `\-g partslist1'.
 222
 223 .PP
 224 To obtain a Scheme prompt to run Scheme expressions directly, you can
 225 use the `\-i' option.
 226
 227 .nf
 228         ./gnetlist-legacy \-i stack_1.sch
 229 .ad b
 230
 231 .PP
 232 \fBgnetlist-legacy\fR will load `stack_1.sh', and then enter an interactive
 233 Scheme read-eval-print loop.
 234
 235 .SH ENVIRONMENT
 236 .TP 8
 237 .B GEDADATA
 238 specifies the search directory for Scheme and rc files.  The default
 239 is `${prefix}/share/gEDA'.
 240 .TP 8
 241 .B GEDADATARC
 242 specifies the search directory for rc files.  The default is `$GEDADATA'.
 243 .TP 8
 244 .B GEDALOG
 245 specifies the directory to which to write log files.  The default is
 246 `~/.gEDA/logs'.
 247
 248 .SH AUTHORS
 249 See the `AUTHORS' file included with this program.
 250
 251 .SH COPYRIGHT
 252 .nf
 253 Copyright \(co 1999-@YEAR@ gEDA Contributors.  License GPLv2+: GNU GPL
 254 version 2 or later.  Please see the `COPYING' file included with this
 255 program for full details.
 256 .PP
 257 This is free software: you are free to change and redistribute it.
 258 There is NO WARRANTY, to the extent permitted by law.
 259
 260 .SH SEE ALSO
 261 \fBgschem\fR(1), \fBgsymcheck\fR(1), \fBpcb\fR(1), \fBgnucap\fR(1)