Changeset 7689 in ntrip for trunk/BNC

Timestamp:

Jan 15, 2016, 5:37:16 PM (9 years ago)

Author:

weber

Message:

Documentation completed

File:

• trunk/BNC/src/bnchelp.html (modified) (6 diffs)

trunk/BNC/src/bnchelp.html

@@ -30 +30 @@
 &nbsp; &nbsp; &nbsp; 1.3 <a href=#introFlow>Data Flow</a><br>
 &nbsp; &nbsp; &nbsp; 1.4 <a href=#introHandling>Handling</a><br>
-&nbsp; &nbsp; &nbsp; 1.5 <a href=#introConf>Configuration</a><br>
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; 1.5.1 <a href=#introManage>Management</a><br>
-&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; 1.5.2 <a href=#introExamples>Examples</a><br>
-&nbsp; &nbsp; &nbsp; 1.6 <a href=#introLimit>Limitations</a><br>
-&nbsp; &nbsp; &nbsp; 1.7 <a href=#introLBack>Looking Back</a><br><br>
+&nbsp; &nbsp; &nbsp; 1.5 <a href=#introInst>Installation</a><br>
+&nbsp; &nbsp; &nbsp; 1.6 <a href=#introConf>Configuration</a><br>
+&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; 1.6.1 <a href=#introManage>Management</a><br>
+&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; 1.6.2 <a href=#introExamples>Examples</a><br>
+&nbsp; &nbsp; &nbsp; 1.7 <a href=#introLimit>Limitations</a><br>
+&nbsp; &nbsp; &nbsp; 1.8 <a href=#introLBack>Looking Back</a><br><br>
 <b>2.</b> <a href=#optsettings><b>Settings Details</b></a><br><br>
 &nbsp; &nbsp; &nbsp; 2.1 <a href=#topmenu><b>Top Menu Bar</b></a><br>
@@ -287 +288 @@
 
 <p>
-BNC has been written under GNU General Public License (GPL). Source code is available from Subversion software archive <u>http://software.rtcm-ntrip.org/svn/trunk/BNC.</u> Binaries for BNC are available for Windows, Linux, and Mac OS X systems. We used the MinGW Version 4.4.0 compiler to create the Windows binaries. It is likely that BNC can be compiled on other systems where a GNU compiler and Qt Version 4.8.4 or any later version are installed. Please ensure that you always use the latest precompiled version of BNC available from <u>http://igs.bkg.bund.de/ntrip/download</u>. Note that static and shared builds of BNC are made available. A <u>static</u> build would be sufficient in case you don't want BNC to trace PPP results using Google Map (GM) or OpenStreetMap (OSM). However, GM/OSM usage requires the QtWebKit library which can only be part of BNC builds from <u>shared</u> libraries. Using a shared library BNC build requires that you first install your own shared Qt library. The 'README.txt' file which comes with the BNC source code describes how to install Qt on Windows, Linux and Mac systems.
+BNC has been written under GNU General Public License (GPL). Source code is available from Subversion software archive <u>http://software.rtcm-ntrip.org/svn/trunk/BNC.</u> Binaries for BNC are available for Windows, Linux, and Mac OS X systems.
 </p>
 <p>
@@ -600 +601 @@
 </p>
 
