1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2024-09-29 07:20:51 +00:00

Update manpage

This commit is contained in:
Carles Fernandez 2018-02-24 19:34:46 +01:00
parent bd6d3fcb28
commit 12f61c6d19

View File

@ -1,10 +1,10 @@
.\" Manpage for gnss\-sdr. .\" Manpage for gnss\-sdr.
.\" Contact carles.fernandez@cttc.es to correct errors or typos. .\" Contact carles.fernandez@cttc.es to correct errors or typos.
.TH gnss\-sdr 1 "05 Feb 2017" "0.0.9" "gnss\-sdr man page" .TH gnss\-sdr 1 "24 Feb 2018" "0.0.9" "gnss\-sdr man page"
.SH NAME .SH NAME
\fBgnss\-sdr\fR \- GNSS Software Defined Receiver. \fBgnss\-sdr\fR \- GNSS Software Defined Receiver.
.SH SYNOPSIS .SH SYNOPSIS
\fBgnss\-sdr \-config_file=\fR\fI<path\-to\-configuration\-file>\fR [OPTION]... \fBgnss\-sdr \-c=\fR\fI<path\-to\-configuration\-file>\fR [OPTION]...
.SH DESCRIPTION .SH DESCRIPTION
\fBgnss\-sdr\fR is a Global Navigation Satellite Systems Software Defined Receiver written in C++. It implements all the signal processing chain, taking as input raw samples coming from the output of an Analog\-to\-Digital Converter, and processing them up to the computation of the Position\-Velocity\-Time solution, including the generation of code and phase measurements. \fBgnss\-sdr\fR is a Global Navigation Satellite Systems Software Defined Receiver written in C++. It implements all the signal processing chain, taking as input raw samples coming from the output of an Analog\-to\-Digital Converter, and processing them up to the computation of the Position\-Velocity\-Time solution, including the generation of code and phase measurements.
\.TP \.TP
@ -12,31 +12,44 @@
.SH OPTIONS .SH OPTIONS
\fBgnss\-sdr\fR takes the following options: \fBgnss\-sdr\fR takes the following options:
.TP .TP
\fB\-config_file=\fR\fI<path\-to\-configuration\-file>\fR Set the configuration file. \fB\-c=\fR\fI<path\-to\-configuration\-file>\fR or \fB\-config_file=\fR\fI<path\-to\-configuration\-file>\fR
Set the configuration file.
.TP .TP
\fB\-signal_source=\fR\fI<path\-to\-raw\-signal\-file>\fR If defined, path to the file containing the signal samples (overrides the data file specified in the configuration file). \fB\-s=\fR\fI<path\-to\-raw\-signal\-file>\fR or \fB\-signal_source=\fR\fI<path\-to\-raw\-signal\-file>\fR
If defined, path to the file containing the signal samples (overrides the data file specified in the configuration file).
.TP .TP
\fB\-log_dir=\fR\fI<path\-to\-directory>\fR If defined, overrides the default directory where logs are saved. \fB\-log_dir=\fR\fI<path\-to\-directory>\fR
If defined, overrides the default directory where logs are saved.
.TP .TP
\fB\-doppler_max=\fR\fIdoppler\fR If defined, maximum Doppler value in the search grid, in Hz (overrides the configuration file), \fB\-doppler_max=\fR\fIdoppler\fR
If defined, maximum Doppler value in the search grid, in Hz (overrides the configuration file).
.TP .TP
\fB\-cn0_samples=\fR\fIsamples\fR Number of correlator outputs used for CN0 estimation. \fB\-cn0_samples=\fR\fIsamples\fR
Number of correlator outputs used for CN0 estimation.
.TP .TP
\fB\-cn0_min=\fR\fIcn0_min\fR Minimum valid CN0 (in dB-Hz). \fB\-cn0_min=\fR\fIcn0_min\fR
Minimum valid CN0 (in dB-Hz).
.TP .TP
\fB\-max_lock_fail=\fR\fImax_lock_fail\fR Number number of lock failures before dropping satellite. \fB\-max_lock_fail=\fR\fImax_lock_fail\fR
Number number of lock failures before dropping satellite.
.TP .TP
\fB\-carrier_lock_th=\fR\fIcarrier_lock_th\fR Carrier lock threshold (in rad). \fB\-carrier_lock_th=\fR\fIcarrier_lock_th\fR
Carrier lock threshold (in rad).
.TP .TP
\fB\-dll_bw_hz=\fR\fIdll_bw_hz\fR If defined, bandwidth of the DLL low pass filter, in Hz (overrides the configuration file). \fB\-dll_bw_hz=\fR\fIdll_bw_hz\fR
If defined, bandwidth of the DLL low pass filter, in Hz (overrides the configuration file).
.TP .TP
\fB\-pll_bw_hz=\fR\fIpll_bw_hz\fR If defined, bandwidth of the PLL low pass filter, in Hz (overrides the configuration file). \fB\-pll_bw_hz=\fR\fIpll_bw_hz\fR
If defined, bandwidth of the PLL low pass filter, in Hz (overrides the configuration file).
.TP .TP
\fB\-RINEX_version=\fI<version>\fR Specifies the RINEX version (2.11 or 3.02). Default: "3.02". \fB\-RINEX_version=\fI<version>\fR
Specifies the RINEX version (2.11 or 3.02). Default: "3.02".
.TP .TP
\fB\-version\fR Print program version and exit. \fB\-version\fR
Print program version and exit.
.TP .TP
\fB\-help\fR Print all the available commandline flags and exit. \fB\-help\fR
Print all the available commandline flags and exit.
.SH SEE ALSO .SH SEE ALSO
.BR volk_gnsssdr_profile (1) .BR volk_gnsssdr_profile (1)
\.TP \.TP