.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "USBPROG 1"
.TH USBPROG 1 "2010-01-04" "0.2.0" "USBprog"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
usbprog \- Programmer for the USBprog hardware
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
usbprog [options] [commands]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
USBprog has two modes: An interactive mode and a batch mode. Both mode use
exactly the same commands. As every command takes a fixed number of arguments,
no separator is necessary between commands \*(-- just specify as much commands as
you would like to execute.
.PP
The \fBhelp\fR command gives a list of all commands, \fB?\fR \fIcommand\fR can be used
to get help for a specific command. Example:
.PP
.Vb 2
\&  (usbprog) help
\&  (usbprog) ? upload
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
Following options can be specified, both for the interactive and the batch
mode:
.IP "\fB\-h\fR | \fB\-\-help\fR" 7
.IX Item "-h | --help"
Prints a short help.
.IP "\fB\-v\fR | \fB\-\-version\fR" 7
.IX Item "-v | --version"
Prints the version number to standard output.
.IP "\fB\-d\fR | \fB\-\-datadir\fR \fIdatadir\fR" 7
.IX Item "-d | --datadir datadir"
Uses \fIdatadir\fR instead of \fI~/.usbprog\fR.
.IP "\fB\-o\fR | \fB\-\-offline\fR" 7
.IX Item "-o | --offline"
Don't try to connect to the internet. Use the cached firmware and index
file(s) only.
.IP "\fB\-D\fR | \fB\-\-debug\fR" 7
.IX Item "-D | --debug"
Enable debugging output.
.SH "COMMANDS"
.IX Header "COMMANDS"
This section describes all commands. As mentioned above, the syntax is the
same for interactive and batch usage.
.IP "\fBhelp\fR" 7
.IX Item "help"
This just prints an overview about every command, i.e. the command name
and an one-sentence description.
.IP "\fBhelpcmd\fR | \fB?\fR \fIcommand\fR" 7
.IX Item "helpcmd | ? command"
Print a detailed description for \fIcommand\fR.
.IP "\fBexit\fR | \fBquit\fR" 7
.IX Item "exit | quit"
Quit the program. On Unix, you can also send an \fI\s-1EOF\s0\fR by pressing \fICtrl-d\fR
on your terminal.
.IP "\fBcopying\fR | \fBlicense\fR" 7
.IX Item "copying | license"
Prints a short license (\s-1GPL\s0) text and the version number of the program.
.IP "\fBlist\fR | \fBfirmwares\fR" 7
.IX Item "list | firmwares"
Prints a list of available firmwares. A \fI[*]\fR shows that the firmware is
available in the offline cache.
.IP "\fBdownload\fR \fIfirmware\fR" 7
.IX Item "download firmware"
Downloads the specified \fIfirmware\fR. Use the same string as you retrieved from
the \fBfirmwares\fR command described above. This command doesn't work in offline
mode.
.IP "\fBinfo\fR \fIfirmware\fR" 7
.IX Item "info firmware"
Shows some basic information about \fIfirmware\fR like what it does, the latest
version number, the author and the \s-1USB\s0 \s-1ID\s0 which the USBprog device has after
this firmware has been uploaded. See also the \fBpins\fR command.
.IP "\fBpins\fR \fIfirmware\fR" 7
.IX Item "pins firmware"
This shows the \s-1PIN\s0 assignment of \fIfirmware\fR and the meaning of the \s-1LED\s0 and
jumpers. See also the \fBinfo\fR command for basic information about the
\&\fIfirmware\fR.
.IP "\fBcache\fR \fIclean\fR | \fIdelete\fR" 7
.IX Item "cache clean | delete"
\&\fIclean\fR deletes all old firmware versions from the firmware cache, i.e. if
the latest version of a firmware is 5, then it deletes the versions 0 to 4 if
they are still on disk. The \fIdelete\fR command deletes the whole firmware
cache. Only the index and history file are in the cache directory after
executing this command.
.IP "\fBdevices\fR" 7
.IX Item "devices"
Shows a list of connected \s-1USB\s0 devices related to USBprog. The currently used
update device an be set with \fBdevice\fR and is also marked in the output.
.IP "\fBdevice\fR \fInumber\fR | \fIname\fR" 7
.IX Item "device number | name"
Sets the update device for the \fBupload\fR command. You have to use the integer
\&\fInumber\fR or the device \fIname\fR you retrieved from the \fBdevices\fR command.
.IP "\fBupload\fR \fIfirmware\fR | \fIfile\fR" 7
.IX Item "upload firmware | file"
Uploads a new firmware. The firmware identifier can be found with the
\&\fBlist\fR command. Alternatively, you can also specify a file name on the disk.
The extension doesn't matter.
.SH "FILES"
.IX Header "FILES"
.IP "\fI~/.usbprog/version.xml\fR" 7
.IX Item "~/.usbprog/version.xml"
Index file, downloaded from \fIhttp://www.ixbat.de/usbprog/versions.xml\fR.
.IP "\fI~/.usbprog/history\fR" 7
.IX Item "~/.usbprog/history"
The saved \fIreadline\fR\|(1) history.
.IP "\fI~/.usbprog/*\fR" 7
.IX Item "~/.usbprog/*"
The rest in that directory are firmware files. The naming scheme is
\&\fIname\fR.\fIversion\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
The USBprog program and documentation has been written by Bernhard Walle
<bernhard@bwalle.de>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIusbprog\-gui\fR\|(1), \fIhttp://www.embedded\-projects.net/index.php?page_id=135\fR