2020-08-08 15:47:34 +02:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>XSCHEM TUTORIAL</title>
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="xschem_man.css" />
|
|
|
|
|
<style type="text/css">
|
|
|
|
|
/* Local styling goes here */
|
|
|
|
|
p{padding: 10px 30px 10px;}
|
|
|
|
|
|
|
|
|
|
</style>
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<!-- start of slide -->
|
|
|
|
|
<div class="content">
|
|
|
|
|
<!-- navigation buttons -->
|
|
|
|
|
<a href="install_xschem.html" class="prev">PREV</a>
|
|
|
|
|
<a href="xschem_man.html" class="home">UP</a>
|
|
|
|
|
<a href="xschem_elements.html" class="next">NEXT</a>
|
|
|
|
|
|
|
|
|
|
<!-- slide title -->
|
|
|
|
|
<h1>RUN XSCHEM</h1><br>
|
|
|
|
|
<p> Assuming <kbd>xschem</kbd> is installed in one of the <kbd>${PATH}</kbd> search paths just execute:</p>
|
|
|
|
|
|
|
|
|
|
<pre class="code">
|
|
|
|
|
user:~$ xschem
|
|
|
|
|
</pre>
|
|
|
|
|
<p> the xschem window should appear. If <kbd>xschem</kbd> is not in the search path then specify
|
|
|
|
|
its full pathname.
|
|
|
|
|
</p>
|
2021-10-13 17:33:10 +02:00
|
|
|
<img src="xschem_home.png">
|
2020-08-08 15:47:34 +02:00
|
|
|
|
|
|
|
|
<p> if a filename is given that file will be loaded on startup: </p>
|
|
|
|
|
<pre class="code">
|
|
|
|
|
user:~$ xschem .../xschem_library/examples/0_examples_top.sch
|
|
|
|
|
</pre>
|
2021-10-13 17:33:10 +02:00
|
|
|
<img src="xschem_home1.png">
|
2020-08-08 15:47:34 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>XSCHEM COMMAND LINE OPTIONS </H3>
|
|
|
|
|
<p>
|
|
|
|
|
xschem accepts short (-h) or long (--help) options:
|
|
|
|
|
</p>
|
|
|
|
|
<pre class="code">
|
2023-10-22 22:16:17 +02:00
|
|
|
|
2020-08-08 15:47:34 +02:00
|
|
|
usage: xschem [options] [schematic | symbol ]
|
|
|
|
|
Options:
|
|
|
|
|
-h --help Print this help.
|
2023-04-09 02:12:54 +02:00
|
|
|
-b --detach Detach Xschem from console (no output and no input from console)
|
2020-08-08 15:47:34 +02:00
|
|
|
-n --netlist Do a netlist of the given schematic cell.
|
|
|
|
|
-v --version Print version information and exit.
|
|
|
|
|
-V --vhdl Set netlist type to VHDL.
|
2024-06-27 15:59:42 +02:00
|
|
|
-S --simulate Run a simulation of the current schematic file
|
2023-10-22 22:16:17 +02:00
|
|
|
(spice/Verilog/VHDL, depending on the netlist
|
2020-08-08 15:47:34 +02:00
|
|
|
type chosen).
|
|
|
|
|
-w --verilog Set netlist type to Verilog.
|
2023-10-22 22:16:17 +02:00
|
|
|
--tcl <tcl_cmd> Execute specified tcl instructions before any other action,
|
|
|
|
|
after sourcing xschemrc, this can be used to change xschemrc variables.
|
2022-10-11 00:26:06 +02:00
|
|
|
--preinit <tcl_cmd> Execute specified tcl instructions before any other action,
|
|
|
|
|
and before loading xschemrc.
|
2023-10-22 22:16:17 +02:00
|
|
|
--script <file> Execute specified tcl file as a command script (perhaps with xschem commands).
|
2022-05-06 23:19:41 +02:00
|
|
|
--command <tcl_cmd> Execute specified tcl commands after completing startup.
|
2022-12-13 13:51:33 +01:00
|
|
|
--diff <file> Show differences with given file.
|
2020-08-08 15:47:34 +02:00
|
|
|
--tcp_port <number> Listen to specified tcp port for client connections. (number >=1024).
|
|
|
|
|
-i --no_rcload Do not load any xschemrc file.
|
2023-10-22 22:16:17 +02:00
|
|
|
--netlist_path <path>
|
|
|
|
|
-o <path> Set output path for netlist.
|
|
|
|
|
--netlist_filename <file>
|
2024-11-29 22:52:36 +01:00
|
|
|
-N <file> Set name (only name or full path) of top level netlist file.
|
2020-08-08 15:47:34 +02:00
|
|
|
-t --tedax Set netlist type to tEDAx.
|
|
|
|
|
-s --spice Set netlist type to SPICE.
|
2021-11-17 01:12:55 +01:00
|
|
|
-y --symbol Set netlist type to SYMBOL (used when drawing symbols)
|
2020-08-08 15:47:34 +02:00
|
|
|
-x --no_x Don't use X (only command mode).
|
2024-06-27 15:59:42 +02:00
|
|
|
-z --rainbow Use a rainbow-looking layer color table.
|
2020-08-08 15:47:34 +02:00
|
|
|
-W --waves Show simulation waveforms.
|
|
|
|
|
-f --flat_netlist Set flat netlist (for spice format only).
|
2023-10-22 22:16:17 +02:00
|
|
|
-r --no_readline Start without the tclreadline package, this is necessary
|
|
|
|
|
--pipe if stdin and stdout are to be redirected. This also prevents xschem
|
|
|
|
|
from closing stdin / stdout / stderr even if invoked from pipes.
|
2020-08-08 15:47:34 +02:00
|
|
|
-c --color_ps Set color postscript.
|
|
|
|
|
--plotfile <file> Use <file> as output for plot (png, svg, ps).
|
|
|
|
|
--rcfile <file> Use <file> as a rc file for startup instead of the
|
|
|
|
|
default xschemrc.
|
|
|
|
|
-p --postscript
|
|
|
|
|
--pdf Export pdf schematic.
|
|
|
|
|
--png Export png schematic.
|
|
|
|
|
--svg Export svg schematic.
|
|
|
|
|
-q --quit Quit after doing things (no interactive mode).
|
|
|
|
|
-l <file>
|
|
|
|
|
--log <file> Set a log file.
|
|
|
|
|
-d <n>
|
|
|
|
|
--debug <n> Set debug level: 1, 2, 3,.. C program debug.
|
|
|
|
|
-1, -2, -3... TCL frontend debug.
|
|
|
|
|
|
|
|
|
|
xschem: interactive schematic capture program
|
|
|
|
|
|
|
|
|
|
Example: xschem counter.sch
|
|
|
|
|
the schematic file `counter.sch' will be loaded.
|
|
|
|
|
</pre>
|
|
|
|
|
<h3> CREATING A NEW SCHEMATIC</H3>
|
|
|
|
|
<p>
|
|
|
|
|
To create a new schematic run xschem and give a non existent filename:<br>
|
|
|
|
|
<kbd>xschem aaa.sch</kbd>
|
|
|
|
|
</p>
|
2021-10-13 17:33:10 +02:00
|
|
|
<img src="xschem_new_file.png">
|
2020-08-08 15:47:34 +02:00
|
|
|
<p>
|
|
|
|
|
You can save the schematic by pressing <kbd>'<ctrl shift>s'</kbd> or
|
|
|
|
|
by using the menu <kbd>File - Save As</kbd>:
|
|
|
|
|
</p>
|
2021-10-13 17:33:10 +02:00
|
|
|
<img src="xschem_saveas.png">
|
2020-08-08 15:47:34 +02:00
|
|
|
<p>
|
|
|
|
|
If no filename change is needed you can just use <kbd>File - Save</kbd>.
|
|
|
|
|
Now a new empty schematic file is created. You can use this <kbd>test.sch</kbd> for testing while
|
|
|
|
|
reading the manual.
|
|
|
|
|
After exiting XSCHEM you can load directly this schematic with the following commands, they are
|
|
|
|
|
all equivalent.
|
|
|
|
|
<pre class="code">
|
|
|
|
|
xschem /home/schippes/x/test.sch
|
|
|
|
|
# or ...
|
|
|
|
|
xschem ${HOME}/schippes/x/test
|
|
|
|
|
</pre>
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
you can load <kbd>test.sch</kbd> when xschem is running by using the load command <kbd>'<ctrl>o'</kbd> key or
|
|
|
|
|
by menu <kbd>Open</kbd> command. Use the file selector dialog to locate the schematic and load it in.
|
|
|
|
|
When loading a new file XSCHEM asks to save the currently loaded schematic if it has been modified.
|
|
|
|
|
</p>
|
|
|
|
|
<!-- end of slide -->
|
|
|
|
|
<div class="filler"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- frame footer -->
|
|
|
|
|
<iframe seamless src="xschem_footer.html" class="footer_iframe" >
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
