mirrors/gnss-sdr
1
0
Fork 0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2025-10-21 18:47:41 +00:00
Code Issues Releases Wiki Activity

Improving manpages and package description

Browse Source
This commit is contained in:
Carles Fernandez
2014-11-15 20:40:58 +01:00
parent dfa4af8709
commit cdf14df239
3 changed files with 45 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/manpage/gnss-sdr-manpage
View File

@@ -2,28 +2,35 @@
.\" Contact carles.fernandez@cttc.es to correct errors or typos.
.TH gnss-sdr 1 "14 Nov 2014" "0.0.5" "gnss-sdr man page"
.SH NAME
\fBgnss-sdr\fR \- GNSS Software Defined Receiver
\fBgnss-sdr\fR \- GNSS Software Defined Receiver.
.SH SYNOPSIS
\fBgnss-sdr -config_file=\fR<path-to-configuration-file>
\fBgnss-sdr -config_file=\fR\fI<path-to-configuration-file>\fR [OPTION]...
.SH DESCRIPTION
.PP
\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 observables. It is able to work with raw data files or, if there is computational power enough, in real time with suitable radiofrequency front-ends.
.Pp
\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 observables.
\.TP
\fBgnss-sdr\fR is able to work with raw data files or, if there is computational power enough, in real time with suitable radiofrequency front-ends. The whole receiver is defined in a single configuration file, and therefore users can define theirs.
.SH OPTIONS
\fBgnss-sdr\fR takes the following options:
.TP
\fB-config_file=\fR<path-to-configuration-file> Set the configuration file.
\fB-config_file=\fR\fI<path-to-configuration-file>\fR Set the configuration file.
.TP
\fB-signal_source=\fR<path-to-raw-signal-file> If defined, path to the file containing the signal samples (overrides the data file specified in the configuration file).
\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
\fB-RINEX_version=\fR<version> 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
\fB-version\fR Prints program version
\fB-version\fR Print program version and exit.
.TP
\fB-help\fR Prints all the available commandline flags
\fB-help\fR Print all the available commandline flags and exit.
.SH SEE ALSO
.BR volk_gnsssdr_profile (1),
check http://gnss-sdr.org for more information.
.BR volk_gnsssdr_profile (1)
\.TP
Examples of configuration files available at: ${prefix}/share/gnss-sdr/conf, where ${prefix}$ uses to be /usr or /usr/local.
\.TP
Check http://gnss-sdr.org for more information.
.SH BUGS
No known bugs.
.SH AUTHOR
Carles Fernandez-Prades (carles.fernandez@cttc.es)
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.