aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/CMakeLists.txt4
-rw-r--r--host/docs/build.dox4
-rw-r--r--host/docs/uhd_config_info.164
3 files changed, 69 insertions, 3 deletions
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index 3090d3f80..ed462459c 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -63,7 +63,6 @@ ENDIF(ENABLE_MANUAL)
########################################################################
# Setup API documentation (using Doxygen)
########################################################################
-MESSAGE(STATUS "")
LIBUHD_REGISTER_COMPONENT("API/Doxygen" ENABLE_DOXYGEN ON "DOXYGEN_FOUND" OFF OFF)
OPTION(ENABLE_DOXYGEN_FULL "Use Doxygen to document the entire source tree (not just API)" OFF)
@@ -90,7 +89,6 @@ ENDIF(ENABLE_DOXYGEN)
########################################################################
# Run Doxygen (on code and/or manual, depending on CMake flags)
########################################################################
-MESSAGE(STATUS "")
IF(ENABLE_MANUAL_OR_DOXYGEN)
#generate the doxygen configuration file
SET(CMAKE_CURRENT_BINARY_DIR_DOXYGEN ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
@@ -121,6 +119,7 @@ SET(man_page_sources
uhd_cal_rx_iq_balance.1
uhd_cal_tx_dc_offset.1
uhd_cal_tx_iq_balance.1
+ uhd_config_info.1
uhd_find_devices.1
uhd_image_loader.1
uhd_images_downloader.1
@@ -133,7 +132,6 @@ SET(man_page_sources
########################################################################
# Setup man pages
########################################################################
-MESSAGE(STATUS "")
FIND_PACKAGE(GZip)
# No elegant way in CMake to reverse a boolean
diff --git a/host/docs/build.dox b/host/docs/build.dox
index 1390a8b6d..8caae5c79 100644
--- a/host/docs/build.dox
+++ b/host/docs/build.dox
@@ -99,6 +99,10 @@ You can install all the dependencies through the package manager:
sudo yum -y install boost-devel libusb1-devel python-mako doxygen python-docutils cmake make gcc gcc-c++
+or
+
+ sudo dnf -y install boost-devel libusb1-devel python-mako doxygen python-docutils cmake make gcc gcc-c++
+
Your actual command may differ.
\section build_get_source Getting the source code
diff --git a/host/docs/uhd_config_info.1 b/host/docs/uhd_config_info.1
new file mode 100644
index 000000000..edc1b7532
--- /dev/null
+++ b/host/docs/uhd_config_info.1
@@ -0,0 +1,64 @@
+.TH "uhd_find_devices" 1 "3.9.1" UHD "User Commands"
+.SH NAME
+uhd_config_info \- USRP Hardware Driver Build Configuration Info
+.SH DESCRIPTION
+Print build information corresponding to this installation of the USRP
+Hardware Driver (UHD).
+.LP
+The UHD package is the universal hardware driver for Ettus Research
+products. The goal is to provide a host driver and API for
+current and future Ettus Research products. Users will be able to use
+the UHD driver standalone or with 3rd party applications.
+
+.SH SYNOPSIS
+.B uhd_config_info [OPTIONS]
+
+.SH OPTIONS
+.IP "Print date this build was compiled:"
+--boost-version
+.IP "Print Boost version used:"
+--build-date
+.IP "Print C compiler used:"
+--c-compiler
+.IP "Print C++ compiler used:"
+--cxx-compiler
+.IP "Print C compile flags:"
+--c-flags
+.IP "Print C++ compile flags:"
+--cxx-flags
+.IP "Print UHD components included in this build (comma-delimited):"
+--enabled-components
+.IP "Print default install prefix for this build:"
+--install-prefix
+.IP "Print libusb version used"
+--libusb-version
+.IP "Print all information listed above:"
+--print-all
+.IP "Print UHD version:"
+--version
+.IP "This help information:"
+--help
+
+.SH SEE ALSO
+UHD documentation:
+.B http://files.ettus.com/manual/
+.LP
+GR-UHD documentation:
+.B http://gnuradio.org/doc/doxygen/page_uhd.html
+
+.SH AUTHOR
+This manual page was written by Nicholas Corgan
+for the Debian project (but may be used by others).
+
+.SH COPYRIGHT
+Copyright (c) 2015 National Instruments Corp.
+.LP
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+.LP
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.