Changes between Version 3 and Version 4 of nmxptool


Ignore:
Timestamp:
04/08/12 16:29:23 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • nmxptool

    v3 v4  
    3535 
    3636== Configuration File Commands == 
     37On startup, nmxptool reads the configuration file named on the command line. Commands in this file set all the parameters used for configuring the Earthworm Nanometrics client module nmxptool (Nanometrics). In the control file, lines may begin with a valid nmxptool command (listed below) or with one of 2 special characters: 
     38{{{ 
     39#  marks the line as a comment (example: # This is a comment). 
     40    
     41@  allows control files to be nested; one control file can be  
     42   accessed from another with the command "@" followed by  
     43   a string representing the path name of the next control file  
     44   (example: @model.d). 
     45}}} 
     46 
     47Command names must be typed in the control file exactly as shown in this document (commands are case sensative).  Blank lines are also permitted in the control file. 
     48 
     49=== Functional Command Listing === 
     50Below are the commands recognized by nmxptool, grouped by the function they influence. Most of the commands are required; they may be specified in any order in the control file.  
     51{{{ 
     52        Earthworm system setup: 
     53 
     54MyModuleId              required 
     55 
     56RingName                required 
     57 
     58HeartBeatInterval       required 
     59 
     60Verbosity               optional 
     61 
     62 
     63 
     64Nanometrics server and connection parameters: 
     65 
     66NmxpHost                required 
     67 
     68NmxpPortPDS             optional 
     69 
     70NmxpPortDAP             optional 
     71 
     72UserDAP                 optional 
     73 
     74PassDAP                 optional 
     75 
     76ForceTraceBuf1          optional 
     77 
     78MaxTolerableLatency     optional 
     79 
     80ShortTermCompletion     optional 
     81 
     82MaxDataToRetrieve       optional 
     83 
     84TimeoutRecv             optional 
     85 
     86mschan                  optional 
     87 
     88DefaultNetworkCode      optional 
     89 
     90ChannelFile             required        Xor Channel 
     91 
     92Channel                 required        Xor ChannelFile 
     93 
     94 
     95 
     96 
     97Output control: 
     98 
     99LogFile                 required 
     100}}} 
     101 
    37102 
    38103