Merge pull request #2070 from stefanrueger/parsing

Update command line option parsing

Author: stefanrueger

src/avrdude.1

@@ -22,36 +22,38 @@
 .Dt AVRDUDE 1
 .Sh NAME
 .Nm avrdude
-.Nd driver program for ``simple'' Atmel AVR MCU programmer
+.Nd driver program for AVR MCU programmers
 .Sh SYNOPSIS
 .Nm
-.Op Fl p, \-part Ar partname
-.Op Fl b, \-baud Ar baudrate
-.Op Fl B, \-bitclock Ar bitclock
-.Op Fl c, \-programmer Ar programmer-id
-.Op Fl C, \-config Ar config-file
-.Op Fl N, \-noconfig
-.Op Fl A
-.Op Fl D, \-noerase
-.Op Fl e, \-erase
-.Oo Fl E Ar exitspec Ns
+.Op Fl p \-part Ar part
+.Op Fl b \-baud Ar baudrate
+.Op Fl B \-bitclock Ar clock
+.Op Fl c \-programmer Ar pgm
+.Op Fl C \-config Ar file
+.Op Fl C \-config Ar +file
+.Op Fl N \-noconfig
+.Op Fl A \-keep-trailing-0xff
+.Op Fl D \-noerase
+.Op Fl e \-erase
+.Oo Fl E \-exitspecs Ar exitspec Ns
 .Op \&, Ns Ar exitspec
 .Oc
-.Op Fl F
-.Op Fl i Ar delay
-.Op Fl l, \-logfile Ar logfile
-.Op Fl n, \-test-memory
-.Op Fl O, \-osccal
-.Op Fl P, \-port Ar port
-.Op Fl r, \-reconnect
-.Op Fl q, \-quell
-.Op Fl T Ar cmd
-.Op Fl t, \-terminal
-.Op Fl U, \-memory Ar memory:op:filename:filefmt
-.Op Fl v, \-verbose
-.Op Fl x Ar extended_param
-.Op Fl V, \-noverify-memory
+.Op Fl F \-force
+.Op Fl i \-isp-clock-delay Ar delay
+.Op Fl l \-logfile Ar file
+.Op Fl n \-test-memory
+.Op Fl O \-osccal
+.Op Fl P \-port Ar port
+.Op Fl r \-reconnect
+.Op Fl q \-quell
+.Op Fl T \-command Ar cmd
+.Op Fl t \-terminal
+.Op Fl U \-memory Ar mem:op:file:fmt
+.Op Fl v \-verbose
+.Op Fl x \-extended Ar extended_param
+.Op Fl V \-noverify-memory
 .Op Fl \-version
+.Op Fl h \-help
 .Sh DESCRIPTION
 .Nm Avrdude
 is a program for downloading and uploading on-chip memories of Atmel AVR
@@ -430,7 +432,7 @@ Run developer options for programmers that are matched by wildcard. Whilst
 their main use is for developers some flags can be of utility for users, e.g.,
 avrdude -c usbtiny/S shows AVRDUDE's understanding of usbtiny's properties;
 for more information run avrdude -c x/h.
-.It Fl C \-config Ar config-file
+.It Fl C \-config Ar file
 Use the specified config file to load configuration data.  This file
 contains all programmer and part definitions that
 .Nm avrdude
@@ -440,9 +442,9 @@ See the config file, located at
 which contains a description of the format.
 .Pp
 If
-.Ar config-file
+.Ar file
 is written as
-.Pa +filename
+.Pa +file
 then this file is read after the system wide and user configuration
 files. This can be used to add entries to the configuration
 without patching your system wide configuration file. It can be used
@@ -452,7 +454,7 @@ line.
 Do not load the personal configuration file that is usually located at
 ~/.config/avrdude/avrdude.rc, ~/.avrduderc or in the same directory as the
 avrdude executable
-.It Fl A
+.It Fl A \-keep-trailing-0xff
 Disable the automatic removal of trailing-0xFF sequences in file
 input that is to be programmed to flash and in AVR reads from
 flash memory. Normally, trailing 0xFFs can be discarded, as flash
@@ -527,7 +529,7 @@ flash.
 Note that for reprogramming EEPROM cells, no explicit prior chip
 erase is required since the MCU provides an auto-erase cycle in that
 case before programming the cell.
-.It Xo Fl E Ar exitspec Ns
+.It Xo Fl E \-exitspecs Ar exitspec Ns
 .Op \&, Ns Ar exitspec
 .Xc
 Pass
@@ -537,7 +539,7 @@ depends on the programmer itself. See below for a list of programmers
 accepting exitspec parameter options or issue
 .Nm
 -E help ... to see the options of the chosen programmer.
-.It Fl F
+.It Fl F \-force
 Normally,
 .Nm
 tries to verify that the device signature read from the part is
@@ -553,7 +555,7 @@ together with
 to continue in terminal mode.
 Moreover, the option allows to continue despite failed initialization
 of connection between a programmer and a target.
