Changeset 7283 in ntrip for trunk/BNC/src/bncmain.cpp


Ignore:
Timestamp:
Sep 15, 2015, 12:19:08 PM (9 years ago)
Author:
weber
Message:

Documentation completed

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/BNC/src/bncmain.cpp

    r7282 r7283  
    8484      "\n"
    8585      "Internal keys:\n"
    86       "           --startTab      <Top panel index number>\n"
    87       "           --statusTab     <Bottom panel index number>\n"
    88       "           --font          <Used font>\n"
     86      "           startTab      <Top panel index number>\n"
     87      "           statusTab     <Bottom panel index number>\n"
     88      "           font          <Used font>\n"
    8989      "\n"
    9090      "Network Panel keys:\n"
    91       "           --proxyHost       <Proxy host>\n"
    92       "           --proxyPort       <Proxy port>\n"
    93       "           --sslCaCertPath   <Path to SSL certificates>\n"
    94       "           --ignoreSslErrors <Ignore SSL authorization errors, 0=no, 2=yes>\n"
     91      "           proxyHost       <Proxy host>\n"
     92      "           proxyPort       <Proxy port>\n"
     93      "           sslCaCertPath   <Path to SSL certificates>\n"
     94      "           ignoreSslErrors <Ignore SSL authorization errors, 0=no, 2=yes>\n"
    9595      "\n"
    9696      "General Panel keys:\n"
    97       "           --logFile          <Logfile, full path>\n"
    98       "           --rnxAppend        <Append files, 0=no, 2=yes>\n"
    99       "           --onTheFlyInterval <Reread configuration, interval>\n"
    100       "           --autoStart        <Auto start, 0=no, 2=yes>\n"
    101       "           --rawOutFile       <Raw output file, full path>\n"
     97      "           logFile          <Logfile, full path>\n"
     98      "           rnxAppend        <Append files, 0=no, 2=yes>\n"
     99      "           onTheFlyInterval <Reread configuration, interval>\n"
     100      "           autoStart        <Auto start, 0=no, 2=yes>\n"
     101      "           rawOutFile       <Raw output file, full path>\n"
    102102      "\n"
    103103      "RINEX Observations Panel keys:\n"
    104       "           --rnxPath        <Directory>\n"
    105       "           --rnxIntr        <Interval>\n"
    106       "           --rnxSample      <Sampling [sec]> \n"
    107       "           --rnxSkel        <Skeleton file extension>\n"
    108       "           --rnxOnlyWithSKL <Skeleton is mandatory, 0=no, 2=yes>\n"
    109       "           --rnxScript      <File upload script>\n"
    110       "           --rnxV2Priority  <Signal priority>\n"
    111       "           --rnxV3          <Produce version 3 file contents, 0=no, 2=yes>\n"
    112       "           --rnxV3filenames <Produce version 3 filenames, 0=no, 2=yes>\n"
     104      "           rnxPath        <Directory>\n"
     105      "           rnxIntr        <Interval>\n"
     106      "           rnxSample      <Sampling [sec]> \n"
     107      "           rnxSkel        <Skeleton file extension>\n"
     108      "           rnxOnlyWithSKL <Skeleton is mandatory, 0=no, 2=yes>\n"
     109      "           rnxScript      <File upload script>\n"
     110      "           rnxV2Priority  <Signal priority>\n"
     111      "           rnxV3          <Produce version 3 file contents, 0=no, 2=yes>\n"
     112      "           rnxV3filenames <Produce version 3 filenames, 0=no, 2=yes>\n"
    113113      "\n"
    114114      "RINEX Ephemeris Panel keys:\n"
    115       "           --ephPath         <Directory>\n"
    116       "           --ephIntr         <Interval>\n"
    117       "           --outEphPort      <Port>\n"
    118       "           --ephV3           <Produce version 3 file contents, 0=no, 2=yes>\n"
    119       "           --ephV3filenames  <Produde version 3 filenames, 0=no, 2=yes>\n"
     115      "           ephPath         <Directory>\n"
     116      "           ephIntr         <Interval>\n"
     117      "           outEphPort      <Port>\n"
     118      "           ephV3           <Produce version 3 file contents, 0=no, 2=yes>\n"
     119      "           ephV3filenames  <Produde version 3 filenames, 0=no, 2=yes>\n"
    120120      "\n"
    121121      "RINEX Editing and QC Panel keys:\n"
    122       "           --reqcAction            <Action, Edit/Concatenate|Analyze>\n"
    123       "           --reqcObsFile           <Input observations file(s)>\n"
    124       "           --reqcNavFile           <Input navigation file(s)>\n"
    125       "           --reqcOutObsFile        <Output observations file>\n"
    126       "           --reqcOutNavFile        <Output navigation file>\n"
    127       "           --reqcOutLogFile        <Output logfile>\n"
    128       "           --reqcLogSummaryOnly    <Only summary output logfile, 0=no, 2=yes>\n"
    129       "           --reqcSkyPlotSignals    <Plots for signals list>\n"
    130       "           --reqcPlotDir           <QC plots directory>\n"
    131       "           --reqcRnxVersion        <RINEX version, 2|3>\n"
    132       "           --reqcSampling          <RINEX sampling [sec]>\n"
    133       "           --reqcV2Priority        <Version 2 signal priority list>\n"
    134       "           --reqcStartDateTime     <Start time>\n"
    135       "           --reqcEndDateTime       <Stop time>\n"
    136       "           --reqcRunBy             <Operators name>\n"
    137       "           --reqcUseObsTypes       <Use observation types list>\n"
    138       "           --reqcComment           <Additional comments>\n"
    139       "           --reqcOldMarkerName     <Old marker name>\n"
    140       "           --reqcNewMarkerName     <New marker name>\n"
    141       "           --reqcOldAntennaName    <Old antenna name>\n"
    142       "           --reqcNewAntennaName    <New antenna name>\n"
    143       "           --reqcOldAntennaNumber  <Old antenna number>\n"
    144       "           --reqcNewAntennaNumber  <New antenna number>\n"
    145       "           --reqcOldAntennadN      <Old north eccentritity>\n"
    146       "           --reqcNewAntennadN      <New north eccentricity>\n"
    147       "           --reqcOldAntennadE      <Old east eccentricity>\n"
    148       "           --reqcNewAntennadE      <New east eccentricity>\n"
    149       "           --reqcOldAntennadU      <Old up eccentritity>\n"
    150       "           --reqcNewAntennadU      <New up eccentricity>\n"
    151       "           --reqcOldReceiverName   <Old receiver name>\n"
    152       "           --reqcNewReceiverName   <New receiver name>\n"
    153       "           --reqcOldReceiverNumber <Old receiver number>\n"
    154       "           --reqcNewReceiverNumber <New receiver number>\n"
     122      "           reqcAction            <Action, Edit/Concatenate|Analyze>\n"
     123      "           reqcObsFile           <Input observations file(s)>\n"
     124      "           reqcNavFile           <Input navigation file(s)>\n"
     125      "           reqcOutObsFile        <Output observations file>\n"
     126      "           reqcOutNavFile        <Output navigation file>\n"
     127      "           reqcOutLogFile        <Output logfile>\n"
     128      "           reqcLogSummaryOnly    <Only summary output logfile, 0=no, 2=yes>\n"
     129      "           reqcSkyPlotSignals    <Plots for signals list>\n"
     130      "           reqcPlotDir           <QC plots directory>\n"
     131      "           reqcRnxVersion        <RINEX version, 2|3>\n"
     132      "           reqcSampling          <RINEX sampling [sec]>\n"
     133      "           reqcV2Priority        <Version 2 signal priority list>\n"
     134      "           reqcStartDateTime     <Start time>\n"
     135      "           reqcEndDateTime       <Stop time>\n"
     136      "           reqcRunBy             <Operators name>\n"
     137      "           reqcUseObsTypes       <Use observation types list>\n"
     138      "           reqcComment           <Additional comments>\n"
     139      "           reqcOldMarkerName     <Old marker name>\n"
     140      "           reqcNewMarkerName     <New marker name>\n"
     141      "           reqcOldAntennaName    <Old antenna name>\n"
     142      "           reqcNewAntennaName    <New antenna name>\n"
     143      "           reqcOldAntennaNumber  <Old antenna number>\n"
     144      "           reqcNewAntennaNumber  <New antenna number>\n"
     145      "           reqcOldAntennadN      <Old north eccentritity>\n"
     146      "           reqcNewAntennadN      <New north eccentricity>\n"
     147      "           reqcOldAntennadE      <Old east eccentricity>\n"
     148      "           reqcNewAntennadE      <New east eccentricity>\n"
     149      "           reqcOldAntennadU      <Old up eccentritity>\n"
     150      "           reqcNewAntennadU      <New up eccentricity>\n"
     151      "           reqcOldReceiverName   <Old receiver name>\n"
     152      "           reqcNewReceiverName   <New receiver name>\n"
     153      "           reqcOldReceiverNumber <Old receiver number>\n"
     154      "           reqcNewReceiverNumber <New receiver number>\n"
    155155      "\n"
    156156      "SP3 Comparison Panel keys:\n"
    157       "           --sp3CompFile       <SP3 input files, full path>\n"
    158       "           --sp3CompExclude    <Satellite exclusion list>\n"
    159       "           --sp3CompOutLogFile <Output logfile>\n"
     157      "           sp3CompFile       <SP3 input files, full path>\n"
     158      "           sp3CompExclude    <Satellite exclusion list>\n"
     159      "           sp3CompOutLogFile <Output logfile>\n"
    160160      "\n"
    161161      "Broadcast Corrections Panel keys:\n"
    162       "           --corrPath <Directory for saving files in ASCII format>\n"
    163       "           --corrIntr <Interval>\n"
    164       "           --corrPort <Port>\n"
     162      "           corrPath <Directory for saving files in ASCII format>\n"
     163      "           corrIntr <Interval>\n"
     164      "           corrPort <Port>\n"
    165165      "\n"
    166166      "Feed Engine Panel keys:\n"
    167       "           --outPort  <Port>\n"
    168       "           --waitTime <Wait for full obs epoch [sec]>\n"
    169       "           --binSampl <Sampling [sec]>\n"
    170       "           --outFile  <File, full path>\n"
    171       "           --outUPort <Port, unsynchronized output)>\n"
     167      "           outPort  <Port>\n"
     168      "           waitTime <Wait for full obs epoch [sec]>\n"
     169      "           binSampl <Sampling [sec]>\n"
     170      "           outFile  <File, full path>\n"
     171      "           outUPort <Port, unsynchronized output)>\n"
    172172      "\n"
    173173      "Serial Output Panel:\n"
    174       "           --serialMountPoint         <Mountpoint>\n"
    175       "           --serialPortName           <Port name>\n"
    176       "           --serialBaudRate           <Baud rate, 110|300|600|1200|2400|4800|9600|...>\n"
    177       "           --serialFlowControl        <Flow control, OFF|XONXOFF|HARDWARE>\n"
    178       "           --serialDataBits           <Data bits, 5|6|7|8>\n"
    179       "           --serialParity             <Parity, NONE|ODD|EVEN|SPACE>\n"
    180       "           --serialStopBits           <Stop bits, 1|2>\n"
    181       "           --serialAutoNMEA           <NMEA, no|Auto|Manual GPGGA|Manual GNGGA>\n"
    182       "           --serialFileNMEA           <NMEA filename>\n"
    183       "           --serialHeightNMEA         <Height>\n"
    184       "           --serialHeightNMEASampling <Sampling [sec]>\n"
     174      "           serialMountPoint         <Mountpoint>\n"
     175      "           serialPortName           <Port name>\n"
     176      "           serialBaudRate           <Baud rate, 110|300|600|1200|2400|4800|9600|...>\n"
     177      "           serialFlowControl        <Flow control, OFF|XONXOFF|HARDWARE>\n"
     178      "           serialDataBits           <Data bits, 5|6|7|8>\n"
     179      "           serialParity             <Parity, NONE|ODD|EVEN|SPACE>\n"
     180      "           serialStopBits           <Stop bits, 1|2>\n"
     181      "           serialAutoNMEA           <NMEA, no|Auto|Manual GPGGA|Manual GNGGA>\n"
     182      "           serialFileNMEA           <NMEA filename>\n"
     183      "           serialHeightNMEA         <Height>\n"
     184      "           serialHeightNMEASampling <Sampling [sec]>\n"
    185185      "\n"
    186186      "Outages Panel keys:\n"
    187       "           --obsRate      <Observation rate, 0.1 Hz|0.2 Hz|0.5 Hz|1 Hz|5 Hz> \n"
    188       "           --adviseFail   <Failure threshold [min]>\n"
    189       "           --adviseReco   <Recovery threshold [min]>\n"
    190       "           --adviseScript <Script, full path>\n"
     187      "           obsRate      <Observation rate, 0.1 Hz|0.2 Hz|0.5 Hz|1 Hz|5 Hz> \n"
     188      "           adviseFail   <Failure threshold [min]>\n"
     189      "           adviseReco   <Recovery threshold [min]>\n"
     190      "           adviseScript <Script, full path>\n"
    191191      "\n"
    192192      "Miscellaneous Panel keys:\n"
    193       "           --miscMount <Mountpoint>\n"
    194       "           --perfIntr  <Log latency, interval>\n"
    195       "           --scanRTCM  <Scan for RTCM message numbers, 0=no, 2=yes>\n"
    196       "           --miscPort  <Port output>\n"
     193      "           miscMount <Mountpoint>\n"
     194      "           perfIntr  <Log latency, interval>\n"
     195      "           scanRTCM  <Scan for RTCM message numbers, 0=no, 2=yes>\n"
     196      "           miscPort  <Port output>\n"
    197197      "\n"
    198198      "PPP Client Panel 1 keys:\n"
    199       "           --dataSource  <Data source, Real-Time Streams| RINEX Files>\n"
    200       "           --rinexObs    <RINEX observation file>\n"
    201       "           --rinexNav    <RINEX navigation file>\n"
    202       "           --corrMount   <Corrections mountpoint>\n"
    203       "           --corrFile    <Corrections file>\n"
    204       "           --crdFile     <Coordinates file>\n"
    205       "           --logFilePPP  <PPP logfile>\n"
    206       "           --antexFile   <ANTEX file>\n"
    207       "           --nmeaFile    <NMEA output file>\n"
    208       "           --snxtroFile  <SINEX troposphere output filename>\n"
    209       "           --snxtroSampl <SINEX troposphere sampling rate [sec]>\n"
     199      "           dataSource  <Data source, Real-Time Streams| RINEX Files>\n"
     200      "           rinexObs    <RINEX observation file>\n"
     201      "           rinexNav    <RINEX navigation file>\n"
     202      "           corrMount   <Corrections mountpoint>\n"
     203      "           corrFile    <Corrections file>\n"
     204      "           crdFile     <Coordinates file>\n"
     205      "           logFilePPP  <PPP logfile>\n"
     206      "           antexFile   <ANTEX file>\n"
     207      "           nmeaFile    <NMEA output file>\n"
     208      "           snxtroFile  <SINEX troposphere output filename>\n"
     209      "           snxtroSampl <SINEX troposphere sampling rate [sec]>\n"
    210210      "\n"
    211211      "PPP Client Panel 2 keys:\n"
    212       "           --staTable <Stations table>\n"
     212      "           staTable <Stations table>\n"
    213213      "\n"
    214214      "PPP Client Panel 3 keys:\n"
    215       "           --lcGPS        <Select linear combination from GPS code or phase data>\n"
    216       "           --lcGLONASS    <Select linear combination from GLONASS code or phase data>\n"
    217       "           --lcGalileo    <Select linear combination from Galileo code or phase data>\n"
    218       "           --lcBDS        <Select linear combination from BDS code or phase data>\n"
    219       "           --sigmaC1      <Sigma for code observations [m]>\n"
    220       "           --sigmaL1      <Sigma for phase observations [m]>\n"
    221       "           --maxResC1     <Maximal residuum for code observations [m]>\n"
    222       "           --maxResL1     <Maximal residuum for phase observations [m]>\n"
    223       "           --eleWgtCode   <Elevation dependent waiting of code observations, 0=no, 2=yes>\n"
    224       "           --eleWgtPhase  <Elevation dependent waiting of phase observations, 0=no, 2=yes>\n"
    225       "           --minObs       <Minimum number of observations>\n"
    226       "           --minEle       <Minimum elevation [deg]>\n"
    227       "           --corrWaitTime <Wait for clock corrections [sec]>\n"
    228       "           --seedingTime  <Seeding time span for Quick Start [sec]>\n"
     215      "           lcGPS        <Select linear combination from GPS code or phase data>\n"
     216      "           lcGLONASS    <Select linear combination from GLONASS code or phase data>\n"
     217      "           lcGalileo    <Select linear combination from Galileo code or phase data>\n"
     218      "           lcBDS        <Select linear combination from BDS code or phase data>\n"
     219      "           sigmaC1      <Sigma for code observations [m]>\n"
     220      "           sigmaL1      <Sigma for phase observations [m]>\n"
     221      "           maxResC1     <Maximal residuum for code observations [m]>\n"
     222      "           maxResL1     <Maximal residuum for phase observations [m]>\n"
     223      "           eleWgtCode   <Elevation dependent waiting of code observations, 0=no, 2=yes>\n"
     224      "           eleWgtPhase  <Elevation dependent waiting of phase observations, 0=no, 2=yes>\n"
     225      "           minObs       <Minimum number of observations>\n"
     226      "           minEle       <Minimum elevation [deg]>\n"
     227      "           corrWaitTime <Wait for clock corrections [sec]>\n"
     228      "           seedingTime  <Seeding time span for Quick Start [sec]>\n"
    229229      "\n"
    230230      "PPP Client Panel 4 keys:\n"
    231       "           --plotCoordinates  <Mountpoint for time series plot>\n"
    232       "           --audioResponse    <Audio response threshold [m]>\n"
    233       "           --useOpenStreetMap <OSM track map, true|false>\n"
    234       "           --useGoogleMap     <Google track map, true|false>\n"
    235       "           --mapWinDotSize    <Size of dots on map>\n"
    236       "           --mapWinDotColor   <Color of dots and cross hair on map, red|yellow>\n"
    237       "           --mapSpeedSlider   <Offline processing speed for mapping, 1-100>\n"
     231      "           plotCoordinates  <Mountpoint for time series plot>\n"
     232      "           audioResponse    <Audio response threshold [m]>\n"
     233      "           useOpenStreetMap <OSM track map, true|false>\n"
     234      "           useGoogleMap     <Google track map, true|false>\n"
     235      "           mapWinDotSize    <Size of dots on map>\n"
     236      "           mapWinDotColor   <Color of dots and cross hair on map, red|yellow>\n"
     237      "           mapSpeedSlider   <Offline processing speed for mapping, 1-100>\n"
    238238      "\n"
    239239      "Combine Corrections Panel keys:\n"
    240       "           --combineStreams  <Table of correction streams\n"
    241       "           --cmbMethodFilter <Approach, Single-Epoch|Filter\n"
    242       "           --cmbMaxres       <Clock outlier threshold [m]\n"
    243       "           --cmbSampl        <Orbit and clock sampling [m]\n"
    244       "           --cmbUseGlonass   <Use GLONASS in combination, 0=no, 2=yes\n"
     240      "           combineStreams  <Table of correction streams\n"
     241      "           cmbMethodFilter <Approach, Single-Epoch|Filter\n"
     242      "           cmbMaxres       <Clock outlier threshold [m]\n"
     243      "           cmbSampl        <Orbit and clock sampling [m]\n"
     244      "           cmbUseGlonass   <Use GLONASS in combination, 0=no, 2=yes\n"
    245245      "\n"
    246246      "Upload Corrections Panel keys:\n"
    247       "           --uploadMountpointsOut   <Upload corrections table>\n"
    248       "           --uploadIntr             <File interval, length of SP3 and Clock RINEX files>\n"
    249       "           --uploadSamplRtcmEphCorr <Orbit corrections sampling interval [sec]>\n"
    250       "           --uploadSamplSp3         <SP3 file sampling [min]>\n"
    251       "           --uploadSamplClkRnx      <Clock RINEX file sampling [sec]>\n"
     247      "           uploadMountpointsOut   <Upload corrections table>\n"
     248      "           uploadIntr             <File interval, length of SP3 and Clock RINEX files>\n"
     249      "           uploadSamplRtcmEphCorr <Orbit corrections sampling interval [sec]>\n"
     250      "           uploadSamplSp3         <SP3 file sampling [min]>\n"
     251      "           uploadSamplClkRnx      <Clock RINEX file sampling [sec]>\n"
    252252      "\n"
    253253      "Custom Trafo keys:\n"
    254       "           --trafo_dx  <Translation X [m]>\n"
    255       "           --trafo_dy  <Translation Y [m]>\n"
    256       "           --trafo_dz  <Translation Z [m]>\n"
    257       "           --trafo_dxr <Translation change X [m/y]>\n"
    258       "           --trafo_dyr <Translation change Y [m/y]>\n"
    259       "           --trafo_dzr <Translation change Z [m/y]>\n"
    260       "           --trafo_ox  <Rotation X [as]>\n"
    261       "           --trafo_oy  <Rotation Y [as]>\n"
    262       "           --trafo_oz  <Rotation Z [as]>\n"
    263       "           --trafo_oxr <Rotation change X [as/y]>\n"
    264       "           --trafo_oyr <Rotation change Y [as/y]>\n"
    265       "           --trafo_ozr <Rotation change Z [as/y]>\n"
    266       "           --trafo_sc  <Scale [10^-9]>\n"
    267       "           --trafo_scr <Scale change [10^-9/y]>\n"
    268       "           --trafo_t0  <Reference year [y]>\n"
     254      "           trafo_dx  <Translation X [m]>\n"
     255      "           trafo_dy  <Translation Y [m]>\n"
     256      "           trafo_dz  <Translation Z [m]>\n"
     257      "           trafo_dxr <Translation change X [m/y]>\n"
     258      "           trafo_dyr <Translation change Y [m/y]>\n"
     259      "           trafo_dzr <Translation change Z [m/y]>\n"
     260      "           trafo_ox  <Rotation X [as]>\n"
     261      "           trafo_oy  <Rotation Y [as]>\n"
     262      "           trafo_oz  <Rotation Z [as]>\n"
     263      "           trafo_oxr <Rotation change X [as/y]>\n"
     264      "           trafo_oyr <Rotation change Y [as/y]>\n"
     265      "           trafo_ozr <Rotation change Z [as/y]>\n"
     266      "           trafo_sc  <Scale [10^-9]>\n"
     267      "           trafo_scr <Scale change [10^-9/y]>\n"
     268      "           trafo_t0  <Reference year [y]>\n"
    269269      "\n"
    270270      "Upload Ephemeris Panel keys:\n"
    271       "           --uploadEphHost       <Host>\n"
    272       "           --uploadEphPort       <Port>\n"
    273       "           --uploadEphMountpoint <Mountpoint>\n"
    274       "           --uploadEphPassword   <Password>\n"
    275       "           --uploadEphSample     <Sampling interval [sec]>\n"
     271      "           uploadEphHost       <Host>\n"
     272      "           uploadEphPort       <Port>\n"
     273      "           uploadEphMountpoint <Mountpoint>\n"
     274      "           uploadEphPassword   <Password>\n"
     275      "           uploadEphSample     <Sampling interval [sec]>\n"
    276276      "\n"
    277277      "Add Stream keys:\n"
    278       "           --mountPoints  <Mountpoint list>\n"
    279       "           --ntripVersion <Ntrip Version, 1|2|2s|R|U>\n"
    280       "           --casterUrlList <Visited URLs>\n";
     278      "           mountPoints  <Mountpoint list>\n"
     279      "           ntripVersion <Ntrip Version, 1|2|2s|R|U>\n"
     280      "           casterUrlList <Visited URLs>\n"
     281      "\n"
     282      "Example:\n"
     283      "bnc --conf BNC.bnc --key startTab 4 --key reqcAction Edit/Concatenate"
     284      " --key reqcObsFile AGAR.15O --key reqcOutObsFile AGAR_X.15O"
     285      " --key reqcRnxVersion 2 --key reqcSampling 30 --key reqcV2Priority CWPX_?\n";
    281286
    282287  for (int ii = 1; ii < argc; ii++) {
Note: See TracChangeset for help on using the changeset viewer.