-The program #pclient/# is used to support the remote jobs which are -run on the remote hosts by #pcontrol/#. The concept of pclient is to +The program pclient is used to support the remote jobs which are +run on the remote hosts by pcontrol. The concept of pclient is to act as a buffer between the job running on the remote host and pcontrol. The pcontrol design uses (by default) ssh connections Index: /trunk/Ohana/doc/www/html/Opihi-Programs/index.htm =================================================================== --- /trunk/Ohana/doc/www/html/Opihi-Programs/index.htm (revision 4733) +++ /trunk/Ohana/doc/www/html/Opihi-Programs/index.htm (revision 4734) @@ -13,14 +13,14 @@ arithmetic on variables, input from source files, and a variety of other useful tools. Opihi has a simple command-line interaction that -resembles the UNIX tcsh, but with many additional useful features. It -can also be used as a scripting language much like #sh/# or perl. +resembles the UNIX tcsh, but with many additional useful +features. It can also be used as a scripting language much like +sh or perl.
Opihi includes tools to manipulate and display 1-D (vector) and 2-D -(matrix) data. Two external programs are used to graphical display. -These are the image display tool (Kii), the graphing tool (Kapa), and -the vector and matrix manipulation commands. Various functions are -available to perform math, statistical, and other operations on -vectors and images. +(image) data. Two external programs are used for graphical display: +the image display tool (Kii) and the graphing tool (Kapa). Various +functions are available to perform math, statistical, and other +operations on vectors and images.
The command-line interaction is based on the readline libraries and -behaves like tcsh. Arrows can be used for editing. There is both -command and file completion with the TAB key. Multiple commands can -generally be placed on one line with semi-colons as separators. - -The interface has an interaction similar to tcsh. The arrows -allow editing of previous commands. You can also use emacs-like -commands such as cntl-a to reach the beginning of the line and cntl-e -to reach the end. There is command and file completion: if you type -part of a command (as the first thing on a line) and then type tab, it -will fill in as much as possible, until the word is not unique. -Typing tab twice at that point will list the possible endings. For -any but the first word on a line, the same thing will happen for the -files in the current directory. It is also possible to type just a +behaves like #tcsh/#. Arrows can be used for editing. There is both +command and file completion with the TAB key. You can also use +emacs-like commands such as ctrl-a to reach the beginning of the line +and ctrl-e to reach the end. It is also possible to type just a fraction of a command, as long as it is unique. An ambiguous command will list the possible alternatives. For example:
-dvo: c +opihi: c ambiguous command: c ( catalog cgrid clear create cursor )-The shell is an interpretive programming language. +Multiple commands can generally be placed on one line with semi-colons +as separators.
-Scalar variables in Opihi are proceeded with a dollar sign ($). A +Scalar variables in Opihi are prepended with a dollar sign ($). A variable may be created and the value assigned by a line which looks -like: +like:
@@ -67,18 +59,21 @@ consist of the standard math operators (+,-,*,/) as well as any already-defined variables and the functions log(), ln(), sqrt(), -exp(), ten() ($10^x$), sin(), cos(), etc. Variables can be numeric or character strings. If -the shell does not understand the syntax of the line as a math -expression, it is assumed to be a string. +exp(), ten() ($10^x$), sin(), cos(), etc. Other special operators are +the carret (^) for exponetiation (eg, 2^3 is 8) and the @ symbol as a +binary arc-tangent (eg, 1@3 is 18.43 degrees). In addition, the +operator #<>/# returns the maximum. Variables can be numeric or character +strings. If the shell does not understand the syntax of the line as a +math expression, it is assumed to be a string. + +local variables
If there is a pair of curly brackets {} anywhere on a command line, -whatever is inside is assumed to be a math expression and evaluated as -well. This later feature allows functions of variables to be passed -as arguments to Opihi functions. (see also the discussion below about -temporary vectors and images). - -Any expression within curly brackets {} is assumed -to be an arithmetical expression and is evaluated before the line is -executed. For example: +whatever is inside is assumed to be a math expression and evaluated +before the line is executed. This later feature allows functions of +variables to be passed as arguments to Opihi functions. (see also the +discussion below about temporary vectors and images). +For example:
@@ -86,10 +81,10 @@-would give the response 7.07107. There are math functions cos, sin, -and tan, which operate on radian expressions, and also dcos, dsin, -dtan, which operate on degree expressions. There are also the -equivalent inverse functions: eg., asin and dasin return radians and -degrees, respectively. The help section on Math defines all of the -available math functions. +would give the response 7.07107 if $fred had the value of 10.0. There +are math functions #cos/#, #sin/#, and #tan/#, which operate on radian +expressions, and also #dcos/#, #dsin/#, #dtan/#, which operate on +degree expressions. There are also the equivalent inverse functions: +eg., #asin/# and #dasin/# return radians and degrees, respectively. +The help section on Math defines all of the available math functions.
@@ -112,5 +107,5 @@-will define the variables #$sample:0 - $sample:2/#, and #$sample:n/#, +will define the variables $sample:0 - $sample:2, and $sample:n, with value of 3. @@ -138,23 +133,23 @@ A queue is a data construct consisting of a sequence of lines from which simple selections can be made. Data items are added and removed -from the queue with #queuepush/# and #queuepop/# commands which push +from the queue with queuepush and queuepop commands which push entries on the end of the queue and pop them off the beginning. The -available queues may be obtained with the command #queuelist/#, and -the length of a specific queue may be determined with the #queuesize/# -command. The contents of a queue may be printed with #queueprint/#. +available queues may be obtained with the command queuelist, and +the length of a specific queue may be determined with the queuesize +command. The contents of a queue may be printed with queueprint. Pushing data onto a non-existent queue will create the queue. An -empty queue may be created with the command #queueinit/# and a queue -may be deleted with #queuedelete/#. - -
-The #queuepush/# commands allows for additional options which modify -how the data is pushed on the queue. The #-uniq/# flag specifies that +empty queue may be created with the command queueinit and a queue +may be deleted with queuedelete. + +
+The queuepush commands allows for additional options which modify +how the data is pushed on the queue. The -uniq flag specifies that the queue should be search for an existing match and not add the new -data item if a matching item already exists. The #-replace/# flag is -similar to the #-uniq/# flag, but instead the new item will replace +data item if a matching item already exists. The -replace flag is +similar to the -uniq flag, but instead the new item will replace the existing match, if a match is found. These two options have identical results if the match is made based on the entire line. However, they may be more usefully distinguished by specifying a -restriction on the match with the #-key/# flag. This flag specified +restriction on the match with the -key flag. This flag specified which whitespace-separated element of the line to use for the match, with the first element being element 0. @@ -164,110 +159,33 @@ document. -
-break -- escape from function -for -- loops -if -- logical cases ++ +Opihi Shell Programing and Flow-control
+ +input -- read command lines from a file macro -- deal with the macros -- --There are several options for programming in status. First, +for -- for loop +if -- logical cases +while -- while loop +break -- escape from function +continue -- next loop iteration +
+There are several options for programming in the opihi shell. First, a file which contains a series of commands can be executed with -input (filename). It is also possible to define macros which -will behave much like regular commands. A macro is defined by typing -macro name or macro create name followed by the -commands. Arguments to the macro are assigned to the variables $1 -.. $N and the number of arguments is given by $0. Macros may be -defined in input files, and in fact when status is -started, it loads the file ~/.statusrc which may contain -default macros. Simple loops and if statements can be performed, and -are quite useful for complex macros. - -
-'If' statements are similar in syntax to C if statements. Math -expresions in the if statement must be contained in curly braces, as -elsewhere. Variables with string values may use the logical == -operator to test if two strings are the same. 'For' loops are quite -simplistic. The form is: - -
-for var first last delta - (commands) -end -- -
-The value of $var will start at the value first and increment by -delta after each loop. The loop will stop after $var is greater -than stop. The value delta is optional, with 1 assumed. -The value of $var may be changed during the loop, and if set -beyong the value of last will end the loop early. - - -
-Opihi has several types of flow-control features. These include -for-loops, while-loops, if-else blocks. These blocks are defined by -the corresponding command (#for/#, #while/#, #if/#) and are terminated -with by a line with the single word #end/#. - -
-The for loop syntax is simplistic. The #for/# command specifies the -loop variable, the starting value, the ending value, and optionally -the delta for each loop. The implicit loop test is always to check if -the loop variable is still less than the end value (or greater than if -the delta value is negative). The definitions of this loop syntax and -the value of the list length (#$list:n/#) and the vector length -(#vector[]/#) make for natural loops over all elements of a list or -vector. Below are a few examples: - -
-for i 1 10 0.1 - echo $i -end --This runs the loop with the variable #$i/# running from 1.0, 1.1, up to 9.9 - (inclusive). - -
-for i 0 $list:n - echo $list:$i -end --This would print all the elements of the list. - -
-for i 0 vector[] - echo vector[$i] -end --This would print all the elements of the vector. - -
-The if-block begins with a line of the form: #if (condition)/# and -ends with a single #end/#. A line with a single #else/# specifies the -optional else portion of the block. The conditional expression is a -valid math inequality with approximately C-syntax: - -## -(($i < 10) && ($i > 4)) -/## - -The elements of the inequality may also be string comparisons. The -only valid string comparisons are #==/# and #!=/#. - -
-The while loop begins with a line of the form #while (condition)/# and -ends with a single #end/#. The conditions follow the same rules as -the if conditional statements. - -
-*continue, break, auto-break concepts/* - - - +input (filename). When an opihi-based program is started, it +loads a file from the user's home directory, with a name of the form +~/.programrc. This resource file may contain any commands, +and allows a user to customize his or her environment. + +
+It is also possible to define macros which will behave much like +regular commands. A macro is defined by typing macro name or +macro create name followed by the commands. Arguments to the +macro are assigned to the variables $1 .. $N and the number of +arguments is given by $0. Macros may be defined in input +files. The following is a sample macro: + +
macro test echo "this is a macro" @@ -281,7 +199,61 @@-Some of the other useful programming features are the ability to -run files as scripts (input (filename)) and the option of -performing unix system calls (exec (command)). +Opihi has several types of flow-control features. These include +for-loops, while-loops, if-else blocks. These blocks are defined by +the corresponding command (for, while, if) and are terminated +with by a line with the single word end. + +
+The for-loop syntax is simplistic. The for command specifies +the loop variable, the starting value, the ending value, and +optionally the delta for each loop. The implicit loop test is always +to check if the loop variable is still less than the end value (or +greater than if the delta value is negative). The definitions of this +loop syntax and the value of the list length ($list:n) and +the vector length (vector[]) make for natural loops over all +elements of a list or vector. Below are a few examples: + +
+for i 1 10 0.1 + echo $i +end ++This runs the loop with the variable $i running from 1.0, 1.1, up to 9.9 + (inclusive). + ++for i 0 $list:n + echo $list:$i +end ++This would print all the elements of the list. + ++for i 0 vector[] + echo vector[$i] +end ++This would print all the elements of the vector. + ++The if-block begins with a line of the form: if (condition) and +ends with a single end. A line with a single else specifies the +optional else portion of the block. The conditional expression is a +valid math inequality with approximately C-syntax: + +
+(($i < 10) && ($i > 4)) ++ +The elements of the inequality may also be string comparisons. The +only valid string comparisons are == and !=. + ++The while loop begins with a line of the form while (condition) and +ends with a single end. The conditions follow the same rules as +the if conditional statements. + +continue, break, auto-break concepts +
Miscellaneous Commands
@@ -307,4 +279,8 @@ files (this includes general help not associated with a specific command). + +output + +scan1D Data and the Graphing Window