Updated user documentation. MK

This commit is contained in:
cvs
2000-02-11 15:21:07 +00:00
parent b98f7db7f6
commit af97d16309
26 changed files with 1506 additions and 394 deletions

View File

@@ -5,7 +5,18 @@
<body>
<h2>R&#252;nbuffer Commands</h2>
<p>
LNS scientists have got used to using R&#252;nbuffers for instrument control. A R&#252;nbuffer is an array of SICS commands which typically represent a measurement. This R&#252;nbuffer can be edited at run time. This is very similar to a macro. In contrast to a macro only SICS commands are allowed in R&#252;nbuffers. When done with editing the R&#252;nbuffer it can be entered in a R&#252;nlist. This is a stack of R&#252;nbuffers which get executed one by one. While this is happening it is possible (from another client) to modify the R&#252;nlist and edit and add additional R&#252;nbuffer on top of the stack. This allows for almost infinite measurement and gives more control than a static batch file. In order to cater for this scheme three commands have been defined:</p>
LNS scientists have got used to using R&#252;nbuffers for instrument
control. A R&#252;nbuffer is an array of SICS commands which
typically represent a measurement. This R&#252;nbuffer can be edited
at run time. This is very similar to a macro. In contrast to a macro
only SICS commands are allowed in R&#252;nbuffers. When done with
editing the R&#252;nbuffer it can be entered in a R&#252;nlist. This
is a stack of R&#252;nbuffers which get executed one by one. While
this is happening it is possible (from another client) to modify the
R&#252;nlist and edit and add additional R&#252;nbuffers on top of
the stack. This allows for almost infinite measurement and gives more
control than a static batch file. In order to cater for this scheme
three commands have been defined:</p>
<p>
The <b> Buf </b> object is responsible for creating and deleting R&#252;nbuffers. The syntax is:<ul>
<li> <b> Buf new name </b> creates a new empty R&#252;nbuffer with the name name. name will be installed as a SICS object afterwards.
@@ -14,7 +25,8 @@
</ul>
</p>
<p>
After creation, the R&#252;nbuffer is accessible by his name. It than understands the commands:<ul>
After creation, the R&#252;nbuffer is accessible by his name. It
then understands the commands:<ul>
<li> <b> NAME append what shall we do with a drunken sailor </b> will add all text after append as a new line at the end of the R&#252;nbuffer.
<li> <b> NAME print </b> will list the contents of the R&#252;nbuffer.
<li> <b> NAME del iLine </b> will delete line number iLine from the R&#252;nbuffer.
@@ -37,3 +49,5 @@
</p>
</body>
</html>