docs/wiki/geda-documentation.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   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   6   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   7   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   8
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10 </head>
  11 <body>
  12
  13 <p>
  14 <a href="start.html" class="wikilink1" title="start.html">gEDA</a> &gt;&gt; <a href="geda-documentation.html" class="wikilink1" title="geda-documentation.html">Documentation</a>
  15 </p>
  16
  17 <p>
  18 <em>Translations of this page are also available in the following languages:</em> <a href="geda-documentation.ru.html" class="wikilink1" title="geda-documentation.ru.html">Русский</a>.
  19 </p>
  20
  21 <h1 id="gedatoolsuitedocumentation">gEDA Tool Suite documentation</h1>
  22 <div class="level1">
  23
  24 <p>
  25 These are the official project docs.  They have been converted from LaTeX and HTML documents into Wiki pages so that the gEDA community may more easily maintain them.
  26 </p>
  27
  28 </div>
  29
  30 <h2 id="tutorials">Tutorials</h2>
  31 <div class="level2">
  32 <ul>
  33 <li class="level1"><div class="li"> <a href="geda-gsch2pcb_tutorial.html" class="wikilink1" title="geda-gsch2pcb_tutorial.html">gschem to pcb tutorial</a>, by Bill Wilson (<a href="geda-gsch2pcbtutorialreleasenotes.html" class="wikilink2" title="geda-gsch2pcbtutorialreleasenotes.html">release notes</a>).</div>
  34 </li>
  35 <li class="level1"><div class="li"> <a href="geda-gschem_warmup.html" class="wikilink1" title="geda-gschem_warmup.html">gschem warmup</a>, by Bill Willson.</div>
  36 </li>
  37 <li class="level1"><div class="li"> <a href="geda-transistor_guide.html" class="wikilink1" title="geda-transistor_guide.html">gschem Symbol and PCB Element Transistor Guide</a>, by Bill Willson.</div>
  38 </li>
  39 <li class="level1"><div class="li"> PCB tutorial, by DJ Delorie.</div>
  40 </li>
  41 <li class="level1"><div class="li"> <a href="geda-ngspiceandgschem.html" class="wikilink2" title="geda-ngspiceandgschem.html">ngspice and gschem</a></div>
  42 </li>
  43 <li class="level1"><div class="li"> <a href="geda-tragesym_tutorial.html" class="wikilink1" title="geda-tragesym_tutorial.html">tragesym tutorial</a> on how to create symbols with the tragesym script.</div>
  44 </li>
  45 <li class="level1"><div class="li"> <a href="geda-gnetlistschemetutorial.html" class="wikilink2" title="geda-gnetlistschemetutorial.html">Scripting a gnetlist backend in scheme</a> by John Doty.</div>
  46 </li>
  47 <li class="level1"><div class="li"> <a href="geda-hierarchy.html" class="wikilink1" title="geda-hierarchy.html">Using hierarchy in schematics</a></div>
  48 </li>
  49 <li class="level1"><div class="li"> <a href="geda-xorn_getting_started.html" class="wikilink1" title="geda-xorn_getting_started.html">Getting started with Xorn</a></div>
  50 </li>
  51 </ul>
  52
  53 </div>
  54
  55 <h2 id="talks">Talks</h2>
  56 <div class="level2">
  57
  58 <p>
  59 Various talks and presentations on gEDA provide a good top-level overview of the project for those who are interested:
  60 </p>
  61
  62 <p>
  63 gEDA session
  64 DJ Delorie did at Renesas DevCon 2010 (the slides for it are
  65 here under “Presentations and Other Info”)
  66 </p>
  67
  68 <p>
  69 Ignite 5 video
  70 given by Stuart Brorson about “Hardware design and the gEDA Project”
  71 </p>
  72
  73 </div>
  74
  75 <h2 id="general">General</h2>
  76 <div class="level2">
  77
  78 <p>
  79 These are informal FAQs, HOWTOs, and tips/tricks to help you with the practical details of using the gEDA Suite.  If you are having a problem, browse these pages first.
  80 </p>
  81 <ul>
  82 <li class="level1"><div class="li"> <a href="geda-glossary.html" class="wikilink1" title="geda-glossary.html">Glossary</a> : Glossary of terms that are specific to the gEDA Suite.</div>
  83 </li>
  84 <li class="level1"><div class="li"> <a href="geda-usage.html" class="wikilink1" title="geda-usage.html">Usage</a> : Questions about how to do electronic design using the gEDA toolset -- information which applies to several or all tools in the gEDA Suite.</div>
  85 </li>
  86 <li class="level1"><div class="li"> <a href="geda-faq-gschem.html" class="wikilink1" title="geda-faq-gschem.html">FAQ-gschem</a> : Questions about installing, configuring, and using gschem.  Also, questions about creating and using gschem symbols.</div>
  87 </li>
  88 <li class="level1"><div class="li"> <a href="geda-faq-attribs.html" class="wikilink1" title="geda-faq-attribs.html">FAQ-attribs</a> : Attribute management.</div>
  89 </li>
  90 <li class="level1"><div class="li"> <a href="geda-faq-gnetlist.html" class="wikilink1" title="geda-faq-gnetlist.html">FAQ-gnetlist</a> : Questions about installing, configuring, and using gnetlist. It deals with BOMs, DRCs, and all that.</div>
  91 </li>
  92 <li class="level1"><div class="li"> <a href="geda-faq-simulation.html" class="wikilink1" title="geda-faq-simulation.html">FAQ-simulation</a> : Questions about simulating your design using gEDA tools.</div>
  93 </li>
  94 <li class="level1"><div class="li"> <a href="geda-faq-gsch2pcb.html" class="wikilink1" title="geda-faq-gsch2pcb.html">FAQ-gsch2pcb</a> : How to take your design to layout using PCB.</div>
  95 </li>
  96 <li class="level1"><div class="li"> <a href="geda-pcb-quickreference.html" class="wikilink2" title="geda-pcb-quickreference.html">PCB-quick reference</a> : PCB Quick Reference Sheet.</div>
  97 </li>
  98 <li class="level1"><div class="li"> <a href="geda-pcbfootprints.html" class="wikilink2" title="geda-pcbfootprints.html">PCB footprints</a> : How to create, use and share footprints.</div>
  99 </li>
 100 <li class="level1"><div class="li"> <a href="geda-pcbtips.html" class="wikilink2" title="geda-pcbtips.html">PCB tips</a> : Tips and tricks for using PCB.</div>
 101 </li>
 102 <li class="level1"><div class="li"> <a href="geda-guilescripting.html" class="wikilink2" title="geda-guilescripting.html">Guile scripting</a> : Guile functions &amp; variables provided by the gEDA tools.</div>
 103 </li>
 104 <li class="level1"><div class="li"> <a href="geda-symbols.html" class="wikilink1" title="geda-symbols.html">Symbol guide</a> : Symbols and attributes explained</div>
 105 </li>
 106 </ul>
 107 <ul>
 108 <li class="level1"><div class="li"> <a href="geda-gaf.html" class="wikilink1" title="geda-gaf.html">gaf</a></div>
 109 </li>
 110 <li class="level1"><div class="li"> <a href="geda-gafutility.html" class="wikilink2" title="geda-gafutility.html">gaf utility</a></div>
 111 </li>
 112 <li class="level1"><div class="li"> <a href="geda-hsehowto.html" class="wikilink2" title="geda-hsehowto.html">HSE Howto</a></div>
 113 </li>
 114 <li class="level1"><div class="li"> <a href="geda-pcbfootprintnamingconventions.html" class="wikilink2" title="geda-pcbfootprintnamingconventions.html">PCB Footprint Naming Conventions</a></div>
 115 </li>
 116 <li class="level1"><div class="li"> <a href="geda-spicepolys.html" class="wikilink2" title="geda-spicepolys.html">Spice polys</a></div>
 117 </li>
 118 </ul>
 119
 120 </div>
 121
 122 <h2 id="gschem-schematiccapture">gschem - Schematic Capture</h2>
 123 <div class="level2">
 124 <ul>
 125 <li class="level1"><div class="li"> <strong><a href="geda-gschem_ug.html" class="wikilink1" title="geda-gschem_ug.html">gschem User&#039;s Guide</a></strong></div>
 126 </li>
 127 <li class="level1"><div class="li"> <a href="geda-gschem_symbol_creation.html" class="wikilink1" title="geda-gschem_symbol_creation.html">Symbol Creation Guide</a></div>
 128 </li>
 129 <li class="level1"><div class="li"> <a href="geda-gschem_symbol_generators.html" class="wikilink1" title="geda-gschem_symbol_generators.html">Symbol generators for gschem</a></div>
 130 </li>
 131 </ul>
 132
 133 </div>
 134
 135 <h2 id="gnetlist-netlister">gnetlist - Netlister</h2>
 136 <div class="level2">
 137 <ul>
 138 <li class="level1"><div class="li"> <strong><a href="geda-gnetlist_ug.html" class="wikilink1" title="geda-gnetlist_ug.html">gnetlist User&#039;s Guide</a></strong></div>
 139 </li>
 140 <li class="level1"><div class="li"> <a href="geda-gnetlistschemeprimitives.html" class="wikilink2" title="geda-gnetlistschemeprimitives.html">gnetlist Scheme primitives</a></div>
 141 </li>
 142 <li class="level1"><div class="li"> <a href="geda-csygas.html" class="wikilink1" title="geda-csygas.html">Circuit Simulation using gEDA and SPICE - HOWTO</a></div>
 143 </li>
 144 <li class="level1"><div class="li"> <a href="geda-na_howto.html" class="wikilink1" title="geda-na_howto.html">net= attribute mini-HOWTO</a></div>
 145 </li>
 146 <li class="level1"><div class="li"> <a href="geda-ssan.html" class="wikilink1" title="geda-ssan.html">Switcap Symbols and Netlister</a></div>
 147 </li>
 148 <li class="level1"><div class="li"> <a href="geda-sn_readme.html" class="wikilink1" title="geda-sn_readme.html">Switcap netlister README</a></div>
 149 </li>
 150 <li class="level1"><div class="li"> <a href="geda-fbabgapp.html" class="wikilink1" title="geda-fbabgapp.html">Forward/Backward Annotation Between gEDA and Pads PowerPCB</a></div>
 151 </li>
 152 <li class="level1"><div class="li"> <a href="geda-grcsan.html" class="wikilink1" title="geda-grcsan.html">gEDA RF Cascade Symbols and Netlister</a></div>
 153 </li>
 154 <li class="level1"><div class="li"> <a href="geda-bom_readme.html" class="wikilink1" title="geda-bom_readme.html">Bill of Material netlister README</a></div>
 155 </li>
 156 <li class="level1"><div class="li"> <a href="geda-verilog_netlister_readme.html" class="wikilink1" title="geda-verilog_netlister_readme.html">Verilog netlister README</a></div>
 157 </li>
 158 <li class="level1"><div class="li"> <a href="geda-vhdl_netlister_readme.html" class="wikilink1" title="geda-vhdl_netlister_readme.html">VHDL netlister README</a></div>
 159 </li>
 160 <li class="level1"><div class="li"> <a href="geda-vams_netlister_readme.html" class="wikilink1" title="geda-vams_netlister_readme.html">VAMS netlister README</a></div>
 161 </li>
 162 <li class="level1"><div class="li"> <a href="geda-systemc_netlister_readme.html" class="wikilink1" title="geda-systemc_netlister_readme.html">SystemC netlister README</a></div>
 163 </li>
 164 <li class="level1"><div class="li"> <a href="geda-eagle_pcb_netlister_readme.html" class="wikilink1" title="geda-eagle_pcb_netlister_readme.html">Eagle PCB netlister README</a></div>
 165 </li>
 166 </ul>
 167
 168 </div>
 169
 170 <h2 id="gsymcheck-symbolchecker">gsymcheck - Symbol Checker</h2>
 171 <div class="level2">
 172 <ul>
 173 <li class="level1"><div class="li"> <a href="geda-gsymcheck_mp.html" class="wikilink1" title="geda-gsymcheck_mp.html">gsymcheck man-page</a></div>
 174 </li>
 175 </ul>
 176
 177 </div>
 178
 179 <h2 id="utils-gedautilities">utils - gEDA Utilities</h2>
 180 <div class="level2">
 181 <ul>
 182 <li class="level1"><div class="li"> <a href="geda-gsch2pcb_readme.html" class="wikilink1" title="geda-gsch2pcb_readme.html">gsch2pcb (gschem to PCB) README</a></div>
 183 </li>
 184 <li class="level1"><div class="li"> <a href="geda-gsch2pcb_tutorial.html" class="wikilink1" title="geda-gsch2pcb_tutorial.html">gsch2pcb tutorial</a></div>
 185 </li>
 186 <li class="level1"><div class="li"> <a href="geda-tragesym_readme.html" class="wikilink1" title="geda-tragesym_readme.html">tragesym (symbol generator) README</a></div>
 187 </li>
 188 <li class="level1"><div class="li"> <a href="geda-tragesym_tutorial.html" class="wikilink1" title="geda-tragesym_tutorial.html">tragesym Tutorial</a></div>
 189 </li>
 190 <li class="level1"><div class="li"> <a href="geda-olib_readme.html" class="wikilink1" title="geda-olib_readme.html">olib (OrCAD (TM) converter) README</a></div>
 191 </li>
 192 <li class="level1"><div class="li"> <a href="geda-grenum_mp.html" class="wikilink1" title="geda-grenum_mp.html">grenum man-page</a> -- note</div>
 193 </li>
 194 <li class="level1"><div class="li"> <a href="geda-gattrib_readme.html" class="wikilink1" title="geda-gattrib_readme.html">gattrib README</a> -- note</div>
 195 </li>
 196 </ul>
 197
 198 </div>
 199
 200 <h2 id="examples">Examples</h2>
 201 <div class="level2">
 202 <ul>
 203 <li class="level1"><div class="li"> <a href="geda-example_hsm.html" class="wikilink1" title="geda-example_hsm.html">Hierarchical SPICE model</a> -- note</div>
 204 </li>
 205 <li class="level1"><div class="li"> <a href="geda-example_usbjtag.html" class="wikilink1" title="geda-example_usbjtag.html">Example USB-based JTAG interface</a> -- note</div>
 206 </li>
 207 </ul>
 208
 209 </div>
 210
 211 <h2 id="attributefileformatdetails">Attribute/File Format Details</h2>
 212 <div class="level2">
 213 <ul>
 214 <li class="level1"><div class="li"> <a href="geda-master_attributes_list.html" class="wikilink1" title="geda-master_attributes_list.html">Master Attributes List</a></div>
 215 </li>
 216 <li class="level1"><div class="li"> <a href="geda-file_format_spec.html" class="wikilink1" title="geda-file_format_spec.html">sym/sch File Format Specification</a></div>
 217 </li>
 218 </ul>
 219
 220 </div>
 221
 222 <h1 id="spice">SPICE</h1>
 223 <div class="level1">
 224 <ul>
 225 <li class="level1"><div class="li"> Implicit Mixed-Mode Simulation of VLSI Circuits by Albert Tatum Davis (1991)<br/>
 226 Please report if this URL goes dead.</div>
 227 </li>
 228 <li class="level1 node"><div class="li"> <a href="geda-csygas.html" class="wikilink1" title="geda-csygas.html">Circuit Simulation using gEDA and SPICE - HOWTO</a><br/>
 229 The original versions of the document are available at:</div>
 230 <ul>
 231 <li class="level2"><div class="li"> Circuit Simulation using gEDA and SPICE - HOWTO (HTML version)<br/>
 232 by Stuart Brorson (20 December 2004).<br/>
 233 Please report if this URL is not the latest version.</div>
 234 </li>
 235 <li class="level2"><div class="li"> Circuit Simulation using gEDA and SPICE - HOWTO (PDF version)<br/>
 236 by Stuart Brorson (5 January 2005).</div>
 237 </li>
 238 </ul>
 239 </li>
 240 <li class="level1"><div class="li"> gEDA - ngspice cheat sheet including a mini how to use the XSPICE models</div>
 241 </li>
 242 </ul>
 243
 244 </div>
 245
 246 <h1 id="ngspice">ngspice</h1>
 247 <div class="level1">
 248 <ul>
 249 <li class="level1"><div class="li"> Ngspice home page</div>
 250 </li>
 251 <li class="level1"><div class="li"> ngspice User Manual</div>
 252 </li>
 253 <li class="level1"><div class="li"> <a href="geda-ngspiceandgschem.html" class="wikilink2" title="geda-ngspiceandgschem.html">ngspice and gschem</a></div>
 254 </li>
 255 <li class="level1"><div class="li"> <a href="geda-ngspice_mp.html" class="wikilink1" title="geda-ngspice_mp.html">ngspice man-page</a> -- note</div>
 256 </li>
 257 <li class="level1"><div class="li"> <a href="geda-ngnutmeg_mp.html" class="wikilink1" title="geda-ngnutmeg_mp.html">ngnutmeg man-page</a> -- note</div>
 258 </li>
 259 <li class="level1"><div class="li"> <a href="geda-ngsconvert_mp.html" class="wikilink1" title="geda-ngsconvert_mp.html">ngsconvert man-page</a> -- note</div>
 260 </li>
 261 </ul>
 262
 263 </div>
 264
 265 <h1 id="gnucap">gnucap</h1>
 266 <div class="level1">
 267 <ul>
 268 <li class="level1"><div class="li"> Gnucap home page</div>
 269 </li>
 270 <li class="level1"><div class="li"> The Gnu Circuit Analysis Package Users manual -- January 21,2004 version</div>
 271 </li>
 272 <li class="level1"><div class="li"> The Gnucap Model Compiler</div>
 273 </li>
 274 </ul>
 275
 276 </div>
 277
 278 <h1 id="gspiceui">gSpiceUI</h1>
 279 <div class="level1">
 280 <ul>
 281 <li class="level1"><div class="li"> gSpiceUI home page</div>
 282 </li>
 283 </ul>
 284
 285 </div>
 286
 287 <h1 id="pcb">PCB</h1>
 288 <div class="level1">
 289 <ul>
 290 <li class="level1"><div class="li"> PCB home page</div>
 291 </li>
 292 <li class="level1"><div class="li"> The pcb FAQ: <a href="geda-faq-pcb.html" class="wikilink1" title="geda-faq-pcb.html">faq-pcb</a></div>
 293 </li>
 294 <li class="level1"><div class="li"> The official manual of pcb</div>
 295 </li>
 296 <li class="level1"><div class="li"> A very detailed manual on footprint creation by Stephen Meier and Stuart Brorson. covers *.pcb file format.  Remains compatible with current file formats.</div>
 297 </li>
 298 <li class="level1"><div class="li"> The <a href="geda-pcb_mp.html" class="wikilink1" title="geda-pcb_mp.html">man-page of pcb</a></div>
 299 </li>
 300 <li class="level1"><div class="li"> HOWTO: <a href="geda-addagroundplanetoyourlayout.html" class="wikilink2" title="geda-addagroundplanetoyourlayout.html">Add a ground plane to your layout</a></div>
 301 </li>
 302 <li class="level1"><div class="li"> <a href="pcb-footprintgenerators.html" class="wikilink2" title="pcb-footprintgenerators.html">Footprint generators</a> for pcb</div>
 303 </li>
 304 <li class="level1"><div class="li"> <a href="pcb-plugins.html" class="wikilink1" title="pcb-plugins.html">plugins</a></div>
 305 </li>
 306 </ul>
 307
 308 </div>
 309
 310 <h1 id="gerbv">gerbv</h1>
 311 <div class="level1">
 312 <ul>
 313 <li class="level1"><div class="li"> gerbv home page</div>
 314 </li>
 315 <li class="level1"><div class="li"> <a href="geda-gerbv_mp.html" class="wikilink1" title="geda-gerbv_mp.html">gerbv man-page</a></div>
 316 </li>
 317 <li class="level1"><div class="li"> <a href="geda-gerbv_pnp_readme.html" class="wikilink1" title="geda-gerbv_pnp_readme.html">Searching for Parts and marking them on screen (in gerbv)</a></div>
 318 </li>
 319 </ul>
 320
 321 </div>
 322
 323 <h1 id="icarusverilog">Icarus Verilog</h1>
 324 <div class="level1">
 325 <ul>
 326 <li class="level1"><div class="li"> Icarus Verilog home page</div>
 327 </li>
 328 <li class="level1"><div class="li"> <a href="geda-icarus.html" class="wikilink1" title="geda-icarus.html">HOWTOs, READMEs, tutorials</a></div>
 329 </li>
 330 </ul>
 331
 332 </div>
 333
 334 <h1 id="wcalc">Wcalc</h1>
 335 <div class="level1">
 336 <ul>
 337 <li class="level1"><div class="li"> wcalc Home Page</div>
 338 </li>
 339 <li class="level1"><div class="li"> <a href="geda-wcalc_readme.html" class="wikilink1" title="geda-wcalc_readme.html">Wcalc README</a></div>
 340 </li>
 341 <li class="level1"><div class="li"> <a href="geda-wcalc_mp.html" class="wikilink1" title="geda-wcalc_mp.html">Wcalc man-page</a></div>
 342 </li>
 343 <li class="level1"><div class="li"> <a href="geda-wcalc_stdio_mp.html" class="wikilink1" title="geda-wcalc_stdio_mp.html">stdio Wcalc man-page</a></div>
 344 </li>
 345 </ul>
 346
 347 </div>
 348
 349 <h1 id="mcalc">mcalc</h1>
 350 <div class="level1">
 351 <ul>
 352 <li class="level1"><div class="li"> Microstrip Analysis/Synthesis Calculator -- latest documentation from sourceforge</div>
 353 </li>
 354 <li class="level1"><div class="li"> <a href="geda-mcalc_readme.html" class="wikilink1" title="geda-mcalc_readme.html">mcalc README</a></div>
 355 </li>
 356 </ul>
 357
 358 </div>
 359
 360 <h1 id="covered">covered</h1>
 361 <div class="level1">
 362 <ul>
 363 <li class="level1"><div class="li"> covered home page</div>
 364 </li>
 365 <li class="level1"><div class="li"> covered User Manual -- link to latest covered documentation on sourceforge</div>
 366 </li>
 367 <li class="level1"><div class="li"> <strong>covered Report Viewer</strong> -- available in the Help menu of the GUI report utility</div>
 368 </li>
 369 <li class="level1"><div class="li"> <a href="geda-covered__mp.html" class="wikilink2" title="geda-covered__mp.html">covered man-page</a></div>
 370 </li>
 371 </ul>
 372
 373 </div>
 374
 375 <h1 id="dataplottingandviewing">Data plotting and viewing</h1>
 376 <div class="level1">
 377 <ul>
 378 <li class="level1"><div class="li"> GTKWave -- Digital waveform viewer which reads LXT, LXT2, VZT, FST, and GHW files as well as standard Verilog VCD/EVCD files.</div>
 379 </li>
 380 <li class="level1"><div class="li">  gwave -- analog waveform viewer</div>
 381 </li>
 382 <li class="level1"><div class="li"> gaw -- analog waveform viewer, a rewrite of gwave</div>
 383 </li>
 384 <li class="level1"><div class="li"> KJWaves -- viewing, modifying, and simulating SPICE CIRCUIT files</div>
 385 </li>
 386 </ul>
 387
 388 </div>
 389
 390 <h1 id="interactionwithotheredatools">Interaction with other EDA tools</h1>
 391 <div class="level1">
 392 <ul>
 393 <li class="level1"><div class="li"> <a href="geda-conversionutilities.html" class="wikilink2" title="geda-conversionutilities.html">Conversion utilities</a> for importing other EDA tools&#039; data.</div>
 394 </li>
 395 </ul>
 396
 397 </div>
 398 </body>
 399 </html>