-<p><h4>1.5 <a name="introConf">Configuration</h4></p>
+<p><h4>1.5 <a name="introInst">Installation</h4></p>
+<p>
+ We used the MinGW Version 4.4.0 compiler to create the Windows binaries. It is likely that BNC can be compiled on other systems where a GNU compiler and Qt Version 4.8.4 or any later version are installed. Please ensure that you always use the latest precompiled version of BNC available from <u>http://igs.bkg.bund.de/ntrip/download</u>. Note that static and shared builds of BNC are made available. A <u>static</u> build would be sufficient in case you don't want BNC to trace PPP results using Google Map (GM) or OpenStreetMap (OSM). However, GM/OSM usage requires the QtWebKit library which can only be part of BNC builds from <u>shared</u> libraries. Using a shared library BNC build requires that you first install your own shared Qt library. The 'README.txt' file which comes with the BNC source code describes how to install Qt on Windows, Linux and Mac systems.
+</p>
+<p>
+This ZIP archive provides the BNC source code Version 2.12.0 as developed under GNU GPL using Qt Version 4.8.5. The following describes how to produce your builds of BNC on Windows, Linux, and Mac systems. 
+</p>
+
+<p><b>Static and Shared Libraries</b><br>
+You can produce static or shared builds of BNC. Static builds are sufficient in case you don't want BNC to produce track maps using Google Map (GM) or Open StreetMap (OSM). GM/OSM usage would requires the QtWebKit library which can only be part of BNC builds from shared libraries. So, using a shared library BNC build requires that you first install your own shared library of Qt.
+</p>
+
+<p><b>Windows Systems, Shared Library</b><br>
+How to install a shared QT 4.8.5 library on a Windows system to create your
+own shared build of BNC:
+</p>
+
+<ol type=b>
+<li>Supposing that "Secure Socket Layer (SSL)" is not available on you system, you should install OpenSSL libraries in C:\OpenSSL-Win32. They are availabel e.g. from http://slproweb.com/download/Win32OpenSSL-1_0_1e.exe. See <u>http://slproweb.com/products/Win32OpenSSL.html</u> for other SSL resources. Ignore possible comments about missing components during installation.</li>
+
+<li>Download MinGW compiler Version 4.4.0 e.g. from <u>http://igs.bkg.bund.de/root_ftp/NTRIP/software/MinGW-gcc440_1.zip</u></li>
+
+<li>Unzip the ZIP archive and move its contents to a directory C:\MinGW. Now you can do either (4) or (5, 6, 8, 9, 10). Following (4) is suggested.</li>
+
+<li>Download file 'qt-win-opensource-4.8.5-mingw.exe' (317 MB) e.g. from <u>http://download.qt-project.org/official_releases/qt/4.8/4.8.5</u>. Execute this file to install a pre-compiled shared Qt library.</li>
+     
+<li>Download file 'qt-everywhere-opensource-src-4.8.5.zip' (269 MB) e.g. from <u>http://download.qt-project.org/official_releases/qt/4.8/4.8.5</u></li>
+
+<li>Unzip the ZIP archive and move the contents of the contained directory into a directory C:\Qt\4.8.5.</li>
+
+<li>Create somewhere a file QtEnv.bat with the following content:
+<pre>
+  set QTDIR=C:\Qt\4.8.5
+  set PATH=%PATH%;C:\MinGW\bin;C:\Qt\4.8.5\bin
+  set QMAKESPEC=C:\Qt\4.8.5\mkspecs\win32-g++
+</pre></li>
+
+<li>Open a command line window and execute file QtEnv.bat</li>
+
+<li>Go to directory C:\Qt\4.8.5 and configure Qt using command
+<pre>
+  configure -fast -webkit -release -nomake examples -nomake tutorial
+            -openssl -I C:\OpenSSL-Win32\include
+</pre></li>
+
+<li>Compile Qt using command<pre>  mingw32-make</pre>
+This may take quite a long time. Don't worry if the compilation process runs into a problem after some time. It is likely that the libraries you require are already generated at that time.<br>
+Should you want to reconfiguring Qt following steps (8)-(10) you first need to clean the previous configuration using command 'mingw32-make confclean'. Run command 'mingw32-make clean' to delete previously compiled source code.</li>
+
+<li>Download latest BNC from <u>http://software.rtcm-ntrip.org/svn/trunk/BNC</u></li>
+
+<li>Open command line window and execute file QtEnv.bat, see (7)</li>
+
+<li>Go to directory BNC and enter command<pre>  qmake bnc.pro</pre></li>
+
+<li>Enter command <pre>  mingw32-make</pre></li>
+
+<li>Find binary file bnc.exe in directory named src.</li>
+
+<li>Extend the Windows environment variable PATH by C:\Qt\4.8.5\bin.</li>
+</ol>
+
+<p>
+Steps (11)-(15) can be repeated whenever a BNC update becomes available. Running bnc.exe on a windows system requires (1) when using the NTRIP Version 2s option for stream transfer over TLS/SSL.
+</p>
+
+<p>
+<b>Linux Systems</b><br>
+On Linux systems you may use the following procedure to install a shared Qt version 4.8.5 library:
+</p>
+
+<p>
+Download file 'qt-everywhere-opensource-src-4.8.5.tar.gz' (230 MB) available from <u>https://download.qt.io/archive/qt/4.8/4.8.5/</u>. Then unzip file, extract tar archive and change to directory 'qt-everywhere-opensource-src-4.8.5.'. Run commands
+<pre>
+  ./configure -fast -webkit -nomake examples -nomake tutorial 
+              -prefix /usr/local/Trolltech/Qt-4.8.5
+  gmake
+  gmake install
+</pre>
+</p>
+
+<p>
+Qt will be installed into directory /usr/local/Trolltech/Qt-4.8.5. To reconfigure, run 'gmake confclean' and 'configure'. Note that the -prefix option allows you to specify a directory for saving the Qt libraries. This ensures that you don't run into conflicts with other
+Qt installations on your host. Note further that the following two lines<pre>
+  export QTDIR="/usr/local/Trolltech/Qt-4.8.5"
+  export PATH="$QTDIR/bin:$PATH"</pre>
+
+need to be introduced either in $HOME/.bash_profile or $HOME/.bashrc. Once that is done, logout/login and start using Qt 4.8.5.
+</p>
+<p>
+To then compile the BNC program you may use the following commands: <pre>
+  qmake bnc.pro
+  make
+</pre>
+</p>
+
+<p>
+<b>Mac OS X Systems</b><br>
+
+<u>Xcode and Qt Installation</u><br>
+Xcode and Qt are required to compile BNC on OS X. Both tools are freely available. Xcode can be downloaded from the App Store or the Apple Developer Connection website. Once installed, run Xcode, go to Preferences -> Downloads and install the Command Line Tools component. Qt can be downloaded from the QT Project website. Note that as of version 2.6 BNC requires Qt version 4.7.3 or higher due to SSL. The Qt libraries for Mac can be downloaded from http://qt-project.org/downloads. Once downloaded, mount the disk image, run the Qt.mpkg package and follow the instructions from the installation wizard.
+</p>
+
+<p>
+<u>Compiling BNC</u><br>
+The version of qmake supplied in the Qt binary package is configured to use the macx-xcode specification. This can be overridden with the '-spec macx-g++' option which makes it possible to use qmake to create a Makefile to be used by 'make'.
+</p>
+<p>
+From the directory where bnc.pro is located, run qmake to create the Makefile and then make to compile the binary.
+<pre>
+  qmake -spec macx-g++ bnc.pro
+  make
+</pre>
+Refer to the following webpage for further information: <u>http://qt-project.org/doc/qt-4.8/qmake-platform-notes.html</u>.
+</p>
+
+<p>
+<u>Bundle Deployment</u><br>
+When distributing BNC it is necessary to bundle in all related Qt resources in the package. The Mac Deployment Tool has been designed to automate the process of creating a deployable application bundle that contains the Qt libraries as private frameworks. To use it, issue the following commands where bnc.app is located.
+<pre>
+  macdeployqt bnc.app -dmg
+</pre>
+Refer to the following webpage for further information: http://qt-project.org/doc/qt-4.8/deployment-mac.html.
+</p>
+
+<p><b>Running the Program</b><br>
+If you are not familiar with the BNC program, we suggest to start with the Readme.txt file in the Example_Configs directory. See bnchelp.pdf for further information.
+</p>
+
+<p><h4>1.6 <a name="introConf">Configuration</h4></p>
 <p>
 The following sections present information on how the BNC configuration works and provide configuration examples which can be adjusted according to specific user needs.
 </p>
 
