1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2025-02-14 10:00:11 +00:00

Creating volk_gnsssdr_profile manpage

This commit is contained in:
Carles Fernandez 2014-11-14 19:20:33 +01:00
parent ba896d1e83
commit 5738502fb1
3 changed files with 23 additions and 9 deletions

View File

@ -63,7 +63,7 @@ FILE(COPY ${CMAKE_CURRENT_BINARY_DIR}/scripts/prerm DESTINATION ${CMAKE_CURRENT_
# Setup CPack
########################################################################
set(CPACK_PACKAGE_DESCRIPTION "GNSS Software Defined Receiver")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Global Navigation Satellite System Software Defined Receiver written in C++." )
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Global Navigation Satellite Systems Software Defined Receiver written in C++." )
set(CPACK_PACKAGE_VENDOR "Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)")
set(CPACK_PACKAGE_NAME "gnss-sdr")
set(CPACK_PACKAGE_VERSION "${VERSION}")
@ -305,6 +305,11 @@ License: GPL-3+
WORKING_DIRECTORY ${CMAKE_BINARY_DIR} OUTPUT_FILE "${CMAKE_BINARY_DIR}/gnss-sdr.1.gz")
install(FILES ${CMAKE_BINARY_DIR}/gnss-sdr.1.gz DESTINATION share/man/man1)
execute_process(COMMAND gzip -9 -c ${CMAKE_CURRENT_SOURCE_DIR}/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/cmake/Packaging/volk_gnsssdr_profile
WORKING_DIRECTORY ${CMAKE_BINARY_DIR} OUTPUT_FILE "${CMAKE_BINARY_DIR}/volk_gnsssdr_profile.1.gz")
install(FILES ${CMAKE_BINARY_DIR}/volk_gnsssdr_profile.1.gz DESTINATION share/man/man1)
endif(CPACK_GENERATOR STREQUAL "DEB")
include(CPack)

View File

@ -2,20 +2,29 @@
.\" 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
gnss-sdr \- GNSS Software Defined Receiver
\fBgnss-sdr\fR \- GNSS Software Defined Receiver
.SH SYNOPSIS
gnss-sdr --config_file=/path/to/myconfiguration.conf
\fBgnss-sdr -config_file=\fR<path-to-configuration-file>
.SH DESCRIPTION
.PP
gnss-sdr is a 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
\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.
.SH OPTIONS
gnss-sdr takes the following options:
\fBgnss-sdr\fR takes the following options:
.TP
\FB--config_file\FR Set the configuration file
\fB-config_file=\fR<path-to-configuration-file> 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).
.TP
\fB-RINEX_version=\fR<version> Specifies the RINEX version (2.11 or 3.02). Default: "3.02".
.TP
\fB-version\fR Prints program version
.TP
\fB-help\fR Prints all the available commandline flags
.SH SEE ALSO
Check http://gnss-sdr.org for more information.
.BR volk_gnsssdr_profile (1),
check http://gnss-sdr.org for more information.
.SH BUGS
No known bugs.
.SH AUTHOR
Carles Fernandez (carles.fernandez@cttc.es)
Carles Fernandez-Prades (carles.fernandez@cttc.es)

View File

@ -5,6 +5,6 @@ rm @CMAKE_INSTALL_PREFIX@/@PROJECT_NAME@
rm @CMAKE_INSTALL_PREFIX@/volk_gnsssdr_profile
fi
if test -e @CMAKE_INSTALL_PREFIX@/share/@PROJECT_NAME@ ; then
rm @CMAKE_INSTALL_PREFIX@/share/@PROJECT_NAME@
rm -rf @CMAKE_INSTALL_PREFIX@/share/@PROJECT_NAME@
fi