xschem/doc/xschem_man/xschem_remote.html

51 lines
1.8 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<title>XSCHEM REMOTE CONTROL</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="developer_info.html" class="prev">PREV</a>
<a href="xschem_man.html" class="home">UP</a>
<a href="xschem_remote.html" class="next">NEXT</a>
<!-- slide title -->
<h1>XSCHEM REMOTE INTERFACE SPECIFICATION</h1><br>
<h3>GENERAL INFORMATIONS</h3>
<p>
XSCHEM embeds a tcl shell, when running xschem the terminal will present a tcl prompt allowing to
send / get commands through it.
Most user actions done in the drawing window can be done by sending tcl commands through the tcl shell.
A tcp socket can be activated to allow sending remote commands to xschem, for this to work you
must the <kbd>xschem_listen_port</kbd> tcl variable in xschemrc, specifying an unused port number.
Xschem will listen to this port number for commands and send back results, as if commands were given
directly from the tcl console.
</p>
<p>
XSCHEM implements a TCL <kbd>xschem</kbd> command that accepts additional arguments.
This command implements all the XSCHEM remote interface.
Of course all Tck-Tk commands are available, for example, if this command is sent to XSCHEM: '<kbd>wm withdraw .</kbd>'
the xschem main window
will be withdrawn by the window manager, while '<kbd>wm state . normal</kbd>' will show again the window.<br>
This command: '<kbd>puts $XSCHEM_LIBRARY_PATH</kbd>' will print the content of the <kbd>XSCHEM_LIBRARY_PATH</kbd> tcl variable
containing the search path.
</p>
<!-- end of slide -->
<div class="filler"></div>
</div>
<!-- frame footer -->
<iframe seamless src="xschem_footer.html" class="footer_iframe" >
</body>
</html>