root/trunk/libffado/support/firmware/ffado-fireworks-downloader.1

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

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

Line 
1 .TH FFADO-FIREWORKS-DOWNLOADER 1 27-Mar-2012 "ffado-fireworks-downloader"
2 .SH NAME
3 ffado-fireworks-downloader \- firmware download application for Echo
4 Fireworks devices
5 .SH SYNOPSIS
6 .BI "ffado-fireworks-downloader [OPTION...] OPERATION
7 .sp
8 .SH DESCRIPTION
9 .B ffado-bridgeco-downloader
10 permits firmware updates to be made to Echo Fireworks devices under
11 Linux.
12 .I OPERATION
13 describes the action to be carried out.  An
14 .I OPERATION
15 comprises one of the following keywords and any arguments required by that
16 keyword.
17 .TP
18 .B list
19 List devices on the firewire bus.
20 .TP
21 .B display
22 Display information about a device and its firmware.
23 .TP
24 .B upload FILE
25 Upload the firmware contained in
26 .I FILE
27 to the device
28 .TP
29 .B download FILE START_ADDR LEN
30 Download the flash contents from the device. 
31 .I LEN
32 bytes will be downloaded starting at
33 .I START_ADDR
34 and written to the file
35 .I FILE
36 .TP
37 .B verify FILE
38 Verify that the firmware contained in the device corresponds to the one in
39 .I FILE
40 .TP
41 .B session_display
42 Show information about the session on the device.
43 .TP
44 .B session_info FILE
45 Show information about the device session stored in
46 .I FILE
47 .TP
48 .B session_download FILE
49 Download the session content from the device into
50 .I FILE
51 .TP
52 .B session_upload FILE
53 Upload the session from
54 .I FILE
55 to the device.
56 .sp
57 .SH OPTIONS
58 .TP
59 .B "\-h, \-\-help"
60 Display brief usage information and exit
61 .TP 
62 .B "\-p, \-\-port=NUM"
63 Specify use of IEEE1394 port
64 .I NUM
65 .TP   
66 .B "\-v, \-\-verbose=LEVEL"
67 Produce verbose output.  The higher the
68 .I LEVEL
69 the more verbose the messages.  The some verbose messages may only be
70 available of FFADO was compiled with debugging enabled.
71 .TP
72 .B "\-g, \-\-guid=GUID"
73 Specify the GUID of the device to interact with.  If this is not specified
74 an attempt will be made to automatically detect a suitable device.
75 .TP
76 .B "\-m, \-\-magic=MAGIC"
77 A magic number you have to obtain before this program will work.  Specifying
78 it on the command line means that you accept the risks which come with this
79 tool.  The magic number can be obtained in the source code.
80 .sp
81 .SH NOTES
82 Manipulating firmware can cause your device to stop working.  The FFADO
83 project accepts no responsibility if this occurs as a result of using this
84 tool.
Note: See TracBrowser for help on using the browser.