xschem(1)

πŸ“¦
version 3.4.4 Β· 5 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ‘‘ NAME πŸ‘‘

xschem β€” the schematic capture + netlisting EDA tool, aka your new bestie for drawing circuits πŸ’–


✨ SYNPOSIS ✨

xschem [options] [inputfile]

πŸ’… DECSRIPTION πŸ’…

So basically xschem is a schematic capture program, and what that means is you get to build hierarchical representations of circuits β€” top down, main character energy, starting from the big picture and zooming in πŸ¦‹


πŸŽ€ OPTIONS πŸŽ€

  • -h, --help β€” prints the help and dips out. bye πŸ‘‹
  • -b, --detach β€” detaches xschem from the console, so no output and no input from the console at all. it's giving independent πŸ’…
  • -n, --netlist β€” does a netlist of the schematic cell you gave it.
  • -v, --version β€” prints the version info and exits, periodt.
  • -V, --vhdl β€” sets the netlist type to VHDL.
  • -S, --simulate β€” runs a simulation of the current schematic file (spice / Verilog / VHDL, whichever netlist type you chose).
  • -w, --verilog β€” sets the netlist type to Verilog.
  • --tcl <tcl_script> β€” runs those tcl instructions before literally any other action. perfect for changing xschemrc variables, iykyk.
  • --preinit <file> β€” runs the specified tcl instructions before any other action and before loading xschemrc. earliest of the early birds 🐦
  • --command <tcl_cmd> β€” runs those tcl commands once startup is done.
  • --script <file> β€” runs the specified tcl file as a command script (maybe with xschem commands in it πŸ‘€).
  • --diff <file> β€” shows you the differences with the given file.
  • --tcp-port <number> β€” listens on the specified tcp port for client connections. (number must be >=1024).
  • -i, --no_rcload β€” does not load any xschemrc file. none. zero. πŸ™ˆ
  • -o, --netlist_path β€” sets the output for the netlist.
  • -N, --netlist_filename β€” sets the name (only the name, not the path) of the top level netlist file.
  • -t, --tedax β€” sets the netlist type to tEDAx.
  • -s, --spice β€” sets the netlist type to SPICE.
  • -y, --symbol β€” sets the netlist type to symbol global property edit.
  • -x, --no_x β€” don't use X. command mode only, babe πŸ–€
  • -z, --rainbow β€” uses a rainbow-looking layer color table 🌈 iconic.
  • -W, --waves β€” shows simulation waveforms.
  • -f, --flat_netlist β€” sets a flat netlist (spice format only, bestie).
  • -r, --no_readline β€” starts without the tclreadline package. this is necessary if stdin and stdout are gonna be redirected, like to /dev/null for example.
  • -c, --color_ps β€” sets color postscript.
  • --plotfile <file> β€” uses <file> as the output for plot export (png, svg, postscript/pdf).
  • --rcfile <file> β€” uses <file> as the rc file for startup instead of the default xschemrc.
  • -p, --postscript, --pdf β€” exports a pdf schematic.
  • --png β€” exports a png schematic.
  • --svg β€” exports an svg schematic.
  • -q, --quit β€” quits after doing the things. no interactive mode, no hanging around πŸ’€
  • -l file, --log file β€” sets a log file.
  • -d n, --debug n β€” sets the debug level. 1, 2, 3,... is C program debug; -1, -2, -3,... is TCL frontend debug.

πŸ¦‹ FILES πŸ¦‹

  • /usr/share/xschem/xschemrc β€” the default configuration.
  • ~/.xschem/xschemrc β€” your user configuration. if it exists it overrides settings from the default configuration, and it may be partial: anything you don't override stays exactly as the system config set it 🫢
  • ./xschemrc β€” local / per-project configuration. if it exists it overrides settings from the user configuration and the default configuration.
  • /usr/share/xschem/systemlib β€” builtin essentials, like font and missing symbol graphics.
  • /usr/share/xschem/utile β€” TODO.

okay that's the whole thing, no cap πŸ’œ

and that's a wrap from your girl, straight out of the xschem manual, section 1 β€” catch you in the group chat βœ¨πŸŽ€πŸŒΈ

πŸ“¦ where this page comes from