gnetlist(1)

📦 version 1.10.2, in nixos 26.05

💖 gnetlist — the netlist extraction and generation queen 💖

okay so bestie, welcome to gnetlist, part of the gEDA (GPL Electronic Design Automation) toolset, manual page from the gEDA/gaf collection, version 1.10.2.20201216. she's iconic, she's essential, and she's here to turn your schematics into netlists. periodt. 💅✨

🌸 NAME 🌸

gnetlist — gEDA/gaf Netlist Extraction and Generation. no cap, that's literally her whole brand.

🦋 SYNOPSIS 🦋

gnetlist [OPTION...] [-p BACKEND|-g BACKEND] [--] FILE...

like, that's the vibe check right there. options, a backend (Python or Scheme, pick your fighter), then your schematic files. easy. 🎀

✨ DESCRIPTION ✨

okay so gnetlist is a netlist extraction and generation tool, and she's part of the gEDA (GPL Electronic Design Automation) toolset. think of her as the main character who takes one or multiple electronic schematics as input and outputs a netlist. and what's a netlist? it's a machine-interpretable description of the way that components in an electronic circuit are connected together — and it's commonly used as the input to a PCB layout program such as pcb(1) or to a simulator such as gnucap(1). literally the glue between your design and the real world. 🌈

a normal gnetlist run is carried out in two steps. first, the gnetlist frontend loads the specified human-readable schematic FILEs and compiles them to an in-memory netlist description. then, a BACKEND is used to export the connection and component data to one of many supported netlist formats. two steps, no stress, she ate. 💖

and the best part? gnetlist is extensible in Python and Scheme. so you can add your own backends and make her do even more. obsessed. 🧚

🎀 GENERAL OPTIONS 🎀

  • -q — Quiet mode. Turns off all warnings/notes/messages. lowkey perfect when you just want her to do her thing in silence. 🙈
  • -v, --verbose — Verbose mode. Output all diagnostic information. she's gonna tell you everything, bestie. 💀
  • -L DIRECTORY — Prepend DIRECTORY to the list of directories to be searched for Python backends, Scheme backends, and other Scheme files. like adding extra spots to your fave playlist. 📁
  • -p BACKEND — Specify the Python netlist backend to be used. this is your Python girlie. 🐍
  • -g BACKEND — Specify the Scheme netlist backend to be used. and this is your Scheme girlie. 🧠
  • -O STRING — Pass an option string to the backend. give your backend a little note, a little tip, a little STRING. 💌
  • --list-backends — Print a list of available netlist backends. A backend name is prefixed with the letters P and G in brackets if it is available as a Python and as a Scheme backend, respectively. so [P] = Python, [G] = Scheme, and both = she's versatile. 👑
  • -o FILE — Specify the filename for the generated netlist. By default, output is directed to output.net. If - is given instead of a filename, the output is directed to the standard output. so you can pipe her straight into another command, slay. 🌟
  • -l FILE — Specify a Scheme file to be loaded before the backend is loaded or executed. This option can be specified multiple times. load her up with pre-backend Scheme files, as many as you want. 🎀
  • -m FILE — Specify a Scheme file to be loaded between loading the backend and executing it. This option can be specified multiple times. the in-between moment, the little pause for extra Scheme. 🦋
  • -c EXPR — Specify a Scheme expression to be executed during gnetlist startup. This option can be specified multiple times. like a little spell you cast at the beginning. ✨
  • -i — After the schematic files have been loaded and the netlist generated, enter an interactive Python interpreter. The netlist structure is available as netlist in the local dictionary. literally a Python prompt with your netlist right there. main character energy. 💻
  • --report-gui — Report warnings and errors in a GUI dialog. because sometimes you want your problems in a pop-up window. 😭
  • -h, --help — Print a help message. when you're lost, she'll guide you. 🫶
  • -V, --version — Print gnetlist version information. know your queen's version. 💅
  • -- — Treat all remaining arguments as schematic filenames. Use this if you have a schematic filename which begins with -. protect her from confusion. 🛡️

🔥 BACKENDS 🔥