-.It Fl i Ar delay
+.It Fl i \-isp-clock-delay Ar delay
 For bitbang-type programmers, delay for approximately
 .Ar delay
 microseconds between each bit state change.
@@ -571,9 +573,9 @@ is running.
 On Win32 operating systems, a preconfigured number of cycles per
 microsecond is assumed that might be off a bit for very fast or very
 slow machines.
-.It Fl l \-logfile Ar logfile
+.It Fl l \-logfile Ar file
 Use
-.Ar logfile
+.Ar file
 rather than
 .Va stderr
 for diagnostics output.
@@ -747,7 +749,7 @@ Posix systems (by now).
 .It Fl q \-quell
 Disable (or quell) output of the progress bar while reading or writing
 to the device.  Specify it more often for even quieter operations.
-.It Fl T Ar cmd
+.It Fl T \-command Ar cmd
 Run terminal line
 .Ar cmd
 when it is its turn in relation to other -t interactive terminals
@@ -969,7 +971,7 @@ options increase verbosity level.
 Disable automatic verify check when writing data to the AVR with -U.
 .It Fl \-version
 Print version and exit
-.It Fl x Ar extended_param
+.It Fl x \-extended Ar extended_param
 Pass
 .Ar extended_param
 to the chosen programmer implementation as an extended parameter.
@@ -979,6 +981,8 @@ See below for a list of programmers accepting extended parameters
 or issue
 .Nm
 -x help ... to see the extended options of the chosen programmer.
+.It Fl h \-help
+Show a short help message and exit
 .El
 .Ss Terminal mode
 In this mode,

src/doc/avrdude.texi

@@ -666,8 +666,11 @@ Do not load the personal configuration file that is usually located at
 directory as the avrdude executable.
 
 @item -A
+@item --keep-trailing-0xff
 @cindex Option @code{-A}
+@cindex Option @code{--keep-trailing-0xff}
 @cindex @code{-A}
+@cindex @code{--keep-trailing-0xff}
 @cindex @code{flash}
 Disable the automatic removal of trailing-0xFF sequences in file input
 that is to be programmed to flash and in AVR reads from flash memory.
@@ -732,8 +735,11 @@ required since the MCU provides an auto-erase cycle in that case before
 programming the cell.
 
 @item -E @var{exitspec}[,@dots{}]
+@item --exitspecs @var{exitspec}[,@dots{}]
 @cindex Option @code{-E} @var{exitspec}[,@dots{}]
+@cindex Option @code{--exitspecs} @var{exitspec}[,@dots{}]
 @cindex @code{-E} @var{exitspec}[,@dots{}]
+@cindex @code{--exitspecs} @var{exitspec}[,@dots{}]
 Pass @var{exitspec} to the programmer. The interpretation of the exitspec
 parameter depends on the programmer itself. See below for a list of
 programmers accepting exitspec parameter options or issue
@@ -742,8 +748,11 @@ programmers accepting exitspec parameter options or issue
 Multiple @var{exitspec} options can be separated with commas.
 
 @item -F
+@item --force
 @cindex Option @code{-F}
+@cindex Option @code{--force}
 @cindex @code{-F}
+@cindex @code{--force}
 @cindex @code{signature}
 Normally, AVRDUDE tries to verify that the device signature read from
 the part is reasonable before continuing.  Since it can happen from time
@@ -758,8 +767,11 @@ Moreover, the option allows to continue despite failed initialization
 of connection between a programmer and a target.
 
 @item -i @var{delay}
+@item --isp-clock-delay @var{delay}
 @cindex Option @code{-i} @var{delay}
+@cindex Option @code{--isp-clock-delay} @var{delay}
 @cindex @code{-i} @var{delay}
+@cindex @code{--isp-clock-delay} @var{delay}
 For bitbang-type programmers, delay for approximately
 @var{delay}
 microseconds between each bit state change.
@@ -941,8 +953,11 @@ Disable (or quell) output of the progress bar while reading or writing
 to the device.  Specify it a second time for even quieter operation.
 
 @item -T @var{cmd}
+@item --command @var{cmd}
 @cindex Option @code{-T} @var{cmd}
+@cindex Option @code{--command} @var{cmd}
 @cindex @code{-T} @var{cmd}
+@cindex @code{--command} @var{cmd}
 Run terminal line @var{cmd} when it is its turn in relation to other
 @code{-t} interactive terminals, @code{-T} terminal commands and
 @code{-U} memory operations. Except for the simplest of terminal commands
@@ -960,16 +975,16 @@ Tells AVRDUDE to run an interactive terminal when it is its turn in
 relation to other @code{-t} interactive terminals, @code{-T}
 terminal commands and @code{-U} memory operations.
 
