Documentation:Reference:TCL 2 - MdsWiki
Personal tools

From MdsWiki

Jump to: navigation, search



The HELP command invokes the VAX/VMS HELP Facility to display information about an MDS command or topic. In response to the "Topic?" prompt, you can:
o Type the name of the command or topic for which you need help.
o Type a question mark (?) to redisplay the most recently requested text.
o Press the RETURN key one or more times to exit from HELP.
You can abbreviate any topic name, although ambiguous abbreviations result in all matches being displayed.
keyword ...
Specifies one or more keywords that indicate the information you want from a HELP library. Information within HELP libraries is arranged in a hierarchical manner. The levels are:
1. None -- If you do not specify a keyword, HELP describes the HELP command and lists the topics that are documented in the root library. Each item in the list is a keyword in the first level of the hierarchy.
2. Topic-name -- If you specify a keyword by naming a topic, HELP describes the topic as it is documented in either the root library or one of the other enabled default libraries and lists keywords for additional information available on this topic.
3. Topic-name subtopic -- If you specify a subtopic following a topic, HELP provides a description of the specified subtopic.
4. @file-spec followed by any of the above -- If you specify a HELP library to replace the current root library, HELP searches that library for a description of the topic or subtopic specified. The file specification must take the same form as the file specification included with the /LIBRARY command qualifier. However, if the specified library is an enabled user-defined default library, the file specification can be abbreviated to any unique substring of that default library's logical name translation.
If you use an asterisk in place of any keyword, the HELP command displays all information available at the level that the asterisk replaces. For example, HELP COPY * displays all the subtopics under the topic COPY.
If you use an ellipsis immediately after any keyword, HELP displays all the information on the specified topic and all subtopics of that topic. For example, HELP COPY... displays information on the COPY topic as well as information on all the subtopics under COPY.
You can use percent signs and asterisks in the keyword as wildcard characters.


Initialization command
The INIT TIMER command will zero a VMS process statistics timer (See LIB$INIT_TIMER in the Run-Time Library Manual). Use in conjunction with the SHOW TIMER command you can determine The elapsed time, CPU usage, Pagefaults, direct I/O and buffer I/O that has taken place since the INIT TIMER command was issued.


Command to link a source tree (with subtrees) into a single destination tree.
FORMAT: TCL> LINK source_experiment destination_experiment
Note: LINK only operates on model files.


MDS supports command macros. Command macros are very similar to indirect command procedure except for several key features:
o Once invoked a macro resides in memory and can be efficiently processed.
o Macros can be modified using EDT without ever leaving the command interpreter.
o Macros can be saved in VMS text libraries for future reference.
o Macros are invoked just as if they were a valid command. If a command you enter in response to the interpreters prompt is not a known command for the utility you are in, the interpreter checks to see the command is the name of one of your macros. (note: if you name a macro to be the same as a valid command the macro won't be automatically invoked. You can explicitly invoke a macro using the command DO/MACRO macro-name)
o Macro execution can repeated a specified number of repetitions or indefinitely using a repeat qualifier as follows:
macro-name/REPEAT[=repetitions] [p1] [p2] [p3] [p4] [p5] [p6] [p7]


The MARK command sets the usage of all of the subtrees of the currently open tree.
The Mark command makes the usage of all of the external tree references (subtrees) either TREE$K_USAGE_SUBTREE or TREE$K_USAGE_STRUCTURE. If the subtree can be found then it is made TREE$K_USAGE_SUBTREE otherwise it is set to TREE$K_USAGE_STRUCTURE. Use this command to prevent set tree from looking for nonexistent subtrees.
NOTE: This command can only be used when a tree is open not edit.


The modify command invokes EDT to modify a macro. The macro may be locally defined or one that is stored in a macro library.
Format: MODIFY macro-name
The name of a command macro. The string can contain from 1 to 32 characters.


Puts data into a node
FORMAT: PUT nodename expression
TCL> PUT/EXTENDED[/EOF=end-of-file-string][/SYMBOLS] nodename
PUT> first_line
PUT> second_line
PUT> ...
PUT> last_line
Specifies the node into which data is to be inserted.
Any valid MDSplus expression. This can be simple constants or complex expressions.
Expression to insert in node is included on subsequent lines. A blank line or line containing the EOF string will complete the expression.
Used with /EXTENDED qualifier to specify an end-of-file string to designate the end of input. If this qualifier is omitted, the input is designated by a blank line. If you want to include blank lines in the expression, you need to specify an EOF string to designate when input is done. For example:
PUT> "This is a node containing comments.
PUT> It has many lines of text.
PUT> including blank lines."
Specifies whether symbol substitution should occur in extended expressions. If omitted, no symbol substitution will occur and single quotes will be interpreted as part of the expression.


Removes a tagname from a tree
This command will remove the tag named in the tag_name parameter from a tree.
NOTE: The tree must be open for write to use this command. see EDIT vs SET TREE.
tag_name - the tag to remove from the tree.


Renames / Moves a node or sub tree.
FORMAT: RENAME source_path destination_path
The RENAME command cuts a node or subtree specified by the source_path parameter out of the current tree and pastes it into the tree at the destination_path. The source_path node and the parent of the destination_path node must be present for the command to operate. The actual node specified by the destination path must NOT be there since this is what the new node will be called.
NOTE: The tree must be open for write to use this command. see EDIT vs SET TREE.


Forces users to re-open the characteristics and datafile of a tree the next time these files are accessed. This is automatically done when a tree is compressed or cleaned.
This qualifier will cause all processes which have this tree open to exit.
Include all subtrees in the rundown.