Currently, gnetlist includes the following backends. and honestly? the range. the versatility. she's giving range. 🌈

  • allegro — Allegro netlist format. 🎵
  • bae — Bartels Autoengineer netlist format. 🚗
  • bom, bom2 — Bill of materials generation. know exactly what you need to buy. 🛒
  • calay — Calay netlist format. 📞
  • cascade — RF Cascade netlist format. 📶
  • drc, drc2 — Design rule checkers (drc2 is recommended). check those rules, bestie. ✅
  • dumpindent, dumpjson, dumplihata, dumptext, dumpxml — Dump the netlist in various generic formats. the dump squad. 🗑️✨
  • eagle — Eagle netlist format. 🦅
  • ewnet — Netlist format for National Instruments ULTIboard layout tool. 🇺🇸
  • futurenet2 — Futurenet2 netlist format. 🔮
  • geda — Internal gEDA netlist format (used for testing and diagnostics). the home team. 🏠
  • gossip — Gossip netlist format. spill the tea. ☕
  • gsch2pcb — Backend used for pcb(1) file layout generation by gsch2pcb(1). It is not recommended to use this backend directly. like, let gsch2pcb handle it, okay? 🙅‍♀️
  • guile — Compatibility layer for old backends written in Scheme. respect the elders. 🧓
  • liquidpcb — LiquidPCB netlist format. 💧
  • makedpend — Auto-generate dependencies for Makefiles. make dependency management easy. 🛠️
  • mathematica — Netlister for analytical circuit solving using Mathematica. big brain energy. 🧮
  • maxascii — MAXASCII netlist format. 🔤
  • osmond — Osmond netlist format. 🍊
  • pads — PADS netlist format. 📋
  • partslist1, partslist2, partslist3 — Bill of materials generation backends (alternatives to bom and bom2). more BOM options, more choices. 📝
  • PCB — pcb(1) netlist format. the classic. 🖥️
  • pcbfwd — Internally used by pcb(1)'s "Import Schematics" mechanism. behind the scenes. 🎬
  • pcbpins — Generates a pcb(1) action file for forward annotating pin/pad names from schematic to layout. pin it, pad it, annotate it. 📍
  • protelII — Protel II netlist format. 👑
  • redac — RACAL-REDAC netlist format. 📡
  • spice, spice-sdb, spice-noqsi — SPICE-compatible netlist format (spice-sdb and spice-noqsi are recommended). Suitable for use with gnucap(1). spice up your simulation life. 🌶️
  • switcap — SWITCAP switched capacitor simulator netlist format. ⚡
  • systemc — Structural SystemC code generation. 🧩
  • tango — Tango netlist format. 💃
  • tedax — tEDAx netlist format (used by pcb-rnd(1)). 🤖
  • vams — VHDL-AMS code generation. 📐
  • verilog — Verilog code generation. 🧬
  • vhdl — VHDL code generation. 🏗️
  • vipec — ViPEC Network Analyser netlist format. 🕸️

🧚 EXAMPLES 🧚

These examples assume that you have a schematic file stack_1.sch in the current directory. okay? okay. let's go. 💖

gnetlist requires that at least one schematic and either a Python backend, a Scheme backend, or interactive mode are specified on the command line. If a backend name is specified with -p BACKEND (for a Python backend) or -g BACKEND (for a Scheme backend), gnetlist will output a netlist:

gnetlist -p dumptext stack_1.sch

The netlist output will be written to a file called output.net in the current working directory. default behavior, and she ate. ✨

You can specify the output filename by using the -o option:

gnetlist -p dumptext -o /tmp/stack.netlist stack_1.sch

Output will now be directed to /tmp/stack.netlist. name it and claim it. 🎀

You could run (for example) the spice-sdb backend against the schematic if you specified -p spice-sdb, or you could generate a bill of materials for the schematic using -p partslist1. options, options, options. 🌈

To obtain a Python prompt to run Python commands directly, you can use the -i option:

gnetlist -i stack_1.sch

gnetlist will load stack_1.sh and then enter an interactive Python interpreter. The netlist structure is available as netlist in the local dictionary. so you can poke around, inspect, and vibe. 🐍💬

🌸 ENVIRONMENT 🌸

  • GEDADATA — specifies the search directory for Scheme and rc files. The default is ${prefix}/share/gEDA. her home base. 🏡
  • GEDADATARC — specifies the search directory for rc files. The default is $GEDADATA. follows the leader. 🧭

🫶 AUTHORS 🫶

See the AUTHORS file included with this program. the whole squad. 👯‍♀️

Copyright © 1999-2020 gEDA Contributors. License GPLv2+: GNU GPL version 2 or later. Please see the COPYING file included with this program for full details. 📜

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. like, none. zero. protect yourself. ⚠️

🔗 SEE ALSO 🔗

gschem(1), gsymcheck(1), pcb(1), pcb-rnd(1), gnucap(1)

that's the whole page, bestie. now go make some netlists and slay. 💅✨🎀🦋🌸💖

signing off from the gEDA Project — December 16, 2020 — this was gnetlist(1), and she's iconic. periodt. 🫶

📦 where this page comes from