gEDA » Documentation

Translations of this page are also available in the following languages: Русский.

# gEDA Tool Suite documentation

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.

## Tutorials

- gschem to pcb tutorial, by Bill Wilson (release notes).
- gschem warmup, by Bill Willson.
- gschem Symbol and PCB Element Transistor Guide, by Bill Willson.
- PCB tutorial, by DJ Delorie.
- ngspice and gschem
- tragesym tutorial on how to create symbols with the tragesym script.
- Scripting a gnetlist backend in scheme by John Doty.
- Using hierarchy in schematics
- Getting started with Xorn

## Talks

Various talks and presentations on gEDA provide a good top-level overview of the project for those who are interested:

gEDA session DJ Delorie did at Renesas DevCon 2010 (the slides for it are here under “Presentations and Other Info”)

Ignite 5 video given by Stuart Brorson about “Hardware design and the gEDA Project”

## General

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.

- Glossary : Glossary of terms that are specific to the gEDA Suite.
- Usage : Questions about how to do electronic design using the gEDA toolset – information which applies to several or all tools in the gEDA Suite.
- FAQ-gschem : Questions about installing, configuring, and using gschem. Also, questions about creating and using gschem symbols.
- FAQ-attribs : Attribute management.
- FAQ-gnetlist : Questions about installing, configuring, and using gnetlist. It deals with BOMs, DRCs, and all that.
- FAQ-simulation : Questions about simulating your design using gEDA tools.
- FAQ-gsch2pcb : How to take your design to layout using PCB.
- PCB-quick reference : PCB Quick Reference Sheet.
- PCB footprints : How to create, use and share footprints.
- PCB tips : Tips and tricks for using PCB.
- Guile scripting : Guile functions & variables provided by the gEDA tools.
- Symbol guide : Symbols and attributes explained

- gaf
- gaf utility
- HSE Howto
- PCB Footprint Naming Conventions
- Spice polys

## gschem - Schematic Capture

- gschem User's Guide
- Symbol Creation Guide
- Symbol generators for gschem

## gnetlist - Netlister

- gnetlist User's Guide
- gnetlist Scheme primitives
- Circuit Simulation using gEDA and SPICE - HOWTO
- net= attribute mini-HOWTO
- Switcap Symbols and Netlister
- Switcap netlister README
- Forward/Backward Annotation Between gEDA and Pads PowerPCB
- gEDA RF Cascade Symbols and Netlister
- Bill of Material netlister README
- Verilog netlister README
- VHDL netlister README
- VAMS netlister README
- SystemC netlister README
- Eagle PCB netlister README

## gsymcheck - Symbol Checker

- gsymcheck man-page

## utils - gEDA Utilities

- gsch2pcb (gschem to PCB) README
- gsch2pcb tutorial
- tragesym (symbol generator) README
- tragesym Tutorial
- olib (OrCAD (TM) converter) README
- grenum man-page – note
- gattrib README – note

## Examples

- Hierarchical SPICE model – note
- Example USB-based JTAG interface – note

## Attribute/File Format Details

- Master Attributes List
- sym/sch File Format Specification

# SPICE

- Implicit Mixed-Mode Simulation of VLSI Circuits by Albert Tatum Davis (1991)
  Please report if this URL goes dead.
- Circuit Simulation using gEDA and SPICE - HOWTO
  The original versions of the document are available at:
  - Circuit Simulation using gEDA and SPICE - HOWTO (HTML version)
    by Stuart Brorson (20 December 2004).
    Please report if this URL is not the latest version.
  - Circuit Simulation using gEDA and SPICE - HOWTO (PDF version)
    by Stuart Brorson (5 January 2005).
- gEDA - ngspice cheat sheet including a mini how to use the XSPICE models

# ngspice

- Ngspice home page
- ngspice User Manual
- ngspice and gschem
- ngspice man-page – note
- ngnutmeg man-page – note
- ngsconvert man-page – note

# gnucap

- Gnucap home page
- The Gnu Circuit Analysis Package Users manual – January 21,2004 version
- The Gnucap Model Compiler

# gSpiceUI

- gSpiceUI home page

# PCB

- PCB home page
- The pcb FAQ: faq-pcb
- The official manual of pcb
- A very detailed manual on footprint creation by Stephen Meier and Stuart Brorson. covers *.pcb file format. Remains compatible with current file formats.
- The man-page of pcb
- HOWTO: Add a ground plane to your layout
- Footprint generators for pcb
- plugins

# gerbv

- gerbv home page
- gerbv man-page
- Searching for Parts and marking them on screen (in gerbv)

# Icarus Verilog

- Icarus Verilog home page
- HOWTOs, READMEs, tutorials

# Wcalc

- wcalc Home Page
- Wcalc README
- Wcalc man-page
- stdio Wcalc man-page

# mcalc

- Microstrip Analysis/Synthesis Calculator – latest documentation from sourceforge
- mcalc README

# covered

- covered home page
- covered User Manual – link to latest covered documentation on sourceforge
- covered Report Viewer – available in the Help menu of the GUI report utility
- covered man-page

# Data plotting and viewing

- GTKWave – Digital waveform viewer which reads LXT, LXT2, VZT, FST, and GHW files as well as standard Verilog VCD/EVCD files.
- gwave – analog waveform viewer
- gaw – analog waveform viewer, a rewrite of gwave
- KJWaves – viewing, modifying, and simulating SPICE CIRCUIT files

# Interaction with other EDA tools

- Conversion utilities for importing other EDA tools' data.