[hamradio-commits] [limesuite] 09/12: Add newly written man pages for LimeUtil and LimeSuiteGUI

Wed Sep 20 02:08:07 UTC 2017

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

aeb pushed a commit to branch master
in repository limesuite.

commit 07dc4ec3efc018ba1d32e6a4a8327c90448bbd77
Author: Andreas Bombe <aeb at debian.org>
Date:   Mon Sep 18 21:41:27 2017 +0200

    Add newly written man pages for LimeUtil and LimeSuiteGUI
---
 debian/LimeSuiteGUI.1     | 37 ++++++++++++++++++++
 debian/LimeUtil.1         | 86 +++++++++++++++++++++++++++++++++++++++++++++++
 debian/changelog          |  1 +
 debian/limesuite.manpages |  2 ++
 4 files changed, 126 insertions(+)

diff --git a/debian/LimeSuiteGUI.1 b/debian/LimeSuiteGUI.1
new file mode 100644
index 0000000..f05b1ca
--- /dev/null
+++ b/debian/LimeSuiteGUI.1
@@ -0,0 +1,37 @@
+.\" LimeUtil.1 - manpage for LimeUtil
+.\"
+.\" Copyright 2017 Andreas Bombe
+.\"
+.\" Copying and distribution of this file, with or without modification,
+.\" are permitted in any medium without royalty provided the copyright
+.\" notice and this notice are preserved.  This file is offered as-is,
+.\" without any warranty.
+.\"
+.\" This man page was originally written for the Debian project
+.\" 
+.TH LIMESUITEGUI 1 2017\-09\-18 "Lime Suite" "User Commands"
+.SH NAME
+\fBLimeSuiteGUI\fR \- control and update LMS7 based transceiver devices
+.\" ----------------------------------------------------------------------------
+.SH SYNOPSIS
+\fBLimeSuiteGUI\fR
+.\" ----------------------------------------------------------------------------
+.SH DESCRIPTION
+\fBLimeSuiteGUI\fR is a graphical application to access LMS7 based transceiver
+devices such as the LimeSDR.
+It can be used to update the firmware, to configure and control the LMS7
+transceiver and support devices such as clock generators, to calibrate the
+device and to display received signals.
+.\" ----------------------------------------------------------------------------
+.SH OPTIONS
+\fBLimeSuiteGUI\fR has no command-line options and will ignore any options
+given.
+.\" ----------------------------------------------------------------------------
+.SH HOMEPAGE
+\fBLimeSuiteGUI\fR is part of the
+.UR https://myriadrf.org/projects/lime-suite/
+Lime Suite
+.UE .
+.\" ----------------------------------------------------------------------------
+.SH SEE ALSO
+.BR LimeUtil (1)
diff --git a/debian/LimeUtil.1 b/debian/LimeUtil.1
new file mode 100644
index 0000000..64b6d6f
--- /dev/null
+++ b/debian/LimeUtil.1
@@ -0,0 +1,86 @@
+.\" LimeUtil.1 - manpage for LimeUtil
+.\"
+.\" Copyright 2017 Andreas Bombe
+.\"
+.\" Copying and distribution of this file, with or without modification,
+.\" are permitted in any medium without royalty provided the copyright
+.\" notice and this notice are preserved.  This file is offered as-is,
+.\" without any warranty.
+.\"
+.\" This man page was originally written for the Debian project
+.\" 
+.TH LIMEUTIL 1 2017\-09\-18 "Lime Suite" "User Commands"
+.SH NAME
+\fBLimeUtil\fR \- control and update LMS7 based transceiver devices
+.\" ----------------------------------------------------------------------------
+.SH SYNOPSIS
+\fBLimeUtil\fR [\fIOPTIONS\fR]
+.\" ----------------------------------------------------------------------------
+.SH DESCRIPTION
+\fBLimeUtil\fR is a tool to show information about and control LMS7 based
+transceiver devices such as the LimeSDR.
+It can be used to update the firmware and to calibrate the device.
+.\" ----------------------------------------------------------------------------
+.SH OPTIONS
+.TP
+\fB\-\-help\fR
+Print a help message.
+.TP
+\fB\-\-info\fR
+Print information about LimeSuite and found devices.
+.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"]
+Create a device instance.
+.SS Advanced options
+.TP
+\fB\-\-args\fR[="\fIARGS\fR"]
+Supply arguments \fIARGS\fR to the \fB\-\-update\fR, \fB\-\-fpga\fR and
+\fB\-\-fw\fR options.
+.TP
+\fB\-\-update\fR
+Download latest firmware and program it into the device flash memory.
+.TP
+\fB\-\-fpga\fR="\fIFILE\fR"
+Program FPGA firmware image in \fIFILE\fR to device flash memory.
+.TP
+\fB\-\-fw\fR="\fIFILE\fR"
+Program FX3 firmware image in \fIFILE\fR to device flash memory.
+.TP
+\fB\-\-timing\fR
+Time interfaces and operations.
+.SS Calibrations sweep
+.TP
+\fB\-\-cal\fR[="\fIARGS\fR"]
+Calibrate device. Use \fIARGS\fR to select and configure device.
+.TP
+\fB\-\-start\fR=\fIFREQ\fR
+Start calibration sweep at frequency \fIFREQ\fR Hz.
+.TP
+\fB\-\-stop\fR=\fI\FREQ\fR
+Stop calibration sweep at frequency \fIFREQ\fR Hz.
+.TP
+\fB\-\-step\fR=\fISTEP\fR
+Step frequency during calibration sweep by \fISTEP\fR Hz (default 1 MHz).
+.TP
+\fB\-\-bw\fR=\fIBW\fR
+Set calibration bandwidth to \fIBW\fR Hz (default 30 MHz).
+.TP
+\fB\-\-dir\fR=\fIDIR\fR
+Set calibration direction to \fIDIR\fR (one of RX, TX or BOTH, default is BOTH).
+.TP
+\fB\-\-chans\fR=\fICHANNELS\fR
+Set calibration channels to \fICHANNELS\fR (one of 0, 1 or ALL, default is ALL).
+.\" ----------------------------------------------------------------------------
+.SH HOMEPAGE
+\fBLimeUtil\fR is part of the
+.UR https://myriadrf.org/projects/lime-suite/
+Lime Suite
+.UE .
+.\" ----------------------------------------------------------------------------
+.SH SEE ALSO
+.BR LimeSuiteGUI (1)
diff --git a/debian/changelog b/debian/changelog
index 9e0a42a..35ddb9a 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,6 +2,7 @@ limesuite (17.09.0+dfsg-1) UNRELEASED; urgency=medium
 
   * New upstream release 17.09.0
   * Change liblimesuite ABI version from 17.06-1 to 17.09-1
+  * Add newly written man pages for LimeUtil and LimeSuiteGUI
   * Also remove GROUP="660" assignment with udev-use-tag-uaccess patch
   * Disable auto detection of SIMD features during the configure step
   * Bump Standards-Version to 4.1.0, no changes required
diff --git a/debian/limesuite.manpages b/debian/limesuite.manpages
new file mode 100644
index 0000000..c4a7838
--- /dev/null
+++ b/debian/limesuite.manpages
@@ -0,0 +1,2 @@
+debian/LimeUtil.1
+debian/LimeSuiteGUI.1

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

