Add sigrok-fwextract-dreamsourcelab-dslogic script and manpage.
[sigrok-util.git] / firmware / dreamsourcelab-dslogic / sigrok-fwextract-dreamsourcelab-dslogic.1
1 .TH SIGROK\-FWEXTRACT\-DREAMSOURCELAB\-DSLOGIC 1 "Nov 02, 2016"
2 .SH "NAME"
3 sigrok\-fwextract\-dreamsourcelab\-dslogic \- Extract DreamSourceLab DSLogic / DSLogic Pro / DScope firmware
4 .SH "SYNOPSIS"
5 .B [PREFIX=...] sigrok\-fwextract\-dreamsourcelab\-dslogic
6 .SH "DESCRIPTION"
7 This tool downloads the vendor FX2 firmware and FPGA bitstreams
8 for the DreamSourceLab DSLogic / DSLogic Pro / DScope devices from the
9 vendor's GitHub repository and installs them in the specified location.
10 .PP
11 In order to download/install the firmware/bitstreams, run the following command:
12 .PP
13 .B "  $ sudo sigrok-fwextract-dreamsourcelab-dslogic"
14 .br
15 .RB "  Installing into: /usr/local/share/sigrok-firmware"
16 .br
17 .PP
18 This will download and install the files to the location where libsigrok
19 expects to find its firmware files. By default this is
20 .BR /usr/local/share/sigrok-firmware .
21 .PP
22 You can override the
23 .B PREFIX
24 variable to install the files elsewhere:
25 .PP
26 .B "  $ PREFIX=$HOME/sr sigrok-fwextract-dreamsourcelab-dslogic"
27 .br
28 .RB "  Installing into: /home/<user>/sr/share/sigrok-firmware"
29 .PP
30 .SH OPTIONS
31 None.
32 .SH "EXIT STATUS"
33 Exits with 0 on success, 1 on most failures.
34 .SH "SEE ALSO"
35 \fBsigrok\-fwextract\-hantek\-dso\fP(1)
36 .br
37 \fBsigrok\-fwextract\-lecroy\-logicstudio\fP(1)
38 .br
39 \fBsigrok\-fwextract\-saleae\-logic16\fP(1)
40 .br
41 \fBsigrok\-fwextract\-sysclk\-lwla1016\fP(1)
42 .br
43 \fBsigrok\-fwextract\-sysclk\-lwla1034\fP(1)
44 .SH "BUGS"
45 Please report any bugs via Bugzilla
46 .RB "(" http://sigrok.org/bugzilla ")"
47 or on the sigrok\-devel mailing list
48 .RB "(" sigrok\-devel@lists.souceforge.net ")."
49 .SH "LICENSE"
50 This program is covered by the GNU General Public License (GPL),
51 version 3 or later.
52 .SH "AUTHORS"
53 Please see the individual source code files.