mirrors/gnss-sdr
1
0
Fork 0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2024-09-27 22:58:24 +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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
cmake/Modules/GnssSdrPackaging.cmake
View File

@ -83,8 +83,18 @@ set(CPACK_DEBIAN_PACKAGE_SECTION "science")
set(CPACK_DEBIAN_PACKAGE_PRIORITY "optional")
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libboost-dev (>= 1.45), libstdc++6 (>= 4.7), libc6 (>= 2.13), gnuradio (>= 3.7), libarmadillo-dev (>= 1:4.200.0), liblapack-dev (>= 3.4), libopenblas-dev (>= 0.1.1), gfortran (>= 1:4.7), libssl-dev (>= 1.0), libgflags-dev (>= 2.0)")
set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "GNSS Software Defined Receiver written in C++.
It processes raw samples up to the computation of the PVT solution,
including code and phase observables. More info at http://gnss-sdr.org")
Global Navigation Satellite Systems receiver defined by software.
It performs all the signal processing from raw signal samples up to the
computation of the Position-Velocity-Time solution, including
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. This software is mainly developed at CTTC
(Centre Tecnologic de Telecomunicacions de Catalunya, http://www.cttc.es)
with contributions from around the world.
More info at http://gnss-sdr.org")
o 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.
set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_BINARY_DIR}/postinst;${CMAKE_CURRENT_BINARY_DIR}/prerm")

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.

23
src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/cmake/Packaging/volk_gnsssdr_profile-manpage
View File

@ -2,9 +2,9 @@
.\" Contact carles.fernandez@cttc.es to correct errors or typos.
.TH volk_gnsssdr_profile 1 "14 Nov 2014" "0.0.5" "volk_gnsssdr_profile man page"
.SH NAME
\fBvolk_gnsssdr_profile\fR \- Profiler application for libvolk_gnsssdr functions
\fBvolk_gnsssdr_profile\fR \- Profiler application for libvolk_gnsssdr functions.
.SH SYNOPSIS
\fBvolk_gnsssdr_profile\fR
\fBvolk_gnsssdr_profile\fR [OPTION]
.SH DESCRIPTION
.PP
The Vector-Optimized Library of Kernels of GNSS-SDR (VOLK_GNSSSDR) is a software library that provides developers with an interface to use Single Input - Multiple Data (SIMD) instructions, which are of special interest for operations that are in the receiver's critical path of the processing load.
@ -15,17 +15,22 @@ Processors providing SIMD instruction sets compute with multiple processing elem
.SH OPTIONS
\fBvolk_gnsssdr_profile\fR takes the following options:
.TP
\fB-h\fR [ \fB--help\fR Print help message.
\fB-h\fR [ \fB--help\fR ] Print help message.
.TP
\fB-b\fR [ \fB--benchmark\fR ] [ \fB=arg(=1)\fR ] (\fB=0\fR) Run all kernels (benchmark mode)
\fB-b\fR [ \fB--benchmark\fR ] [ \fB=arg(=1)\fR ] (\fB=0\fR) Run all kernels (benchmark mode).
.TP
\fB-R\fR [ \fB--tests-regex\fR ] <arg> Run tests matching regular expression.
\fB-R\fR [ \fB--tests-regex\fR ] <arg> Run tests matching regular expression.
.TP
\fB-j\fR [ \fB--json\fR ] <arg> JSON output file
\fB-j\fR [ \fB--json\fR ] \fI<arg>\fR JSON output file.
.SH SEE ALSO
.BR gnss-sdr (1),
check http://gnss-sdr.org for more information.
.BR gnss-sdr (1)
\.TP
Check http://gnss-sdr.org for more information.
.SH HISTORY
This library was originally developed by Andres Cecilia Luque in the framework of the Summer of Code in Space program (SOCIS 2014) by the European Space Agency (ESA), and then integrated into \fBgnss-sdr\fR.
.SH BUGS
No known bugs.
.SH AUTHOR
Andres Cecilia Luque (a.cecilia.luque@gmail.com) and Carles Fernandez-Prades (carles.fernandez@cttc.es)
Andres Cecilia Luque (a.cecilia.luque@gmail.com)
\.TP
Carles Fernandez-Prades (carles.fernandez@cttc.es)