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