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

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

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

Line 
1 .TH FFADO-BRIDGECO-DOWNLOADER 1 27-Mar-2012 "ffado-bridgeco-downloader"
2 .SH NAME
3 ffado-bridgeco-downloader \- firmware download application for BridgeCo
4 devices
5 .SH SYNOPSIS
6 .BI "ffado-bridgeco-downloader [OPTION...] OPERATION
7 .sp
8 .SH DESCRIPTION
9 .B ffado-bridgeco-downloader
10 permits firmware updates to be made to BridgeCo (aka BeBoB) devices under
11 Linux.
12 .I OPERATION
13 describes the action to be carried out.  An
14 .I OPERATION
15 is introduced with the GUID of the device to operate on.  This is followed
16 by one of the following keywords and any arguments required by that keyword.
17 .TP
18 .B display
19 Display information about the interface
20 .TP
21 .B setguid NEW_GUID
22 Set the device's GUID to
23 .I NEW_GUID
24 .TP
25 .B firmware FILE
26 Download the firmware file
27 .I FILE
28 to the device.
29 .TP
30 .B cne FILE
31 Download the CnE file
32 .I FILE
33 to the device.
34 .TP
35 .B bcd FILE
36 Parse the BeBoB BCD file
37 .I FILE
38 and display information about the contents.
39 .sp
40 .SH OPTIONS
41 .TP
42 .B "\-?, \-\-help, \-\-usage"
43 Display brief usage information and exit
44 .TP
45 .B "\-V, \-\-version"
46 Show the program version and exit
47 .TP 
48 .B "\-p, \-\-port=NUM"
49 Specify use of IEEE1394 port
50 .I NUM
51 .TP   
52 .B "\-v, \-\-verbose=LEVEL"
53 Produce verbose output.  The higher the
54 .I LEVEL
55 the more verbose the messages.  The some verbose messages may only be
56 available of FFADO was compiled with debugging enabled.
57 .TP
58 .B "\-b, \-\-noboot"
59 Do not start the bootloader.  Use this if the bootloader is already running.
60 .TP
61 .B "\-f, \-\-force"
62 Force firmware download in the event the program doesn't think it's a good
63 idea.  Use with caution.
64 .TP
65 .B "\-m, \-\-magic=MAGIC"
66 A magic number you have to obtain before this program will work.  Specifying
67 it on the command line means that you accept the risks which come with this
68 tool.  The magic number can be obtained in the source code.
69 .sp
70 .SH NOTES
71 Manipulating firmware can cause your device to stop working.  The FFADO
72 project accepts no responsibility if this occurs as a result of using this
73 tool.
Note: See TracBrowser for help on using the browser.