root/trunk/libffado/support/firmware/ffado-dice-firmware.1

Revision 2089, 1.6 kB (checked in by jwoithe, 9 years ago)

Provide manpages for commonly used FFADO programs. Closes #294.

Line 
1 .TH FFADO-DICE-FIRMWARE 1 27-Mar-2012 "ffado-dice-firmware"
2 .SH NAME
3 ffado-dice-firmware \- firmware download application for DICE-based devices
4 .SH SYNOPSIS
5 .BI "ffado-dice-firmware [OPTION...]
6 .sp
7 .SH DESCRIPTION
8 .B ffado-dice-firmware
9 permits firmware updates to be made to DICE-based devices under
10 Linux.
11 .sp
12 .SH OPTIONS
13 .TP
14 .B "\-h, \-\-help"
15 Display brief usage information and exit
16 .TP 
17 .B "\-p, \-\-port=NUM"
18 Specify use of IEEE1394 port
19 .I NUM
20 .TP   
21 .B "\-v, \-\-verbose=LEVEL"
22 Produce verbose output.  The higher the
23 .I LEVEL
24 the more verbose the messages.  The some verbose messages may only be
25 available of FFADO was compiled with debugging enabled.
26 .TP
27 .B "\-d, \-\-delete=IMAGENAME"
28 Delete image by name.
29 .TP
30 .B "\-e, \-\-dump=FILENAME"
31 Extract current DICE device flash contents into file
32 .I FILENAME
33 .TP
34 .B "\-f, \-\-flash=FILENAME"
35 Write firmware file
36 .I FILENAME
37 to DICE device.
38 .TP
39 .B "\-i, \-\-image-info"
40 Show detailed information about each image within the firmware on the
41 device.
42 .TP
43 .B "\-m, \-\-flash-info"
44 Show information about the flash memory on the device.
45 .TP
46 .B "\-s, \-\-dice-info"
47 Show DICE image vendor and product information.
48 .TP
49 .B "\-t, \-\-test OPERATION"
50 Invoke a test/debug operation.  Possible
51 .I OPERATIONs
52 are 1 (POKE, write to address) and 2 (PEEK, read from address).  Refer to
53 the source code for further information.
54 .TP
55 .B "\-n, \-\-node NODE"
56 Specify the node to operate on.
57 .sp
58 .SH NOTES
59 Manipulating firmware can cause your device to stop working.  The FFADO
60 project accepts no responsibility if this occurs as a result of using this
61 tool.
Note: See TracBrowser for help on using the browser.