gsymcheck(1)

📦 version 1.10.2, in nixos 26.05

💖 gsymcheck — the gEDA/gaf Symbol Checker 💖

hiii bestie, welcome to gsymcheck(1) ✨ this is from the gEDA Project, version 1.10.2.20201216, and yeah we're gonna read the whole thing together, no skimming, no cap 🫶

🌸 NAME 🌸

gsymcheck — the gEDA/gaf Symbol Checker. that's it, that's the vibe check for your symbols 💅

✨ SYNOPSIS ✨

gsymcheck [-h] [-v] [-q] symbol1 [...symbolN]

🦋 DESCRIPTION 🦋

okay so gsymcheck is a symbol checker for gEDA/gaf, and honestly it's giving "your friend who proofreads your essay before you submit it" energy 😭 here's the full list of checks it performs:

  • Checks for graphical= attribute (if present does varied tests)
  • Checks for the device= attribute
  • Checks for various other missing attributes (pinlabel, pintype, pinseq, footprint, refdes)
  • Checks to make sure that the active pin end is on the 100 unit grid
  • Checks the uses of the various attributes (duplicates, incorrect syntax, invalid values, etc...)
  • Checks for obsolete, old, and forbidden attributes
  • Checks for any nets or buses within a symbol
  • Checks for any other connections within a symbol
  • Checks to make sure the number of pins is the correct number

like it literally goes through everything 🔍 periodt.

💅 OPTIONS 💅

gsymcheck accepts the following options:

  • -q, --quiet — Quiet mode on. This mode turns off all warnings/notes/messages. (optional)
  • -v, --verbose — Verbose mode 1. This mode will show all error messages (optional)
  • -vv — Verbose mode 2. This mode will show all error and warning messages (optional)
  • -vvv — Verbose mode 2. This mode will show all error, warning, and info messages (optional)
  • -h, --help — Usage summary / gsymcheck help
  • symbol1 [...symbolN] — At least one symbol file must be specified. If multiple symbols are specified then they are sequentially read in and checked. It is important that the schematic(s) follow all the options (i.e. last).
⚠️ ngl bestie, that "schematic(s) follow all the options" thing is not a suggestion — put those symbol files last, like literally at the end, or the vibe check fails 🙈

🎀 EXAMPLES 🎀

Here are some examples on how to run gsymcheck:

To get usage information just run:

gsymcheck

To actually check a symbol with just error counts, run:

gsymcheck symbolfilename.sym

To get the actuall error messages, run:

gsymcheck -v symbolfilename.sym

To see all the error messages and warnings, run:

gsymcheck -vv symbolfilename.sym

To see all the error messages, warnings, and parse info, run:

gsymcheck -vvv symbolfilename.sym

see how it escalates? one -v, two -v, three -v… it's giving main character energy scaling with every letter 🔥

🌈 ENVIRONMENT 🌈

gsymcheck respects the following environment variable:

  • GEDADATA — specifies where the various required scheme and rc files are located (the default is ${prefix}/share/gEDA). This environment variables does not need to be set by the end user unless they are moving the executables to a new install ${prefix}.
  • GEDALOG specifies the directory to which to write log files. The default is ~/.gEDA/logs.
💜 lowkey note: GEDADATA is the one that's actually labeled as "the following environment variable" up there, and GEDALOG is right after it — both are respected, we're just keeping it 100% faithful to how the page says it 🫶

👑 AUTHOR 👑

Ales Hvezda and many others 💖 (yes, "and many others" — iconic collaborative queen behavior)

🔥 SEE ALSO 🔥

gschem(1), gnetlist(1)

go read those too, iykyk 😌

Copyright © 1999-2008 Ales Hvezda
Copyright © 1999-2020 gEDA Contributors.
This document can be freely redistributed according to the terms of the
GNU General Public License version 2.0

okay that's the whole thing, you slayed it, go check those symbols 🧚💫

later bestie — this page was brought to you by the gEDA Project, dated December 16, 2020, and stamped with version 1.10.2.20201216 💜💅

📦 where this page comes from