Commit cd55606b authored by Matteo Quintiliani's avatar Matteo Quintiliani

Improved documentation


git-svn-id: file:///home/quintiliani/svncopy/nmxptool/trunk@952 3cd66e75-5955-46cb-a940-c26e5fc5497d
parent e3329ab5
......@@ -20,7 +20,7 @@ Verbosity 16 # Set level of verbosity. Verbosity is
# 256 Gap, 512 DOD, 1023 All messages.
# It is equivalent to the option -v.
NmxpHost naqs1a.int.ingv.it # Host address of NaqsServer/DataServer
NmxpHost naqs1a.int.ingv.it # NaqsServer/DataServer hostname or IP address.
# It is equivalent to the option -H.
NmxpPortPDS 28000 # Port number of NaqsServer (Default 28000)
......@@ -37,7 +37,7 @@ MaxTolerableLatency 120 # Max tolerable latency for each channe
# In general, DO NOT use with parameter TimeoutRecv.
# It is equivalent to the option -M.
#TimeoutRecv 30 # Time-out in seconds for flushing queued data for each channel.
#TimeoutRecv 30 # Time-out in seconds for flushing queued data of each channel.
# (Default 0. No time-out) [10..300].
# Useful for retrieving Data On Demand with minimum delay.
# 'tsec' in nmxptool.desc should be greater than 'TimeoutRecv'.
......@@ -51,6 +51,7 @@ DefaultNetworkCode IV # Default network code where in 'Channe
# NET is optional and used only for output.
# STA can be '*', stands for all stations.
# CHAN can contain '?', stands for any character.
# Localtion value is always equal to "--".
# Related to the parameters 'ChannelFile' and 'Channel'.
# Network code will be assigned from the first
# pattern that includes station and channel.
......@@ -65,15 +66,15 @@ DefaultNetworkCode IV # Default network code where in 'Channe
# It is equivalent to the option -A. Related to 'ChannelFile'.
# If 'MaxDataToRetrieve' is zero and 'ChannelFile' is used,
# only data buffered by NaqsServer will be retrieved.
# It is preferable, inside the section Datastream of
# the file Naqs.ini, setting DataBufferLength to a high
# value, than using 'MaxDataToRetrieve'.
# It allows to retrieve much more data of the past when
# the program restarts but it slows down the execution.
# Rather than using 'MaxDataToRetrieve', it is preferable,
# inside the section Datastream of the file Naqs.ini,
# setting DataBufferLength to a high value.
# 'MaxDataToRetrieve' allows to retrieve much more data of the past
# when the program restarts but it considerably slows down the execution.
# It is extremely harmful when you have many channels.
ChannelFile /home/ew/naqs1a.list.txt # List of channel patterns like 'Channel'. One for each line.
ChannelFile /home/ew/naqs1a.list.txt # List of channel patterns, as in 'Channel'. One for each line.
# This file will not be modified by nmxptool.
# Load/Save time of last sample of each channel in a file
# with the same name, same directory, appending suffix ".nmxpstate"
......@@ -81,17 +82,18 @@ ChannelFile /home/ew/naqs1a.list.txt # List of channel patterns like 'Channe
# Related to 'MaxDataToRetrieve', it enables request of recent packets.
# It is equivalent to the option -F. Related to 'MaxDataToRetrieve'.
#mschan 250/9 # mSECs/nC
# mSECs are the milliseconds to wait before next request,
#mschan 280/9 # mSECs/nC
# mSECs are milliseconds to wait before the next request,
# nC is the number of channels to request at a time.
# This kind of request management makes data buffering
# on NaqsServer side more efficient. (Default 280/9).
# Condition: Total number channels * (mSECs/nC) < 15 sec.
# Delaying and requesting few channels at a time make
# data buffering on NaqsServer side more efficient.
# Determined empiric values are default 280/9.
# Condition: TotalNumberOfChannels * (mSECs/nC) < 15 sec.
# Related to -F and -b. 0/0 for disabling.
# DO NOT USE parameters 'Channel' and 'ChannelFile' together.
# 'ChannelFile' is preferable. At restart you can retrieve data
# of the past from DataServer. See 'MaxDataToRetrieve'.
# 'ChannelFile' is preferable. At restart you can retrieve data of the past
# from the NaqsServer and optionally from the DataServer, see 'MaxDataToRetrieve'.
# Example of nmxptool channel definition
# Channel ES.BOB.HH?
......
......@@ -83,7 +83,7 @@ of data to be requested from the NmxpHost.
The <font color="red">streamkey</font> is not in SCNL format. It is composed of a network, station and channel code
separated by period. network is optional and it is used only for output.
Station code can be &quot;&#42;&quot; that stands for all stations.
Within channel code can appear character &quot;&#63;&quot; that stands for any characters.
Within channel code can appear character &quot;&#63;&quot; that stands for any characters. Location value is always set to &quot;--&quot;.
DO NOT USE WITH <a href="#ChannelFile">ChannelFile</a>!
<pre>
Default: none
......@@ -186,12 +186,12 @@ stdout and stderr is suppressed.
<pre><a name="MaxDataToRetrieve"><b>MaxDataToRetrieve <font color="red">seconds</font> ReadConfig nmxptool parameters<br></b><!-- command args ... --> <br></a></pre>
<blockquote><!-- command description goes here --> Max amount of data of the past to retrieve from the DataServer when program restarts. 0 to disable connection to DataServer.
If this parameter is zero and <a href="#ChannelFile">ChannelFile</a> is used, only data buffered by NaqsServer will be retrieved.
It is preferable, inside the section Datastream of
the file Naqs.ini, setting DataBufferLength to a high
value, than using <a href="#MaxDataToRetrieve">MaxDataToRetrieve</a>.
It allows to retrieve
Rather than using <a href="#MaxDataToRetrieve">MaxDataToRetrieve</a>,
it is preferable, inside the section Datastream of
the file Naqs.ini, setting DataBufferLength to a high value.
<a href="#MaxDataToRetrieve">MaxDataToRetrieve</a> allows to retrieve
much more data of the past when the program restarts but
it slows down the execution.
it considerably slows down the execution.
It is extremely harmful when you have many channels.
Range is [0..86400].
<pre><!-- Default and example go here --><br>Default: 0<br>Example: MaxDataToRetrieve 3600</pre>
......@@ -297,7 +297,7 @@ Not yet.
MyModuleId MOD_NMXPTOOL
RingName WAVE_RING # Transport ring to write data to.
HeartBeatInterval 15 # Heartbeat interval, in seconds.
HeartBeatInterval 10 # Heartbeat interval, in seconds.
LogFile 1 # 1 -> Keep log, 0 -> no log file
# 2 -> write to module log but not stderr/stdout
......@@ -313,7 +313,7 @@ Verbosity 16 # Set level of verbosity. Verbosity is
# 256 Gap, 512 DOD, 1023 All messages.
# It is equivalent to the option -v.
NmxpHost naqs1a.int.ingv.it # Host address of NaqsServer/DataServer
NmxpHost naqs1a.int.ingv.it # NaqsServer/DataServer hostname or IP address.
# It is equivalent to the option -H.
NmxpPortPDS 28000 # Port number of NaqsServer (Default 28000)
......@@ -321,16 +321,16 @@ NmxpPortPDS 28000 # Port number of NaqsServer (Default 28
NmxpPortDAP 28002 # Port number of DataServer(Default 28002)
# It is equivalent to the option -D.
#UserDAP mtheo # DataServer user name. Comment if 'none'.
#UserDAP mtheo # DataServer user name. Commented if 'none'.
# It is equivalent to the option -u.
#PassDAP mypass # DataServer password. Comment if 'none'.
#PassDAP mypass # DataServer password. Commented if 'none'.
# It is equivalent to the option -p.
MaxTolerableLatency 120 # Max tolerable latency for each channel. (Default 600 sec.)
# In general, DO NOT use with parameter TimeoutRecv.
# It is equivalent to the option -M.
#TimeoutRecv 30 # Time-out in seconds for flushing queued data for each channel.
#TimeoutRecv 30 # Time-out in seconds for flushing queued data of each channel.
# (Default 0. No time-out) [10..300].
# Useful for retrieving Data On Demand with minimum delay.
# 'tsec' in nmxptool.desc should be greater than 'TimeoutRecv'.
......@@ -344,6 +344,7 @@ DefaultNetworkCode IV # Default network code where in 'Channe
# NET is optional and used only for output.
# STA can be '*', stands for all stations.
# CHAN can contain '?', stands for any character.
# Localtion value is always equal to "--".
# Related to the parameters 'ChannelFile' and 'Channel'.
# Network code will be assigned from the first
# pattern that includes station and channel.
......@@ -358,15 +359,15 @@ DefaultNetworkCode IV # Default network code where in 'Channe
# It is equivalent to the option -A. Related to 'ChannelFile'.
# If 'MaxDataToRetrieve' is zero and 'ChannelFile' is used,
# only data buffered by NaqsServer will be retrieved.
# It is preferable, inside the section Datastream of
# the file Naqs.ini, setting DataBufferLength to a high
# value, than using 'MaxDataToRetrieve'.
# It allows to retrieve much more data of the past when
# the program restarts but it slows down the execution.
# It is extremely harmful when declare a lot of channels.
# Rather than using 'MaxDataToRetrieve', it is preferable,
# inside the section Datastream of the file Naqs.ini,
# setting DataBufferLength to a high value.
# 'MaxDataToRetrieve' allows to retrieve much more data of the past
# when the program restarts but it considerably slows down the execution.
# It is extremely harmful when you have many channels.
ChannelFile /home/ew/naqs1a.list.txt # List of channel patterns like 'Channel'. One for each line.
ChannelFile /home/ew/naqs1a.list.txt # List of channel patterns, as in 'Channel'. One for each line.
# This file will not be modified by nmxptool.
# Load/Save time of last sample of each channel in a file
# with the same name, same directory, appending suffix ".nmxpstate"
......@@ -374,9 +375,18 @@ ChannelFile /home/ew/naqs1a.list.txt # List of channel patterns like 'Channe
# Related to 'MaxDataToRetrieve', it enables request of recent packets.
# It is equivalent to the option -F. Related to 'MaxDataToRetrieve'.
#mschan 280/9 # mSECs/nC
# mSECs are milliseconds to wait before the next request,
# nC is the number of channels to request at a time.
# Delaying and requesting few channels at a time make
# data buffering on NaqsServer side more efficient.
# Determined empiric values are default 280/9.
# Condition: TotalNumberOfChannels * (mSECs/nC) < 15 sec.
# Related to -F and -b. 0/0 for disabling.
# DO NOT USE parameters 'Channel' and 'ChannelFile' together.
# 'ChannelFile' is preferable. At restart you can retrieve data
# of the past from DataServer. See 'MaxDataToRetrieve'.
# 'ChannelFile' is preferable. At restart you can retrieve data of the past
# from the NaqsServer and optionally from the DataServer, see 'MaxDataToRetrieve'.
# Example of nmxptool channel definition
# Channel ES.BOB.HH?
......@@ -389,6 +399,7 @@ ChannelFile /home/ew/naqs1a.list.txt # List of channel patterns like 'Channe
# Please, for other details about parameters, refer to the command line "nmxptool -h"
</pre>
<hr>
......
......@@ -7,7 +7,7 @@
* Istituto Nazionale di Geofisica e Vulcanologia - Italy
* quintiliani@ingv.it
*
* $Id: nmxptool_getoptlong.c,v 1.89 2008-03-24 14:00:52 mtheo Exp $
* $Id: nmxptool_getoptlong.c,v 1.90 2008-03-24 14:22:32 mtheo Exp $
*
*/
......@@ -179,7 +179,7 @@ Main arguments:\n\
Second pattern includes the first. Unless AAA, all\n\
stations with HH channels will have network to N2.\n\
Station MMM will have default network defined by -N.\n\
-F, --statefile=FILE List of channel patterns as in -C. One for each line.\n\
-F, --statefile=FILE List of channel patterns, as in -C. One for each line.\n\
Load/Save time of the last sample of each channel\n\
into a file with the same name, same directory,\n\
appending the suffix '%s'.\n\
......@@ -195,11 +195,11 @@ Main arguments:\n\
0 to disable connection to DataServer.\n\
If this option is equal to zero and -F is used,\n\
only data buffered by NaqsServer will be retrieved.\n\
It is preferable, inside the section Datastream of\n\
the file Naqs.ini, setting DataBufferLength to a high\n\
value, than using -A. It allows to retrieve much more\n\
Rather than using -A, it is preferable, inside the section\n\
Datastream of the file Naqs.ini, setting DataBufferLength \n\
to a high value. -A allows to retrieve much more\n\
data of the past when the program restarts but it\n\
slows down the execution.\n\
considerably slows down the execution.\n\
It is extremely harmful when you have many channels.\n\
Related to -F.\n\
\n",
......@@ -245,9 +245,9 @@ DEFAULT_USEC / 1000, DEFAULT_N_CHANNEL, NMXP_MAX_MSCHAN_MSEC / 1000);
nmxp_log(NMXP_LOG_NORM_NO, NMXP_LOG_D_ANY, "\
-L, --listchannelsnaqs List of the available Time Series channels on NaqsServer.\n\
-M, --maxlatency=SECs Max tolerable latency (default %d) [%d..%d].\n\
-T, --timeoutrecv=SECs Time-out for flushing buffered packets.\n\
-T, --timeoutrecv=SECs Time-out for flushing queued packets of each channel.\n\
(default %d, no time-out) [%d..%d].\n\
-T is useful for retrieving Data On Demand.\n\
-T is useful for retrieving Data On Demand with minimum delay.\n\
-M, -T are usable only with Raw Stream, -S=-1.\n\
In general, -M and -T are not used together.\n\
\n\
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment