# gEDA Tool Suite on-line documentation

## Tutorials

- gschem to pcb tutorial, by Bill Wilson.
- 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.

## gschem - Schematic Capture

- gschem User's Guide – also in transition, please comment
- gschem man-page
- Symbol Creation Guide
- Hooks/Scheme Extension HOWTO
- Keymapping in gschem HOWTO

## gnetlist - Netlister

- gnetlist User's Guide
- gnetlist man-page
- Spice netlisting (SDB) 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
- gschem2pcb 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 (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).

Testing:

- Circuit Simulation using gEDA and SPICE - HOWTO – Done converting. Please comment on this conversion to a wiki-format.

# ngspice

- NGSPICE User Manual – describes ngspice-rework-17, Draft Version 0.2
  Please report if this URL is not the appropriated version, or if it goes dead.
- ngspice man-page – note
- ngnutmeg man-page – note
- ngsconvert man-page – note

# gnucap

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

# gSpiceUI

- Please look inside the gSpiceUI tarball for documentation

# PCB

- The pcb FAQ: faq-pcb
- The official manual of pcb
- A very detailed manual on footprint creation by Stephen Meier and Stuart Brorson. It also covers most of the syntax of the *.pcb format. The document refers to the 2007 version of pcb.
- The man-page of pcb

# gerbv

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

# Icarus Verilog

- Getting Started with Icarus Verilog
- Icarus Verilog Mini How To
- Icarus Verilog compiler man-page
- Compile front end for VPI modules man-page
- Icarus Verilog vvp runtime engine man-page
- The Icarus Verilog Compilation System
- FPGA Loadable Code Generator for Icarus Verilog
- Xilinx Hints
- Xilinx Netlist Format
- Icarus Verilog vs. IEEE1364
- Icarus Attribute Naming Conventions
- Icarus Verilog Extensions
- Icarus Verilog Glossary
- Executable Instruction Opcodes
- VPI_within_VVP
- VVP Simulation Engine

# GTKWave

- Welcome to GTKWave – Now for version 3.0 (the promoted version 1.3)
- Visualization tool for VCD, LXT, and VZT files (gtkwave)
- Data mining of LXT2 files (lxt2miner)
- Coverts LXT2 files to VCD (lxt2vcd)
- Coverts MVLSIM AET files to LXT (mvl2lxt)
- Coverts MVLSIM AET files to VCD (mvl2vcd)
- Coverts TEXSIM AET files to VCD (tex2vcd)
- Converts TLA to VCD or LST files (tla2vcd)
- Converts VCD files to interlaced or linear LXT files (vcd2lxt)
- Converts VCD files to LXT2 files (vcd2lxt2)
- Converts VCD files to VZT files (vcd2vzt)
- Coverts VZT files to VCD (vzt2vcd)
- Data mining of VZT files (vztminer)

# Wcalc

- Wcalc README
- Wcalc man-page
- stdio Wcalc man-page

# mcalc

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

# covered

- 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

# For document authors

New features are available for document authors:

- Syntax features
- Installed plugins
- Style Guide – A work in progress, please contribute