-@item -U @var{memory}:@var{op}:@var{filename}[:@var{format}]
-@item --memory @var{memory}:@var{op}:@var{filename}[:@var{format}]
-@cindex Option @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
-@cindex Option @code{--memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]
-@cindex @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
-@cindex @code{--memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]
+@item -U @var{mem}:@var{op}:@var{file}[:@var{fmt}]
+@item --memory @var{mem}:@var{op}:@var{fil}[:@var{fmt}]
+@cindex Option @code{-U} @var{mem}:@var{op}:@var{file}[:@var{fmt}]
+@cindex Option @code{--memory} @var{mem}:@var{op}:@var{file}[:@var{fmt}]
+@cindex @code{-U} @var{mem}:@var{op}:@var{file}[:@var{fmt}]
+@cindex @code{--memory} @var{mem}:@var{op}:@var{file}[:@var{fmt}]
 
 Perform a memory operation when it is its turn in relation to other
 @code{-t} interactive terminals, @code{-T} terminal commands and @code{-U}
-memory operations. The @var{memory} field specifies the memory type to
+memory operations. The @var{mem} field specifies the memory type to
 operate on. From version 8.0 the memory field can also be a
 comma-separated list of memories, eg, @code{flash,eeprom}; also, Intel Hex
 or Motorola S-Record files generated by AVRDUDE can store multiple
@@ -1037,8 +1052,8 @@ read data from both the device and the specified file and perform a verify
 
 @end table
 
-The @var{filename} field indicates the name of the file to read or
-write.  The @var{format} field is optional and contains the format of
+The @var{file} field indicates the name of the file to read or
+write.  The @var{fmt} field is optional and contains the format of
 the file to read or write.  Possible values are:
 
 @table @code
@@ -1066,7 +1081,7 @@ linker; currently only accepted as an input file
 @cindex Immediate file mode
 @item m
 immediate mode; actual byte values are specified on the command line,
-separated by commas or spaces in place of the @var{filename} field of the
+separated by commas or spaces in place of the @var{file} field of the
 @option{-U} option.  This is useful for programming fuse bytes without
 having to create a single-byte file or enter terminal mode.
 
@@ -1120,9 +1135,9 @@ single output file from a memory list for all formats with the exception
 of elf (@code{:e}) it only recognises Intel hex (@code{:I} or @code{:i}),
 Motorola S-Record (@code{:s}) or elf files (@code{:e}, generated by the
 compiler) as valid multi-memory files when reading a file for verifying or
-writing memories. Note also that if a @var{filename} contains a colon as
-penultimate character the @var{format} field is no longer optional since
-the last character would otherwise be misinterpreted as @var{format}.
+writing memories. Note also that if a file name contains a colon as
+penultimate character the @var{fmt} field is no longer optional since
+the last character would otherwise be misinterpreted as @var{fmt}.
 
 @cindex @code{flash}
 When reading any kind of flash memory area (including the various sub-areas
@@ -1132,11 +1147,11 @@ entire memory is unprogrammed, this will result in an output file that has no
 contents at all. This behaviour can be overridden with the @code{-A} option.
 
 @cindex @code{flash}
-As an abbreviation, the form @code{-U} @var{filename}
+As an abbreviation, the form @code{-U} @var{file}
 is equivalent to specifying
-@code{-U} @emph{flash:w:}@var{filename}@emph{:a} or
-@code{-U} @emph{application:w:}@var{filename}@emph{:a} for ATxmegas.
-This will only work if @var{filename} does not have a pair of colons in it
+@code{-U} @emph{flash:w:}@var{file}@emph{:a} or
+@code{-U} @emph{application:w:}@var{file}@emph{:a} for ATxmegas.
+This will only work if @var{file} does not have a pair of colons in it
 that sandwich a single character as otherwise the first part might be
 interpreted as memory, and the single character as memory operation.
 
@@ -1169,14 +1184,26 @@ Disable automatic verify check when writing data to the AVR with @code{-U}.
 @cindex Option @code{--version}
 Print avrdude version and exit
 
-@item -x @var{extended_param}
-@cindex Option @code{-x} @var{extended_param}
-@cindex @code{-x} @var{extended_param}
-Pass @var{extended_param} to the chosen programmer implementation as
+@item -x @var{parameter}
+@item --extended @var{parameter}
+@cindex Option @code{-x} @var{parameter}
+@cindex Option @code{--extended} @var{parameter}
+@cindex @code{-x} @var{parameter}
+@cindex @code{--extended} @var{parameter}
+Pass @var{parameter} to the chosen programmer implementation as
 an extended parameter.  The interpretation of the extended parameter
 depends on the programmer itself.  See below for a list of programmers
 accepting extended parameters or issue @code{avrdude -x help ...} to
-see the extended options of the chosen programmer.
+see the extended options of the chosen programmer. This option can be used
+several times on the command line.
+
+@item -h
+@item --help
+@cindex Option @code{-h}
+@cindex Option @code{--help}
+@cindex @code{-h}
+@cindex @code{--help}
+Show a short help text and exit
 
 @end table