1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2025-01-26 00:46:59 +00:00

Adding man page for gnss-sdr

This commit is contained in:
Carles Fernandez 2014-11-14 15:01:57 +01:00
parent 82b72f9a28
commit ba896d1e83
2 changed files with 26 additions and 0 deletions

View File

@ -300,6 +300,11 @@ License: GPL-3+
WORKING_DIRECTORY ${CMAKE_BINARY_DIR} OUTPUT_FILE "${CMAKE_BINARY_DIR}/changelog.Debian.gz")
install(FILES "${CMAKE_BINARY_DIR}/changelog.gz" "${CMAKE_BINARY_DIR}/changelog.Debian.gz" DESTINATION "share/doc/${CPACK_PACKAGE_NAME}")
execute_process(COMMAND gzip -9 -c ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Packaging/gnss-sdr-manpage
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)
endif(CPACK_GENERATOR STREQUAL "DEB")
include(CPack)

View File

@ -0,0 +1,21 @@
.\" Manpage for gnss-sdr.
.\" 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
.SH SYNOPSIS
gnss-sdr --config_file=/path/to/myconfiguration.conf
.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
.SH OPTIONS
gnss-sdr takes the following options:
.TP
\FB--config_file\FR Set the configuration file
.SH SEE ALSO
Check http://gnss-sdr.org for more information.
.SH BUGS
No known bugs.
.SH AUTHOR
Carles Fernandez (carles.fernandez@cttc.es)