docs/wiki/geda-gnetlist_mp.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html>
   4 <head>
   5   <title></title>
   6   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   7   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   8   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   9
  10   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  11 </head>
  12 <body>
  13
  14
  15 <h1 class="sectionedit844"><a name="gnetlist_man-page" id="gnetlist_man-page">gnetlist man-page</a></h1>
  16 <div class="level1">
  17 <pre class="code">gnetlist(1)                      20031231                        gnetlist(1)
  18
  19
  20
  21 NAME
  22        gnetlist - gEDA/gaf Netlist extraction/generation
  23
  24 SYNOPSIS
  25        gnetlist  [-i] [-I] [-q] [-s] [-v] [-l schem_file] [-m schem_file ] [-g
  26        guile_procedure] [-c scheme_string ]  [-o  output_filename]  schematic1
  27        [... schematicN]
  28
  29 DESCRIPTION
  30        gnetlist  is  the  netlist  extraction/generation program which is part
  31        gEDA (GPL Electronic Design Automation) toolset.  This program takes  a
  32        schematic for its input and outputs a netlist.
  33
  34        gnetlist  depends heavily on guile (a scheme based scripting language).
  35        It uses guile to define the output format.  Basically gnetlist reads  a
  36        schematic,  creates  an  internal representation of the various connec-
  37        tions, and then a guile  script  extracts  the  connections  into  some
  38        netlist format.
  39
  40        gnetlist is very much so a work in progress.  Currently it supports the
  41        following backends:
  42
  43                1) Allegro netlist format (-g allegro)
  44
  45                2) BAE netlist format (-g bae)
  46
  47                3) BOM / BOM2 - Bill of Materials (-g bom and -g bom2)
  48
  49                4) Partslist 1,2,3 - More Bill of Materials (-g partslist[1-3])
  50
  51                5) DRC - Start of a design rule checker (-g drc)
  52
  53                6) DRC2 - A second design rule checker (-g drc2)
  54
  55                7) gEDA - native format, mainly used for testing (-g geda)
  56
  57                8) Gossip netlist format (-g gossip)
  58
  59                9) PADS netlist format (-g pads)
  60
  61                10) PCB / PCBboard (-g PCB and -g PCBboard)
  62
  63                11) gsch2pcb backend (-g gsch2pcb)
  64
  65                12) ProtelII netlist format (-g protelII)
  66
  67                13) Spice compatible netlist format (-g spice)
  68
  69                14) Enhanced spice compatible netlist format (-g spice-sdb)
  70
  71                15) Switcap netlist format (-g switcap)
  72
  73                16) Tango netlist format (-g tango)
  74
  75                17) Verilog code (-g verilog)
  76
  77                18) VHDL code (-g vhdl)
  78
  79                19) VIPEC netlist format (-g vipec)
  80
  81                20) Bartels Autoengineer netlist format (-g bae)
  82
  83                21) GOSSIP system simulation system netlist format (-g gossip)
  84
  85                22) MAXASCII netlist format (-g maxascii)
  86
  87                23) VHDL-AMS netlist format (-g vams)
  88
  89                24) Futurenet2 netlist format (-g futurenet2 )
  90
  91                25)  SWITCAP  switched  capacitor  simulator netlist format (-g
  92        switcap )
  93
  94                26) RF Cascade netlist format (-g cascade )
  95
  96                27) RACAL-REDAC netlist format (-g redac )
  97
  98                28) PCB actions file for forward annotating pin/pad names  from
  99                 schematic to layout (-g pcbpins)
 100
 101
 102        For more info on these formats please look at the README.*
 103
 104        Please  read  the  official  (non-existant) documentation on how to use
 105        gnetlist, since this man page just describes the command line arguments
 106        and a few examples on how to run gnetlist.
 107
 108
 109 OPTIONS
 110        gnelist accepts the following options:
 111
 112        -q      Quiet  mode  on.   This  mode turns off all warnings/notes/mes-
 113                sages. (optional)
 114
 115        -v      Verbose mode on.  This mode gives as much feedback to the  user
 116                as possible. (optional)
 117
 118        -g guile_procedure
 119                Specify  the  guile  procedure  which is executed to create the
 120                netlist.
 121
 122        -o output_filename
 123                Specify the filename which will contain the  netlist  generated
 124                by gnetlist.  If this option is not specified the default file-
 125                name is &quot;output.net&quot;.
 126
 127        -l scheme_file
 128                Specify a filename which contains scheme code to be loaded  and
 129                execute  before  any  backend  is loaded or any guile procedure
 130                (using -g flag) is executed.  This flag can be specified multi-
 131                ple times and can be used to pass information to backends.
 132
 133        -m scheme_file
 134                Specify  a filename which contains scheme code to be loaded and
 135                execute after the backend is loaded but still before any  guile
 136                procedure (using -g flag) is executed.  This flag can be speci-
 137                fied multiple times and can be  used  to  pass  information  to
 138                backends.   This flag, for example, allows the user to override
 139                variables inside of the backends (such as paths).
 140
 141        -c string
 142                Pass the specified  string  to  the  guile  interpreter.   This
 143                allows  you to execute arbitrary guile scripts from the command
 144                line.  Be sure to surround the string  with  either  single  or
 145                double  quotes  to  satisfy  your shell.  The string is execute
 146                before any init or netlist backend scheme  code  is  loaded  or
 147                executed.
 148
 149        -I      Put  .INCLUDE &lt;filename&gt; in output file instead of model file’s
 150                contents.
 151
 152        -i      Interactive mode.  After the schematic is read  in  and  parsed
 153                then  go  into  interactive  mode.  Interactive mode allows the
 154                user to execute guile procedures directly.
 155
 156        -s      Sort output netlist (for Gnucap)
 157
 158        schematic1 [... schematicN]
 159                At least one schematic file must  be  specified.   If  multiple
 160                schematics are specified then they are sequentially read in and
 161                parsed with the assumption that they are all part of  the  same
 162                design.   It  is important that the schematic(s) follow all the
 163                options (ie last).
 164
 165
 166 EXAMPLES
 167        These examples assume that you have a stack_1.sch in the current direc-
 168        tory.
 169
 170        gnetlist  requires  that  at least one schematic to be specified on the
 171        command line:
 172
 173             ./gnetlist stack_1.sch
 174
 175        This is not very useful since it does not direct gnetlist to do
 176        anything.
 177
 178        Specify a guile procedure name to get gnetlist to output a netlist:
 179
 180             ./gnetlist -g geda stack_1.sch
 181
 182        The netlist output will be written to a file called &quot;output.net&quot;
 183        in the current working directory.
 184
 185        You can specify the output filename by using the -o flag:
 186
 187             ./gnetlist -g geda stack_1.sch -o stack.netlist
 188
 189        The spice backend is run against the schematic(s) if you specify
 190        -g spice and the tango backend is run if you specify -g tango.
 191
 192        To interact with the guile interpreter:
 193
 194             ./gnetlist -i stack_1.sch
 195
 196        You will get a prompt where you can execute guile procedures.
 197
 198        To get a more verbose feedback as to what gnetlist is doing run
 199        with the -v flag:
 200
 201             ./gnetlist -v -g geda stack_1.sch
 202
 203
 204 ENVIRONMENT
 205        No environment variables are used.
 206
 207
 208 AUTHOR
 209        Ales Hvezda and many others
 210
 211
 212 SEE ALSO
 213        gschem(1), gsymcheck(1)
 214
 215 COPYRIGHT
 216        Copyright ©  1999-2004 Ales Hvezda
 217
 218        This document can be freely redistributed according to the terms of the
 219        GNU General Public License version 2.0
 220
 221
 222
 223
 224 Version                       December 31st, 2003                  gnetlist(1)</pre>
 225
 226 </div>
 227 </body>
 228 </html>