sigrok-fwextract-saleae-logic16: Add manpage.
authorUwe Hermann <uwe@hermann-uwe.de>
Mon, 5 Aug 2013 13:11:21 +0000 (15:11 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Mon, 5 Aug 2013 13:23:28 +0000 (15:23 +0200)
firmware/saleae-logic16/README.sigrok-fwextract-saleae-logic16 [deleted file]
firmware/saleae-logic16/sigrok-fwextract-saleae-logic16.1 [new file with mode: 0644]

diff --git a/firmware/saleae-logic16/README.sigrok-fwextract-saleae-logic16 b/firmware/saleae-logic16/README.sigrok-fwextract-saleae-logic16
deleted file mode 100644 (file)
index 4f7fb3b..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-This tool extracts FPGA bitstreams from the
-vendor software for the Saleae Logic16 USB logic analyzer. Download
-the Linux version (either 32-bit or 64-bit will do), and unpack it
-to find the main binary called "Logic".
-
-Usage:
-
-$ ./sigrok-fwextract-saleae-logic16 Logic
-saved 149516 bytes to saleae-logic16-fpga-18.bitstream
-saved 149516 bytes to saleae-logic16-fpga-33.bitstream
-
-Copy the resulting files over to the location where sigrok installed its
-firmware files. By default this is /usr/local/share/sigrok-firmware.
diff --git a/firmware/saleae-logic16/sigrok-fwextract-saleae-logic16.1 b/firmware/saleae-logic16/sigrok-fwextract-saleae-logic16.1
new file mode 100644 (file)
index 0000000..54ea43a
--- /dev/null
@@ -0,0 +1,37 @@
+.TH SIGROK\-FWEXTRACT\-SALEAE\-LOGIC16 1 "Aug 08, 2013"
+.SH "NAME"
+sigrok\-fwextract\-saleae\-logic16 \- Extract Saleae Logic16 firmware
+.SH "SYNOPSIS"
+.B sigrok\-fwextract\-saleae\-logic16 [FILE]
+.SH "DESCRIPTION"
+This tool extracts FPGA bitstreams from the vendor software for the
+Saleae Logic16 USB logic analyzer. Download the Linux version (either 32-bit
+or 64-bit will do), and unpack it to find the main binary called "Logic".
+.PP
+In order to extract the firmware/bitstreams, run the following command:
+.PP
+.B "  $ sigrok-fwextract-saleae-logic16 Logic"
+.br
+.RB "  saved 149516 bytes to saleae-logic16-fpga-18.bitstream"
+.br
+.RB "  saved 149516 bytes to saleae-logic16-fpga-33.bitstream"
+.PP
+Copy the resulting files over to the location where libsigrok expects
+to find its firmware files. By default this is
+.BR /usr/local/share/sigrok-firmware .
+.SH OPTIONS
+None.
+.SH "EXIT STATUS"
+Exits with 0 on success, 1 on most failures.
+.SH "SEE ALSO"
+\fBsigrok\-fwextract\-hantek\-dso\fP(1)
+.SH "BUGS"
+Please report any bugs via Bugzilla
+.RB "(" http://sigrok.org/bugzilla ")"
+or on the sigrok\-devel mailing list
+.RB "(" sigrok\-devel@lists.souceforge.net ")."
+.SH "LICENSE"
+This program is covered by the GNU General Public License (GPL),
+version 3 or later.
+.SH "AUTHORS"
+Please see the individual source code files.