1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2024-07-07 20:24:21 +00:00
gnss-sdr/docs/manpage/gnss-sdr-manpage

64 lines
2.9 KiB
Plaintext
Raw Normal View History

2015-02-17 01:34:14 +00:00
.\" Manpage for gnss\-sdr.
2014-11-14 14:01:57 +00:00
.\" Contact carles.fernandez@cttc.es to correct errors or typos.
2018-02-24 18:34:46 +00:00
.TH gnss\-sdr 1 "24 Feb 2018" "0.0.9" "gnss\-sdr man page"
2014-11-14 14:01:57 +00:00
.SH NAME
2015-02-17 01:34:14 +00:00
\fBgnss\-sdr\fR \- GNSS Software Defined Receiver.
2014-11-14 14:01:57 +00:00
.SH SYNOPSIS
2018-02-24 18:34:46 +00:00
\fBgnss\-sdr \-c=\fR\fI<path\-to\-configuration\-file>\fR [OPTION]...
2014-11-14 14:01:57 +00:00
.SH DESCRIPTION
2015-02-17 01:34:14 +00:00
\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
2015-02-17 01:34:14 +00:00
\fBgnss\-sdr\fR is able to work with raw data files or, if there is computational power enough, in real time with suitable radio frequency front\-ends. The whole receiver is defined in a single configuration file, and therefore users can define theirs.
2014-11-14 14:01:57 +00:00
.SH OPTIONS
2015-02-17 01:34:14 +00:00
\fBgnss\-sdr\fR takes the following options:
2014-11-14 14:01:57 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-c=\fR\fI<path\-to\-configuration\-file>\fR or \fB\-config_file=\fR\fI<path\-to\-configuration\-file>\fR
Set the configuration file.
2014-11-14 18:20:33 +00:00
.TP
2018-02-24 18:34:46 +00:00
\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
2018-02-24 18:34:46 +00:00
\fB\-log_dir=\fR\fI<path\-to\-directory>\fR
If defined, overrides the default directory where logs are saved.
2014-11-14 18:20:33 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-doppler_max=\fR\fIdoppler\fR
If defined, maximum Doppler value in the search grid, in Hz (overrides the configuration file).
2018-02-18 18:47:09 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-cn0_samples=\fR\fIsamples\fR
Number of correlator outputs used for CN0 estimation.
2018-02-18 18:47:09 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-cn0_min=\fR\fIcn0_min\fR
Minimum valid CN0 (in dB-Hz).
2018-02-18 18:47:09 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-max_lock_fail=\fR\fImax_lock_fail\fR
Number number of lock failures before dropping satellite.
2018-02-18 18:47:09 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-carrier_lock_th=\fR\fIcarrier_lock_th\fR
Carrier lock threshold (in rad).
2018-02-18 18:47:09 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-dll_bw_hz=\fR\fIdll_bw_hz\fR
If defined, bandwidth of the DLL low pass filter, in Hz (overrides the configuration file).
2018-02-18 18:47:09 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-pll_bw_hz=\fR\fIpll_bw_hz\fR
If defined, bandwidth of the PLL low pass filter, in Hz (overrides the configuration file).
2018-02-18 18:47:09 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-RINEX_version=\fI<version>\fR
Specifies the RINEX version (2.11 or 3.02). Default: "3.02".
2014-11-14 18:20:33 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-version\fR
Print program version and exit.
2014-11-14 18:20:33 +00:00
.TP
2018-02-24 18:34:46 +00:00
\fB\-help\fR
Print all the available commandline flags and exit.
2014-11-14 14:01:57 +00:00
.SH SEE ALSO
.BR volk_gnsssdr_profile (1)
\.TP
2015-02-17 01:34:14 +00:00
Examples of configuration files available at: ${prefix}/share/gnss\-sdr/conf, where ${prefix} uses to be /usr or /usr/local.
\.TP
2015-02-17 01:34:14 +00:00
Check http://gnss\-sdr.org for more information.
2014-11-14 14:01:57 +00:00
.SH BUGS
2015-09-01 22:38:46 +00:00
Please report bugs at https://github.com/gnss-sdr/gnss-sdr/issues
2014-11-14 14:01:57 +00:00
.SH AUTHOR
2015-02-17 01:34:14 +00:00
Carles Fernandez\-Prades (carles.fernandez@cttc.es)
\.TP
This software package has been developed at CTTC (Centre Tecnologic de Telecomunicacions de Catalunya, http://www.cttc.es) with contributions from around the world.