From af97d16309cbbc640623413595214ae46affd018 Mon Sep 17 00:00:00 2001 From: cvs Date: Fri, 11 Feb 2000 15:21:07 +0000 Subject: [PATCH] Updated user documentation. MK --- doc/manager/managerman | 2 +- doc/user/basic.htm | 27 +- doc/user/buffer.htm | 18 +- doc/user/config.htm | 4 +- doc/user/counter.htm | 25 +- doc/user/dmc.htm | 11 +- doc/user/dmcdev.htm | 10 +- doc/user/dmco.htm | 12 +- doc/user/drive.htm | 4 +- doc/user/foman.tex | 242 +++++++----- doc/user/general.htm | 39 +- doc/user/logbook.htm | 7 +- doc/user/macro.htm | 21 +- doc/user/motor.htm | 10 +- doc/user/optimise.htm | 8 +- doc/user/samenv.htm | 92 +++-- doc/user/sicsinvoc.htm | 35 +- doc/user/system.htm | 13 +- doc/user/token.htm | 5 +- doc/user/topdev.htm | 845 +++++++++++++++++++++++++++++++++++++--- doc/user/tophw.htm | 6 +- doc/user/topscan.htm | 18 +- doc/user/tricsingle.htm | 18 +- doc/user/tricsman | 2 +- doc/user/tricsman.tex | 424 +++++++++++++------- doc/user/trouble.htm | 2 +- 26 files changed, 1506 insertions(+), 394 deletions(-) diff --git a/doc/manager/managerman b/doc/manager/managerman index 89606cb9..6decd86f 100644 --- a/doc/manager/managerman +++ b/doc/manager/managerman @@ -18,7 +18,7 @@ \begin{huge} SICS--Managers--Manual \\ \end{huge} -Version 1.0, October,1997\\ +Version: \today\\ Dr. Mark K\"onnecke \\ Labor f\"ur Neutronenstreuung\\ Paul Scherrer Institut\\ diff --git a/doc/user/basic.htm b/doc/user/basic.htm index 09c05efb..7383853e 100644 --- a/doc/user/basic.htm +++ b/doc/user/basic.htm @@ -7,10 +7,22 @@

General structure

- SICS is a client server system. The application the user sees is usually some form of client. A client has two tasks: the first is to collect user input and send it to the SICS server who will execute the command. The clients second task is to listen to the the server messages and display them in a readable format. This aoproach has two advantages: clients can reside on machines across the whole network thus enabling remote control from everywhere in the world. The second advantage is that new clients (such as graphical user interface clients) can be written in any feasible language without changes to the server.

+ SICS is a client server system. The application the user sees is + usually some form of client. A client has two tasks: the first is to + collect user input and send it to the SICS server which then executes +the command. The clients second task is to listen to the the server + messages and display them in a readable format. This aproach has two + advantages: clients can reside on machines across the whole network + thus enabling remote control from everywhere in the world. The second + advantage is that new clients (such as graphical user interface + clients) can be written in any feasible language without changes to + the server.

+

SICS Command Syntax

- SICS is an object oriented system. This is reflected in the command syntax. SICS objects can be devices such as motors or counters, variables such as wavelength or Title and measurement procedures. Communication with these objects happens by sending messages to the target object. This is very simply done by typing something like: object message par1 par2 .. parn. For example, if we have a motor called A1:

+ SICS is an object oriented system. This is reflected in the command
+syntax. SICS objects can be devices such as motors, single
+         counters, histogram memories or other hardware  variables such as wavelength or Title and measurement procedures.  Communication with these objects happens by sending messages to the  target object. This is very simply done by typing something like: object message par1 par2 .. parn. For example, if we have  a motor called A1:
          A1 list
 

  will print a parameter listing for the motor A1. In this example no parameters were needed. There exist a number of one-word commands as well. For 
@@ -24,10 +36,13 @@ system for instance file names are case sensitive and that had to be
 preserved. Commands defined in the scripting language are lower case by
 convention.  
 

-
+ 
 
Authorisation

 

- A client server system is potentially open to unauthorised hackers which might mess up the instrument and your valuable  measurements. A known problem in instrument control is that less  knowledgeable user accidentally change instrument adjustments which should better be left fixed. In order to solve these two  problems SICS supports authorisation on a very fine level. As a user you have to specify a username and password in order to able to access SICS. Some clients already do this for you automatically.  SICS support four levels of access to an instrument: