Changeset 1510 in ntrip for trunk/BNC/bnchelp.html

Timestamp:

Jan 20, 2009, 12:38:46 AM (16 years ago)

Author:

weber

Message:

* empty log message *

File:

• trunk/BNC/bnchelp.html (modified) (9 diffs)

trunk/BNC/bnchelp.html

@@ -74 +74 @@
 </p>
 <p>
-All options for running BNC on Unix/Linux/Mac systems are saved in file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf, see annexed 'Configuration File Example'. On Windows systems options are saved in register BKG_NTRIP_Client. The self-explaining contents of the configuration file or the Windows register can easily be edited. Some options can be changed on-the-fly.
+As default, all options for running BNC on Unix/Linux/Mac systems are saved in file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf, see annexed 'Configuration File Example'. On Windows systems options are saved in register BKG_NTRIP_Client (default). The self-explaining contents of the configuration file or the Windows register can easily be edited. Some options can be changed on-the-fly.
 </p>
 <p>
@@ -209 +209 @@
 <p><a name="genconf"><h4>3.4.3 Reread Configuration - optional</h4></p>
 <p>
-When operating BNC online in 'no window' mode (command line option -nw), some configuration options can nevertheless be changed on-the-fly without interrupting the running process. For that you force the program to reread parts of its configuration in pre-defined intervals. Select '1 min', '1 hour', or '1 day' to let BNC reread on-the-fly changeable configuration options every full minute, hour, or day. This lets in between edited options become effective without interrupting uninvolved threads. See annexed section 'Configuration File Example' for a Unix/Linux/Mac configuration file example and a list of on-the-fly changeable options.
+When operating BNC online in 'no window' mode (command line option -nw), some configuration options can nevertheless be changed on-the-fly without interrupting the running process. For that you force the program to reread parts of its configuration in pre-defined intervals from the disk. Select '1 min', '1 hour', or '1 day' to let BNC reread on-the-fly changeable configuration options every full minute, hour, or day. This lets in between edited options become effective without interrupting uninvolved threads. See annexed section 'Configuration File Example' for a Unix/Linux/Mac configuration file example and a list of on-the-fly changeable options.
 </p> 
 
@@ -832 +832 @@
 <u>Window mode:</u> Hit 'Save & Activate Options' while BNC is in window mode and already processing data to let changes of your streams selection immediately become effective.
 <p>
-<u>No window mode:</u> When operating BNC online in 'no window' mode (command line option -nw), you force BNC to reread its 'mountPoints' configuration option in pre-defined intervals. Select '1 min', '1 hour', or '1 day' as 'Reread configuration' option to reread the 'mountPoints' option every full minute, hour, or day. This lets a 'mountPoints' option edited in between in the configuration file or Windows register become effective without terminating uninvolved threads. See annexed section 'Configuration File Example' for a Unix/Linux/Mac configuration file example and a list of other on-the-fly changeable options.
+<u>No window mode:</u> When operating BNC online in 'no window' mode (command line option -nw), you force BNC to reread its 'mountPoints' configuration option from disk at pre-defined intervals. Select '1 min', '1 hour', or '1 day' as 'Reread configuration' option to reread the 'mountPoints' option every full minute, hour, or day. This lets a 'mountPoints' option edited in between in the configuration file or Windows register become effective without terminating uninvolved threads. See annexed section 'Configuration File Example' for a Unix/Linux/Mac configuration file example and a list of other on-the-fly changeable options.
 </p>
 
@@ -847 +847 @@
 <p><a name="cmd"><h4>3.15. Command Line Options</h4></p>
 <p> 
-Command line options are available to run BNC in 'no window' mode or let it read data from a file in offline mode. BNC will then use processing options from the configuration file (Unix/Linux/Mac) or from the register BKG_NTRIP_Client (Windows). Note that the self-explaining contents of the configuration file or the Windows register can easily be edited. 
+Command line options are available to run BNC in 'no window' mode or let it read data from a file in offline mode. BNC will then use processing options from the configuration file (Unix/Linux/Mac) or from the Windows register. Note that the self-explaining contents of the configuration file or the Windows register can easily be edited and it is possible to introduce specific configuration file/register names instead of the default name 'BKG_NTRIP_Client'.
 </p> 
 
 <p><a name="nw"><h4>3.15.1 No Window Mode - optional</h4></p>
 <p>
-Apart from its regular windows mode, BNC can be started on all systems as a background/batch job with command line option '-nw'. BNC will then run in 'no window' mode, using processing options from its configuration file. Terminate BNC using Windows Task Manager when running it in 'no window' mode on Windows systems.
+Apart from its regular windows mode, BNC can be started on all systems as a background/batch job with command line option '-nw'. BNC will then run in 'no window' mode, using processing options from its configuration file on disk. Terminate BNC using Windows Task Manager when running it in 'no window' mode on Windows systems.
 </p> 
 <p> 
@@ -879 +879 @@
 
 <p><a name="conffile"><h4>3.15.3 Configuration File - optional</h4></p>
-The default configuration file name on  Unix/Linux/Mac systems is 'BKG_NTRIP_Client' with suffix '.conf'. On Windows systems the configuration is saved in register 'BKG_NTRIP_Client'. You may change the configuration file/register string at startup time using the command line option '--conf &#060;<u>confFile</u>&#062;'.
+The default configuration file name on  Unix/Linux/Mac systems is 'BKG_NTRIP_Client' with suffix '.conf'. On Windows systems the configuration is saved in register 'BKG_NTRIP_Client'. You may change the configuration file/register name at startup time using the command line option '--conf &#060;<u>confFile</u>&#062;'.
 </p>
 <p>
 Example:<br><br>
-./bnc --conf myConf
+./bnc --conf MyConfig
 </p> 
 <p> 
-This leads to a configuration file 'myConf.conf' and a Windows register 'myConf'.
+This leads to a configuration file 'MyConfig.conf' and a Windows register 'MyConfig'.
 </p> 
 
@@ -924 +924 @@
 <li>
 Once BNC has been started, many of its configuration options can not be changed as long as it is stopped. See chapter 'Reread Configuration' for on-the-fly configuration exceptions.
-</li>
-<li>
-On Window systems it is not possible to run several BNC jobs in parallel on the same host because processing options are saved in the same Windows register. However, this is possible on Unix/Linux/Mac systems where the configuration is saved in files. <br>
-You may start several BNC jobs from shell scripts, each script with its own (re-)definition of $HOME directory (e.g. export $HOME=/home/user/bnc_test) before calling BNC so that the configuration file is saved e.g. at '/home/user/bnc_test/.config/BKG/BKG_NTRIP_client.conf'.<br>
-As an alternative, directory $HOME/.config could be overridden by the user by setting the XDG_CONFIG_HOME environment variable. Command 'export XDG_CONFIG_HOME=/home/temp' would lead to a configuration file /home/temp/BKG/BNC_NTRIP_Client.conf.
 </li>
 <br>
@@ -980 +975 @@
 <tr><td>Apr 2008 &nbsp;</td><td>Version 1.5 &nbsp;</td><td>[Add] Handle ephemeris from RTCM Version 3.x streams<br> [Add] Upgrade to Qt Version 4.3.2<br> [Add] Optional RINEX v3 output<br> [Add] SBAS support<br> [Bug] RINEX skeleton download following stream outage<br> [Add] Handle ephemeris from RTIGS streams<br> [Add] Monitor stream failure/recovery and latency<br> [Mod] Redesign of main window<br> [Bug] Freezing of About window on Mac systems<br> [Bug] Fixed problem with PRN 32 in RTCMv2 decoder<br> [Bug] Fix for Trimble 4000SSI receivers in RTCMv2 decoder<br> [Mod] Major revision of input buffer in RTCMv2 decoder</td></tr>
 <tr><td>Dec 2008 &nbsp;</td><td>Version 1.6 &nbsp;</td><td>[Mod] Fill blanc columns in RINEXv3 with 0.000<br> [Add] RTCMv3 decoder for clock and orbit corrections<br>[Add] Check RTCMv3 streams for incoming message types<br> [Add] Decode RTCMv2 message types 3, 20, 21, and 22<br> [Add] Loss of lock and lock time indicator<br> [Bug] Rounding error in RTCMv3 decoder concerning GLONASS height<br> [Mod] Accept GLONASS in RTCMv3 when transmitted first<br> [Add] Leap second 1 January 2009<br> [Add] Offline mode, read data from file<br> [Add] Output antenna descriptor, coordinates and excentricities from RTCMv3<br> [Add] Reconfiguration on-the-fly<br> [Mod] Binary ouput of synchronized observations<br> [Add] Binary output of unsynchronized observations<br> [Bug] Fixed problem with joined RTCMv3 blocks</td></tr>
-<tr><td>Jan 2009 &nbsp;</td><td>Version 1.7 &nbsp;</td><td>[Mod] NTRIP v1 source-table request<br> [Bug] RINEX navigation file format <br> [Add] Upgrade to Qt Version 4.4.3<br> [Add] Support of NTRIP v2<br> [Add] Rover support via serial port<br> [Add] Show broadcaster table from www.rtcm-ntrip.org<br> [Add] Enable/disable tab widgets</td></tr>
+<tr><td>Jan 2009 &nbsp;</td><td>Version 1.7 &nbsp;</td><td>[Mod] NTRIP v1 source-table request<br> [Bug] RINEX navigation file format <br> [Add] Upgrade to Qt Version 4.4.3<br> [Add] Support of NTRIP v2<br> [Add] Rover support via serial port<br> [Add] Show broadcaster table from www.rtcm-ntrip.org<br> [Add] Enable/disable tab widgets<br> [Add] Change default configuration file/register name<br> [Add] Remove configuration file/register contents</td></tr>
 </table>
 </p>
@@ -1179 +1174 @@
 <p><a name="config"><h4>8.4. Configuration File Example</h4></p>
 <p>
-The following is an example for the contents of a Unix/Linux/Mac configuration file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf. It enables the retrieval of stream ACOR0 form www.euref-ip.net and FFMJ3 from www.igs-ip.net for the generation of 15 min RINEX files. RINEX files are uploaded to an archive using script 'up2archive' :
+The following is an example for the contents of a Unix/Linux/Mac (default) configuration file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf. It enables the retrieval of stream ACOR0 form www.euref-ip.net and FFMJ3 from www.igs-ip.net for the generation of 15 min RINEX files. RINEX files are uploaded to an archive using script 'up2archive' :
 <pre>
 [General]
@@ -1232 +1227 @@
 </p>
 <p>
-Note that on Windows systems configuration options are saved in register BKG_NTRIP_Client.
-</p>
-<p>
-Note further that configuration options that can be changed/edited on-the-fly while BNC is already processing data are
+Note that on Windows systems configuration options are saved in (default) register BKG_NTRIP_Client.
+</p>
+<p>
+Note further that configuration options saved on disk can be changed/edited on-the-fly while BNC is already processing data.
 </p>
 <p>