Try making the cindex (concept index) meaningful

Rearrange existing @cindex entries, add a lot of new ones.
This commit is contained in:
Joerg Wunsch
2022-03-18 00:04:17 +01:00
parent 31feb9ff75
commit 0c912a201f
44 changed files with 26 additions and 7678 deletions

View File

@@ -119,7 +119,7 @@ Copyright @copyright{} Brian S. Dean, J@"org Wunsch
@node Introduction, Command Line Options, Top, Top
@comment node-name, next, previous, up
@chapter Introduction
@cindex introduction
@cindex Introduction
AVRDUDE - AVR Downloader Uploader - is a program for downloading and
uploading the on-chip memories of Atmel's AVR microcontrollers. It can
@@ -137,6 +137,8 @@ from the contents of a file, while interactive mode is useful for
exploring memory contents, modifying individual bytes of eeprom,
programming fuse/lock bits, etc.
@cindex Programmers supported
AVRDUDE supports the following basic programmer types: Atmel's STK500,
Atmel's AVRISP and AVRISP mkII devices,
Atmel's STK600,
@@ -337,6 +339,7 @@ below for Teensy specific options.
@c Node
@c
@node History, , Introduction, Introduction
@cindex History
@section History and Credits
AVRDUDE was written by Brian S. Dean under the name of AVRPROG to run on
@@ -368,7 +371,6 @@ Roth.
@c
@node Command Line Options, Terminal Mode Operation, Introduction, Top
@chapter Command Line Options
@cindex options
@menu
* Option Descriptions::
@@ -380,6 +382,7 @@ Roth.
@c Node
@c
@node Option Descriptions, Programmers accepting extended parameters, Command Line Options, Command Line Options
@cindex Options (command-line)
@section Option Descriptions
@noindent
@@ -404,6 +407,8 @@ but it can be added to the configuration file if you have the Atmel
datasheet so that you can enter the programming specifications.
Currently, the following MCU types are understood:
@cindex Device support
@multitable @columnfractions .15 .3
@include parts.texi
@end multitable
@@ -455,6 +460,8 @@ file without any code changes to AVRDUDE. Simply copy an existing entry
and change the pin definitions to match that of the unknown programmer.
Currently, the following programmer ids are understood and supported:
@cindex Programmer support
@multitable @columnfractions .2 .6
@include programmers.texi
@end multitable
@@ -832,7 +839,7 @@ accepting extended parameters.
@c
@node Programmers accepting extended parameters, Example Command Line Invocations, Option Descriptions, Command Line Options
@section Programmers accepting extended parameters
@cindex @code{-x} AVR Dragon
@table @code
@item JTAG ICE mkII/3
@@ -849,6 +856,7 @@ Each AVR unit within the chain shifts by 4 bits.
Other JTAG units might require a different bit shift count.
@end table
@cindex @code{-x} AVR910
@item AVR910
The AVR910 programmer type accepts the following extended parameter:
@@ -869,6 +877,7 @@ Use
programmer creates errors during initial sequence.
@end table
@cindex @code{-x} Arduino
@item Arduino
The Arduino programmer type accepts the following extended parameter:
@@ -877,6 +886,7 @@ The Arduino programmer type accepts the following extended parameter:
Overide the default number of connection retry attempt by using @var{VALUE}.
@end table
@cindex @code{-x} Buspirate
@item BusPirate
The BusPirate programmer type accepts the following extended parameters:
@@ -966,6 +976,7 @@ The default value is 100ms. Using 10ms might work in most cases.
@end table
@cindex @code{-x} Micronucleus bootloader
@item Micronucleus bootloader
When using the Micronucleus programmer type, the
@@ -978,6 +989,7 @@ If no time-out is specified, AVRDUDE will wait indefinitely until the
device is plugged in.
@end table
@cindex @code{-x} Teensy bootloader
@item Teensy bootloader
When using the Teensy programmer type, the
@@ -990,6 +1002,7 @@ If no time-out is specified, AVRDUDE will wait indefinitely until the
device is plugged in.
@end table
@cindex @code{-x} Wiring
@item Wiring
When using the Wiring programmer type, the
@@ -1001,6 +1014,7 @@ After performing the port open phase, AVRDUDE will wait/snooze for
No toggling of DTR/RTS is performed if @var{snooze} > 0.
@end table
@cindex @code{-x} PICkit2
@item PICkit2
Connection to the PICkit2 programmer:
@multitable @columnfractions .05 .3
@@ -1021,6 +1035,7 @@ Sets the SPI clocking rate in Hz (default is 100kHz). Alternately the -B or -i o
Sets the timeout for USB reads and writes in milliseconds (default is 1500 ms).
@end table
@cindex @code{-x} USBasp
@item USBasp
Extended parameters:
@table @code
@@ -1031,6 +1046,7 @@ rather than entire chip.
Only applicable to TPI devices (ATtiny 4/5/9/10/20/40).
@end table
@cindex @code{-x} xbee
@item xbee
Extended parameters:
@table @code
@@ -1047,6 +1063,7 @@ The remaining two necessary XBee-to-MCU connections are not selectable
the MCU's TXD line.
@end table
@cindex @code{-x} serialupdi
@item serialupdi
Extended parameters:
@table @code
@@ -1249,6 +1266,7 @@ commands can be recalled and edited.
@end menu
@node Terminal Mode Commands, Terminal Mode Examples, Terminal Mode Operation, Terminal Mode Operation
@cindex Terminal Mode
@section Terminal Mode Commands
@noindent
@@ -1554,6 +1572,8 @@ avrdude> q
@c Node
@c
@node Configuration File, Programmer Specific Information, Terminal Mode Operation, Top
@cindex Configuration File
@cindex @code{avrdude.conf}
@chapter Configuration File
@noindent
@@ -1916,6 +1936,7 @@ Reading fuse and lock bits is fully supported.
@c Node
@c
@node Atmel STK600, Atmel DFU bootloader using FLIP version 1, Programmer Specific Information, Programmer Specific Information
@cindex STK600
@section Atmel STK600
@c
@@ -2012,6 +2033,7 @@ least 4.5 V in order to work. This can be done using
@c Node
@c
@node Atmel DFU bootloader using FLIP version 1, SerialUPDI programmer , Atmel STK600, Programmer Specific Information
@cindex DFU bootloader
@section Atmel DFU bootloader using FLIP version 1
Bootloaders using the FLIP protocol version 1 experience some very
@@ -2040,6 +2062,7 @@ versions of the bootloader.
@c Node
@c
@node SerialUPDI programmer, , Atmel DFU bootloader using FLIP version 1, Programmer Specific Information
@cindex SerialUPDI
@section SerialUPDI programmer
SerialUPDI programmer can be used for programming UPDI-only devices