[hamradio-commits] [soapysdr] 01/04: Add man page for SoapySDRUtil

[Andreas E. Bombe]

This is an automated email from the git hooks/post-receive script.

aeb pushed a commit to branch master
in repository soapysdr.

commit d658c55c87cec37cd242ecc71664d0db6b517482
Author: Andreas Bombe <aeb at debian.org>
Date:   Sat Nov 19 22:30:36 2016 +0100

    Add man page for SoapySDRUtil
---
 debian/SoapySDRUtil.1          | 54 ++++++++++++++++++++++++++++++++++++++++++
 debian/changelog               |  1 +
 debian/soapysdr-tools.manpages |  1 +
 3 files changed, 56 insertions(+)

diff --git a/debian/SoapySDRUtil.1 b/debian/SoapySDRUtil.1
new file mode 100644
index 0000000..8f79cf0
--- /dev/null
+++ b/debian/SoapySDRUtil.1
@@ -0,0 +1,54 @@
+.\" SoapySDRUtil.1 - manpage for SoapySDRUtil
+.\"
+.\"
+.TH SOAPYSDRUTIL 1 2016\-10\-28 "SoapySDR 0.5.3"
+.SH NAME
+\fBSoapySDRUtil\fR \- query and change module information of SoapySDR
+.\" ----------------------------------------------------------------------------
+.SH SYNOPSIS
+\fBSoapySDRUtil\fR [\fIOPTIONS\fR]
+.\" ----------------------------------------------------------------------------
+.SH DESCRIPTION
+SoapySDRUtil is a command line application that provides basic
+diagnostic utility for SoapySDR by printing installation information,
+available modules, discovered devices, and tests on instantiated devices.
+.\" ----------------------------------------------------------------------------
+.SH OPTIONS
+.TP
+\fB\-\-info\fR
+Print general information on the library, list all found hardware support
+modules and available factories.
+.TP
+\fB\-\-find\fR[="\fISPEC\fR"]
+Discover available devices, restricted to those matching the \fISPEC\fR if
+given.
+If no matching devices are found it will exit with exit status 1.
+.TP
+\fB\-\-make\fR[="\fISPEC\fR"]
+Open and close device matching \fISPEC\fR if possible.
+If \fISPEC\fR is not given, the first discovered device is opened.
+.TP
+\fB\-\-probe\fR[="\fISPEC\fR"]
+Show detailed information on all devices or the devices matching \fISPEC\fR if
+given.
+.TP
+\fB\-\-check\fR=\fINAME\fR
+Check and print if driver module named \fINAME\fR is present.
+If it is not found it will exit with exit status 1.
+.\" ----------------------------------------------------------------------------
+.SH HOMEPAGE
+SoapySDRUtil is part of the
+.UR https://github.com/pothosware/SoapySDR/wiki
+SoapySDR project
+.UE .
+.\" ----------------------------------------------------------------------------
+.SH AUTHORS
+The SoapySDR library, including SoapySDRUtil, was written mostly by
+.MT josh at pothosware.com
+Josh Blum
+.ME .
+.\"
+.\"This man page was originally written for the Debian project by
+.\".MT aeb at debian.org
+.\"Andreas Bombe
+.\".ME .
diff --git a/debian/changelog b/debian/changelog
index 111f04b..fe12e16 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,5 +1,6 @@
 soapysdr (0.5.3-2) UNRELEASED; urgency=medium
 
+  * Add man page for SoapySDRUtil
   * Add hackrf, remote and uhd dependencies to soapysdr0.5-2-module-all
   * Add appropriate Multi-Arch headers to libsoapysdr-dev, libsoapysdr-doc,
     soapysdr0.5-2-module-all, soapysdr-module-all
diff --git a/debian/soapysdr-tools.manpages b/debian/soapysdr-tools.manpages
new file mode 100644
index 0000000..275e5b4
--- /dev/null
+++ b/debian/soapysdr-tools.manpages
@@ -0,0 +1 @@
+debian/SoapySDRUtil.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/soapysdr.git