diff options
Diffstat (limited to 'doc/dfu-suffix.1')
| -rw-r--r-- | doc/dfu-suffix.1 | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/dfu-suffix.1 b/doc/dfu-suffix.1 new file mode 100644 index 0000000..edea5d0 --- /dev/null +++ b/doc/dfu-suffix.1 @@ -0,0 +1,91 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "DFU\-SUFFIX" "1" "September 2021" "dfu\-util 0.11" "" +.hy +.SH NAME +.PP +dfu\-suffix \- add, check, or remove DFU firmware file suffix +.SH SYNOPSIS +.PP +\f[B]dfu\-suffix\f[R] [\f[I]options\f[R]] \f[B]\-\-add\f[R] +\f[I]DFU_FILE\f[R] +.PD 0 +.P +.PD +\f[B]dfu\-suffix\f[R] \f[B]\-\-check\f[R] \f[I]DFU_FILE\f[R] +.PD 0 +.P +.PD +\f[B]dfu\-suffix\f[R] \f[B]\-\-delete\f[R] \f[I]DFU_FILE\f[R] +.PD 0 +.P +.PD +\f[B]dfu\-suffix\f[R] \f[B]\-\-help\f[R] +.PD 0 +.P +.PD +\f[B]dfu\-suffix\f[R] \f[B]\-\-version\f[R] +.SH DESCRIPTION +.PP +The program \f[B]dfu\-suffix\f[R] can be used to add, check or remove a +DFU firmware file suffix, recommended for safely matching a firmware +file and device. +.PP +Note that a suffix is recommended by the DFU standard, but not required. +A DFU host tool like dfu\-util will recognize the suffix and use it to +check that the device is matching, but not transfer the suffix to the +device. +.SH OPTIONS +.TP +.B \-v, \-\-vid \f[I]vendorID\f[R] +Specify USB vendor ID (hexadecimal) +.TP +.B \-p, \-\-pid \f[I]productID\f[R] +Specify USB product ID (hexadecimal) +.TP +.B \-d, \-\-did \f[I]deviceID\f[R] +Specify USB device ID (hexadecimal) +.TP +.B \-S, \-\-spec \f[I]version\f[R] +Specify DFU specification version (hexadecimal) +.TP +.B \-h, \-\-help +Displays a help message. +.TP +.B \-V, \-\-version +Displays the software version. +.SH EXAMPLES +.TP +.B \f[B]dfu\-suffix\f[R] \-\-vid 0123 \-\-add firmware.dfu +Adds a suffix matching vendor 0x0123 and product ID 0x4567. +Since product and device ID are not specified, they will contain the +wildcard value 0xFFFF. +.TP +.B \f[B]dfu\-suffix\f[R] \-\-check firmware.dfu +Checks the file firmware.dfu for a valid DFU suffix +.TP +.B \f[B]dfu\-suffix\f[R] \-\-delete firmware.dfu +Removes a valid DFU suffix from the file firmware.dfu +.SH EXIT VALUES +.TP +.B \f[B]0\f[R] +Success (also if suffix is missing) +.TP +.B \f[B]\-64\f[R] +Usage error +.SH LIMITATIONS +.PP +\f[B]dfu\-suffix\f[R] can not tell a broken DFU suffix (e.g.\ checksum +mismatch) from a non\-existing suffix, so only a valid suffix can be +removed. +.SH BUGS +.PP +https://sourceforge.net/p/dfu\-util/tickets/ +.SH COPYRIGHT +.PP +License GPLv2: GNU GPL version 2 +.SH SEE ALSO +.PP +\f[B]dfu\-prefix\f[R](1), \f[B]dfu\-util\f[R](1) +.SH AUTHORS +See AUTHORS file in source. |