Changes between Version 3 and Version 4 of startstop_sol


Ignore:
Timestamp:
11/15/11 17:27:45 (10 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • startstop_sol

    v3 v4  
    103103 
    104104===== nRing ===== 
    105 nRing nRing 
     105'''nRing''' nRing 
    106106 
    107107Specifies the number of shared memory regions (aka transport rings) that startstop will create for "public" use by the modules of this Earthworm system. nRing should be an integer from 1 to MAX_RING (currently defined to be 50). 
     
    110110 
    111111===== Ring ===== 
    112 Ring name size 
     112'''Ring''' name size 
    113113 
    114114Specifies the name and size, in kilobytes, of one transport ring. There must be exactly nRing "Ring" commands following the "nRing" command in the startstop_sol.d. name is a character string (up to 19 characters long, valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. size should be an integer between 1 and 1024 (the default maximum size). When deciding how large to make a memory region, realize that the transport layer uses a portion of the memory region for its own bookkeeping. The region size is NOT required to be an even multiple of the size of the messages it will contain. However, suppose you want the region to be exactly large enough to store NUM messages of size MSGSIZE. To include space for transport bookkeeping too, the region size (in bytes) should be: 
     
    133133 
    134134===== !MyModuleId ===== 
    135 !MyModuleId mod_id 
     135!'''MyModuleId''' mod_id 
    136136 
    137137Sets the module id for labeling all outgoing messages. mod_id is a character string (up to 30 characters, valid strings listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. Startstop places its outgoing messages on the shared memory ring specified by the first "Ring" command in startstop_sol.d. 
     
    140140 
    141141===== !HeartbeatInt ===== 
    142 !HeartbeatInt nsec 
     142!'''HeartbeatInt''' nsec 
    143143 
    144144Defines the number of seconds, nsec, between TYPE_HEARTBEAT messages issued by startstop. Startstop places its heartbeats on the shared memory ring specified by the first "Ring" command in startstop_sol.d. 
     
    147147 
    148148===== !MyClassName ===== 
    149 !MyClassName class 
     149!'''MyClassName''' class 
    150150 
    151151Sets the process class for startstop. class is a character string that must be set to either "RT" (for Real-Time) or "TS" (for Time- Share) on solaris. 
     
    154154 
    155155===== !MyPriority ===== 
    156 !MyPriority priority 
    157  
    158 Sets the process priority for startstop. See the "Class/Priority" command below for allowed values. After startstop reads its configuration file, it changes its own class/priority to the values specified in the "!MyClassName" and "!MyPriority" commands. 
     156!'''MyPriority''' priority 
     157 
     158Sets the process priority for startstop. See the "!Class/Priority" command below for allowed values. After startstop reads its configuration file, it changes its own class/priority to the values specified in the "!MyClassName" and "!MyPriority" commands. 
    159159 
    160160Example:  !MyPriority 4 
    161161 
    162162===== !LogFile ===== 
    163 !LogFile switch 
     163!'''LogFile''' switch 
    164164 
    165165Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, startstop will write a daily log file(s) called cfname_yyyymmdd.log where cfname is the name (without extension) of startstop's configuration file (ex: startstop_sol) and yyyymmdd is the current UTC date (ex: 19960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 
     
    168168 
    169169===== !KillDelay ===== 
    170 !KillDelay nsec 
     170!'''KillDelay''' nsec 
    171171 
    172172Gives the number of seconds nsec that startstop will wait for modules to shutdown gracefully on termination. After this delay, startstop will force modules to shut down with the TERM signal. If module still does not stop after nsec seconds, behavior is determined by the "!HardKillDelay" command. 
     
    175175 
    176176===== !HardKillDelay ===== 
     177!'''HardKillDelay''' nsec 
     178 
     179Optional specification of number of seconds nsec that startstop will wait for modules to shutdown after being sent a KILL signal before aborting a restart of the module. If not specified, no KILL signal is issued, and any restart is aborted after sequence described in the "KillDelay" command. 
     180 
     181Example:  !HardKillDelay 10 
     182 
    177183===== !maxStatusLineLen ===== 
     184!'''maxStatusLineLen''' nchars 
     185 
     186Optional specification of maximum length of a line when printing status to nchars characters; default is 80, and new value cannot be smaller. When specified, status will adjust column widths to minimize truncation of information. 
     187 
     188Example:  !maxStatusLineLen 120 
     189 
    178190===== Stderr ===== 
     191'''Stderr''' target 
     192 
     193Optional specification of what to do with messages printed to stderr; target can be either "Console" (the screen, the default), "None" (messages are eliminated), or "File" (messages get written to a file in the Log directory, named as the log file for this module would be but with the extension .err). When specified for startstop itself, it is the default for all modules (save startstop); when specified for a specific module, it overrides the specification for all modules. In the example configuration, every module's stderr messages are surpressed except for eqproc (whose go to the screen) and binder_ew (whose go to a file). 
     194 
     195Example:  Stderr File 
    179196 
    180197==== Earthworm modules to run ==== 
     
    187204 
    188205===== Process ===== 
    189 ===== Class/Priority ===== 
     206===== !Class/Priority ===== 
    190207===== Stderr ===== 
    191208