-<p><h4>1.5.1 <a name="introManage">Management</h4></p>
+<p><h4>1.6.1 <a name="introManage">Management</h4></p>
 <p>
 As a default, configuration files for running BNC on Unix/Linux/Mac OS X systems are saved in directory '${HOME}/.config/BKG'. On Windows systems, they are typically saved in directory 'C:/Documents and Settings/Username/.config/BKG'. The default configuration filename is 'BNC.bnc'.</p>
@@ -644 +774 @@
 </p>
 
-<p><h4>1.5.2 <a name="introExamples">Examples</h4></p>
+<p><h4>1.6.2 <a name="introExamples">Examples</h4></p>
 
 <p>
@@ -882 +1012 @@
 </p>
 
-<p><h4>1.6 <a name="introLimit">Limitations</h4></p>
+<p><h4>1.7 <a name="introLimit">Limitations</h4></p>
 <ul>
 <li>
@@ -908 +1038 @@
 </ul>
 
-<p><h4>1.7 <a name="introLBack">Looking Back</h4></p>
+<p><h4>1.8 <a name="introLBack">Looking Back</h4></p>
 <p>
 A basic function of BNC is streaming GNSS data over the open Internet using the Ntrip transport protocol. Employing IP streaming for satellite positioning goes back to the beginning of our century. Wolfgang Rupprecht has been the first person who developed TCP/IP server software under the acronym of DGPS-IP (Rupprecht 2000) and published it under GNU General Public License (GPL). While connecting marine beacon receivers to PCs with permanent access to the Internet he transmitted DGPS corrections in an RTCM format to support Differential GPS positioning over North America. With approximately 200 bits/sec the bandwidth requirement for disseminating beacon data was comparatively small. Each stream was transmitted over a unique combination of IP address and port. Websites informed about existing streams and corresponding receiver positions.