luke
/
xschem
mirror of https://github.com/StefanSchippers/xschem.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add scripts.html manual page

This commit is contained in:
stefan schippers 2025-01-03 11:43:00 +01:00
parent e77cc334f4
commit 0af6155b5b
2 changed files with 97 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
doc/xschem_man/scripts.html Normal file
View File

@ -0,0 +1,96 @@
<!DOCTYPE html>
<html>
<head>
<title>SCRIPTS</title>
<link rel="stylesheet" type="text/css" href="xschem_man.css" />
<style type="text/css">
/* Local styling goes here */
p{padding: 15px 30px 10px;}
</style>
</head>
<body>
<!-- start of slide -->
<div class="content">
<!-- navigation buttons -->
<a href="simulation.html" class="prev">PREV</a>
<a href="xschem_man.html" class="home">UP</a>
<a href="graphs.html" class="next">NEXT</a>
<!-- slide title -->
<h1>XSCHEM SCRIPTS</h1><br>
<p>
Xschem is a tcl interpreter and as such TCL scripts and commands can be executed.
Xschem adds its own extension commands, mostly with the <kbd>xschem</kbd> TCL command.
See this <a href="developer_info.html">manual page</a>.
The same procedure as tcl is used to load and execute a script:
<br><br><pre> source /path/to/script.tcl</pre>
</p>
<p>
there are various ways to run a script in xschem:
</p>
<ol>
<li>
On the xschem command prompt:
<br><br><pre>source myscript.tcl</pre><br>
</li>
<li>
In the xschemrc you may set the <kbd>tcl_files</kbd> tcl variable with a list of files
to read in and execute after xschem is started:
<br><br><pre>set tcl_files {/path/to/file1.tcl /path/to/file2.tcl}</pre><br>
</li>
<li>
the <kbd>postinit_commands</kbd> variable in xschemrc can be filled with tcl code ,
it is executed when starting xschem:
<br><br><pre>set postinit_commands {
puts hello
puts world
}
</pre><br>
</li>
<li>
On the unix shell command line with <kbd>--tcl</kbd> (this code is executed after reading xschemrc,
this is usually done to override xschemrc settings:
<br><br><pre>xschem --tcl 'set intuitive_interface 0'</pre><br>
</li>
<li>
On the unix shell command line with <kbd>--preinit</kbd>. Same as <kbd>--tcl</kbd>,
but the commands are executed
at the very beginning of xschem startup, before reading xschemrc.
Usually done to change some internal variables for testing
<br><br><pre>xschem --preinit 'some_weird_tcl_code'</pre><br>
</li>
<li>
On the unix shell command line with <kbd>--command</kbd>.
The specified tcl code is executed after complete startup so all extended
xschem commands are available:
<br><br><pre>
xschem solar_panel.sch --command 'simulate' #there are other ways to do this, just an example
</pre><br>
</li>
<li>
On the unix shell command line with <kbd>--script</kbd>. Specify a file to source,
it will be executed after complete startup.
<br><br><pre>xschem --script myscript.tcl</pre><br>
</li>
</ol>
<!-- end of slide -->
<div class="filler"></div>
</div>
<!-- frame footer -->
<iframe seamless src="xschem_footer.html" class="footer_iframe" >
</body>
</html>

2
doc/xschem_man/simulation.html
View File

@ -17,7 +17,7 @@ p{padding: 15px 30px 10px;}
<!-- navigation buttons -->
<a href="net_probes.html" class="prev">PREV</a>
<a href="xschem_man.html" class="home">UP</a>
<a href="graphs.html" class="next">NEXT</a>
<a href="scripts.html" class="next">NEXT</a>
<!-- slide title -->
<h1>SIMULATION</h1><br>
<p>