[Demudi-commits] r1441 - libffado/trunk/debian
marciotex-guest at alioth.debian.org
marciotex-guest at alioth.debian.org
Sun Jun 3 05:03:38 UTC 2007
Author: marciotex-guest
Date: 2007-06-03 05:03:37 +0000 (Sun, 03 Jun 2007)
New Revision: 1441
Modified:
libffado/trunk/debian/ffado-bridgeco-downloader.1
libffado/trunk/debian/ffado-bridgeco-downloader.xml
Log:
manpage bridgeco downloader fixed
Modified: libffado/trunk/debian/ffado-bridgeco-downloader.1
===================================================================
--- libffado/trunk/debian/ffado-bridgeco-downloader.1 2007-06-03 00:31:48 UTC (rev 1440)
+++ libffado/trunk/debian/ffado-bridgeco-downloader.1 2007-06-03 05:03:37 UTC (rev 1441)
@@ -1,11 +1,11 @@
-.\" Title: LIBFREEBOB
+.\" Title: libffado
.\" Author: Marcio Teixeira
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\" Date: july 4, 2006
+.\" Date: june 3, 2007
.\" Manual:
.\" Source:
.\"
-.TH "LIBFREEBOB" "1" "july 4, 2006" "" ""
+.TH "LIBFFADO" "1" "june 3, 2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -14,38 +14,82 @@
ffado\-bridgeco\-downloader \- firmware downloader application
.SH "SYNOPSIS"
.HP 26
-\fBffado\-bridgeco\-downloader\fR [\fB\-v\ \fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-f\ \fR]
+\fBffado\-bridgeco\-downloader\fR [\-b\ \-f\ \-p\ \fIPORT\fR\ \-v\ \fILEVEL\fR] \fINODE_ID\fR \fIOPERATION\fR
+.HP 26
+\fBffado\-bridgeco\-downloader\fR [\-? | \-\-usage | \-V]
.SH "DESCRIPTION"
.PP
+BridgeCo devices are audio breakout boxes running BridgeCo firmware (a.k.a. BeBoB). BridgeCo devices are attached with IEEE1394, a.k.a FireWire(tm) or i.Link(tm), a high performance serial bus.
+.PP
\fBffado\-bridgeco\-downloader\fR
-is a program to download firmware from freebob devices.
-.PP
-This manual page was written for the
-Debian(TM)
-distribution because the original program does not have a manual page.
+is a program to download firmware from these devices.
.SH "OPTIONS"
.PP
-These programs follow the usual
-GNU
-command line syntax. A summary of options is included below.
+\fB\-b , \-\-noboot\fR
+.RS 4
+Do no start bootloader (bootloader is already running)
+.RE
.PP
-\fB\-v\fR
+\fB\-f\fR
.RS 4
-Produce verbose output.
+Force firmware download.
.RE
.PP
-\fB\-p \fR\fB\fIport\fR\fR
+\fB\-p \fR\fB\fIPORT\fR\fR\fB, \-\-port=\fR\fB\fIPORT\fR\fR
.RS 4
Set port.
.RE
.PP
-\fB\-f\fR
+\fB\-v \fR\fB\fILEVEL\fR\fR\fB, \-\-verbose=\fR\fB\fILEVEL\fR\fR
.RS 4
-Force firmware download.
+Produce verbose output.
.RE
+.PP
+\fB\-?, \-\-help\fR
+.RS 4
+Give help list.
+.RE
+.PP
+\fB\-\-usage\fR
+.RS 4
+Give a short usage message.
+.RE
+.PP
+\fB\-V, \-\-version\fR
+.RS 4
+Print program version.
+.RE
+.SH "NODE_ID"
+.PP
+An unique number of device on IEEE1394 bus. For find it check Physical ID field of gscanbus.
+.SH "OPERATIONS"
+.PP
+.RS 4
+display
+.RE
+.PP
+.RS 4
+setguid
+\fIGUID\fR
+.RE
+.PP
+.RS 4
+firmware
+\fIFILE\fR
+.RE
+.PP
+.RS 4
+cne
+\fIFILE\fR
+.RE
+.PP
+.RS 4
+bcd
+\fIFILE\fR
+.RE
.SH "SEE ALSO"
.PP
-plugreport (1) plugctl (1)
+ffado\-bebob\-sync(1) gscanbus(1)
.SH "AUTHOR"
.PP
This manual page was written by Marcio Roberto Teixeira
@@ -64,6 +108,6 @@
.IP "" 4
Author.
.SH "COPYRIGHT"
-Copyright \(co 2006 Marcio Roberto Teixeira
+Copyright \(co 2007 Marcio Roberto Teixeira
.br
Modified: libffado/trunk/debian/ffado-bridgeco-downloader.xml
===================================================================
--- libffado/trunk/debian/ffado-bridgeco-downloader.xml 2007-06-03 00:31:48 UTC (rev 1440)
+++ libffado/trunk/debian/ffado-bridgeco-downloader.xml 2007-06-03 05:03:37 UTC (rev 1441)
@@ -30,13 +30,13 @@
<!ENTITY dhfirstname "<firstname>Marcio</firstname>">
<!ENTITY dhsurname "<surname>Teixeira</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
- <!ENTITY dhdate "<date>july 4, 2006</date>">
+ <!ENTITY dhdate "<date>june 3, 2007</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>marciotex at gmail.com</email>">
<!ENTITY dhusername "Marcio Roberto Teixeira">
- <!ENTITY dhucpackage "<refentrytitle>LIBFREEBOB</refentrytitle>">
+ <!ENTITY dhucpackage "<refentrytitle>libffado</refentrytitle>">
<!ENTITY dhpackage "ffado-bridgeco-downloader">
<!ENTITY debian "<productname>Debian</productname>">
@@ -54,7 +54,7 @@
&dhsurname;
</author>
<copyright>
- <year>2006</year>
+ <year>2007</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
@@ -72,57 +72,123 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
-
- <arg><option>-v </option></arg>
- <arg><option>-p <replaceable>port</replaceable></option></arg>
- <arg><option>-f </option></arg>
+ <arg>-b -f -p <replaceable>PORT</replaceable> -v <replaceable>LEVEL</replaceable></arg>
+ <arg choice='plain'><replaceable>NODE_ID</replaceable></arg>
+ <arg choice='plain'><replaceable>OPERATION</replaceable></arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+ <group>
+ <arg choice='plain'>-?</arg>
+ <arg choice='plain'>--usage</arg>
+ <arg choice='plain'>-V</arg>
+ </group>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
- <para><command>&dhpackage;</command> is a program to download firmware from freebob devices.</para>
-
- <para>This manual page was written for the &debian; distribution
- because the original program does not have a manual page.</para>
+ <para>BridgeCo devices are audio breakout boxes running BridgeCo firmware, a.k.a. BeBoB. BridgeCo devices are attached with IEEE1394, a.k.a FireWire(tm) or i.Link(tm), a high performance serial bus.</para>
+ <para><command>&dhpackage;</command> is a program to download firmware from these devices.</para>
+ </refsect1>
- </refsect1>
<refsect1>
<title>OPTIONS</title>
-
- <para>These programs follow the usual &gnu; command line syntax.
- A summary of options is included below.</para>
-
<variablelist>
<varlistentry>
- <term><option>-v</option>
+ <term><option>-b , --noboot</option>
</term>
<listitem>
- <para>Produce verbose output.</para>
+ <para>Do no start bootloader (bootloader is already running)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-p <replaceable>port</replaceable></option>
+ <term><option>-f</option>
</term>
<listitem>
+ <para>Force firmware download.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-p <replaceable>PORT</replaceable>, --port=<replaceable>PORT</replaceable></option>
+ </term>
+ <listitem>
<para>Set port.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-f</option>
+ <term><option>-v <replaceable>LEVEL</replaceable>, --verbose=<replaceable>LEVEL</replaceable></option></term>
+ <listitem>
+ <para>Produce verbose output.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-?, --help</option>
</term>
<listitem>
- <para>Force firmware download.</para>
+ <para>Give help list.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--usage</option>
+ </term>
+ <listitem>
+ <para>Give a short usage message.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-V, --version</option>
+ </term>
+ <listitem>
+ <para>Print program version.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>
+ <title>NODE_ID</title>
+ <para>An unique number of device on IEEE1394 bus. For find it check Physical ID field of gscanbus.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>OPERATIONS</title>
+ <variablelist>
+ <varlistentry>
+ <listitem>
+ <para>display</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <listitem>
+ <para>setguid <replaceable>GUID</replaceable></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <listitem>
+ <para>firmware <replaceable>FILE</replaceable></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <listitem>
+ <para>cne <replaceable>FILE</replaceable></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <listitem>
+ <para>bcd <replaceable>FILE</replaceable></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
<title>SEE ALSO</title>
- <para>plugreport (1) plugctl (1)</para>
+ <para> ffado-bebob-sync(1) gscanbus(1)</para>
</refsect1>
+
+
<refsect1>
<title>AUTHOR</title>
More information about the Demudi-commits
mailing list