Skip to content

Commit

Permalink
Add longopts to texinfo document
Browse files Browse the repository at this point in the history
  • Loading branch information
@MCUdude
MCUdude authored Feb 7, 2025
1 parent 2b0eced commit 6ba5044
Showing 1 changed file with 60 additions and 46 deletions.
106 changes: 60 additions & 46 deletions src/doc/avrdude.texi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -509,8 +509,9 @@ following options are recognized:

@table @code
@item -p @var{partno}
@cindex Option @code{-p} @var{partno}
@cindex @code{-p} @var{partno}
@item --part @var{partno}
@cindex Option @code{-p ,--part} @var{partno}
@cindex @code{-p, --part} @var{partno}

This option tells AVRDUDE what part (MCU) is connected to the programmer.
The @var{partno} parameter is the part's id listed in the configuration
Expand All @@ -533,25 +534,28 @@ directly via a bootloader. See @ref{List of Parts} for a full and detailed
listing of supported parts.

@item -p @var{wildcard/flags}
@cindex Option @code{-p} @var{wildcard/flags}
@cindex @code{-p} @var{wildcard/flags}
@item --part @var{wildcard/flags}
@cindex Option @code{-p, --part} @var{wildcard/flags}
@cindex @code{-p, --part} @var{wildcard/flags}
Run developer options for MCUs that are matched by @var{wildcard}. Whilst
their main use is for developers some @var{flags} can be of utility for
users, e.g., @code{avrdude -p m328p/S} outputs AVRDUDE's understanding of
ATmega328P MCU properties; for more information run @code{avrdude -p x/h}.

@item -b @var{baudrate}
@cindex Option @code{-b} @var{baudrate}
@cindex @code{-b} @var{baudrate}
@item --baud @var{baudrate}
@cindex Option @code{-b, --baud} @var{baudrate}
@cindex @code{-b, baud} @var{baudrate}
Override the RS-232 connection baud rate specified in the respective
programmer's @code{baudrate} entry of the configuration file
or defined by the @code{default_baudrate} entry in your
@code{~/.config/avrdude/avrdude.rc} or @code{~/.avrduderc} configuration
file if no @code{baudrate} entry was provided for this programmer.

@item -B @var{bitclock}
@cindex Option @code{-B} @var{bitclock}
@cindex @code{-B} @var{bitclock}
@item --bitclock @var{bitclock}
@cindex Option @code{-B, --bitclock} @var{bitclock}
@cindex @code{-B, --bitclock} @var{bitclock}
Specify the bit clock period for the JTAG, PDI, TPI, UPDI, or ISP
interface. The value is a floating-point number in microseconds.
Alternatively, the value might be suffixed with Hz, kHz or
Expand All @@ -577,8 +581,9 @@ the last user-specified bitclock until the programmer is disconnected from
the computer.

@item -c @var{programmer-id}
@cindex Option @code{-c} @var{programmer-id}
@cindex @code{-c} @var{programmer-id}
@item --programmer @var{programmer-id}
@cindex Option @code{-c, --programmer} @var{programmer-id}
@cindex @code{-c, --programmer} @var{programmer-id}

Specify the programmer to be used. AVRDUDE knows about quite a few
programmers. The @var{programmer-id} parameter is the programmer's id
Expand All @@ -596,16 +601,18 @@ bootloader. See @ref{List of Programmers} for a full and detailed listing
of known programmers.

@item -c @var{wildcard/flags}
@cindex Option @code{-c} @var{wildcard/flags}
@cindex @code{-c} @var{wildcard/flags}
@item --programmer @var{wildcard/flags}
@cindex Option @code{-c, --programmer} @var{wildcard/flags}
@cindex @code{-c, --programmer} @var{wildcard/flags}
Run developer options for programmers that are matched by @var{wildcard}.
Whilst their main use is for developers some @var{flags} can be of utility
for users, e.g., @code{avrdude -c usbtiny/S} shows AVRDUDE's understanding of
usbtiny's properties; for more information run @code{avrdude -c x/h}.

@item -C @var{config-file}
@cindex Option @code{-C} @var{config-file}
@cindex @code{-C} @var{config-file}
@item --config @var{config-file}
@cindex Option @code{-C, --config} @var{config-file}
@cindex @code{-C, --config} @var{config-file}
@cindex Configuration files
Use the specified config file for configuration data. This file
contains all programmer and part definitions that AVRDUDE knows about.
Expand Down Expand Up @@ -634,8 +641,9 @@ several times, the files are read in same order as given on the command
line.

@item -N
@cindex Option @code{-N}
@cindex @code{-N}
@item --noconfig
@cindex Option @code{-N, --noconfig}
@cindex @code{-N, --noconfig}
Do not load the personal configuration file that is usually located at
@code{~/.config/avrdude/avrdude.rc}, @code{~/.avrduderc} or in the same
directory as the avrdude executable.
Expand All @@ -654,8 +662,9 @@ The popular Arduino bootloader exhibits this behaviour; for this reason
@code{-A} is engaged by default when specifying @code{-c} arduino.

@item -D
@cindex Option @code{-D}
@cindex @code{-D}
@item --noerase
@cindex Option @code{-D, --noerase}
@cindex @code{-D, --noerase}
@cindex @code{flash}
Disable auto-erase for flash. When the @code{-U} option for writing to any
flash memory is specified, avrdude will perform a chip erase before
Expand All @@ -668,8 +677,9 @@ page not affected by the current operation will retain its previous
contents. Setting @code{-D} implies @code{-A}.

@item -e
@cindex Option @code{-e}
@cindex @code{-e}
@item --erase
@cindex Option @code{-e, --erase}
@cindex @code{-e, --erase}
@cindex @code{flash}
@cindex @code{eeprom}
Causes a chip erase to be executed. This will reset the contents of the
Expand Down Expand Up @@ -746,22 +756,25 @@ microsecond is assumed that might be off a bit for very fast or very
slow machines.

@item -l @var{logfile}
@cindex Option @code{-l} @var{logfile}
@cindex @code{-l} @var{logfile}
@item --logfile @var{logfile}
@cindex Option @code{-l, --logfile} @var{logfile}
@cindex @code{-l, --logfile} @var{logfile}
Use @var{logfile} rather than @var{stderr} for diagnostics output.
Note that initial diagnostic messages (during option parsing) are still
written to @var{stderr} anyway.

@item -n
@cindex Option @code{-n}
@cindex @code{-n}
@item --test
@cindex Option @code{-n, --test}
@cindex @code{-n, --test}
No-write: disables writing data to the MCU whilst processing @code{-U}
(useful for debugging AVRDUDE). The terminal mode continues to write to
the device.

@item -O
@cindex Option @code{-O}
@cindex @code{-O}
@item --osccal
@cindex Option @code{-O, --osccal}
@cindex @code{-O, --osccal}
@cindex @code{calibration}
Perform a RC oscillator run-time calibration according to Atmel
application note AVR053.
Expand All @@ -771,8 +784,9 @@ hardware.
Note that the result will be stored in the EEPROM cell at address 0.

@item -P @var{port}
@cindex Option @code{-P} @var{port}
@cindex @code{-P} @var{port}
@item --port @var{port}
@cindex Option @code{-P, --port} @var{port}
@cindex @code{-P, --port} @var{port}

Use @var{port} to identify the connection through which the programmer is
attached. This can be a parallel, serial, spi or linuxgpio connection. The
Expand Down Expand Up @@ -858,8 +872,9 @@ Note: The ability to handle IPv6 hostnames and addresses is limited to
Posix systems (by now).

@item -r
@cindex Option @code{-r}
@cindex @code{-r}
@item --reconnect
@cindex Option @code{-r, --reconnect}
@cindex @code{-r, --reconnect}
Opens the serial port at 1200 baud and immediately closes it, waits 400 ms
for each @code{-r} on the command line and then establishes communication
with the programmer. This is commonly known as a "1200bps touch", and is
Expand All @@ -869,8 +884,9 @@ therefore multiple @code{-r} options, are sometimes needed for slower, less
powerful hosts.

@item -q
@cindex Option @code{-q}
@cindex @code{-q}
@item --quell
@cindex Option @code{-q, --quell}
@cindex @code{-q, --quell}
Disable (or quell) output of the progress bar while reading or writing
to the device. Specify it a second time for even quieter operation.

Expand All @@ -891,15 +907,17 @@ OS shell manual for details. See below for a detailed description of all
terminal commands.

@item -t
@cindex Option @code{-t}
@cindex @code{-t}
@item --terminal
@cindex Option @code{-t, --terminal}
@cindex @code{-t, --terminal}
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}]
@cindex Option @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
@cindex @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
@item --memory @var{memory}:@var{op}:@var{filename}[:@var{format}]
@cindex Option @code{-U, --memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]
@cindex @code{-U, --memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]

Perform a memory operation when it is its turn in relation to other
@code{-t} interactive terminals, @code{-T} terminal commands and @code{-U}
Expand Down Expand Up @@ -1075,14 +1093,16 @@ that sandwich a single character as otherwise the first part might be
interpreted as memory, and the single character as memory operation.

@item -v
@cindex Option @code{-v}
@cindex @code{-v}
@item --verbose
@cindex Option @code{-v, --verbose}
@cindex @code{-v, --verbose}
Enable verbose output.
More @code{-v} options increase verbosity level.

@item -V
@cindex Option @code{-V}
@cindex @code{-V}
@item --noverify
@cindex Option @code{-V, --noverify}
@cindex @code{-V, --noverify}
Disable automatic verify check when writing data to the AVR with @code{-U}.

@item -x @var{extended_param}
Expand Down Expand Up @@ -2095,12 +2115,6 @@ verbosity level:
@cartouche
$ avrdude -c jtag2 -p m128 -P usb:xxx -v
Avrdude version 7.3-20240815 (e230d889)
Copyright see https://github.com/avrdudes/avrdude/blob/main/AUTHORS
System wide configuration file is /usr/local/etc/avrdude.conf
User configuration file is /home/srueger/.avrduderc
Using port : usb:xxx
Using programmer : jtag2fast
Programmer baud rate : 115200
Expand Down

0 comments on commit 6ba5044

Please sign in to comment.