Skip to content

Commit fdb76f3

Browse files
committed
Add more options to the content index list
1 parent 0c2c03f commit fdb76f3

File tree

1 file changed

+80
-43
lines changed

1 file changed

+80
-43
lines changed

src/doc/avrdude.texi

Lines changed: 80 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -510,9 +510,10 @@ following options are recognized:
510510
@table @code
511511
@item -p @var{partname}
512512
@item --part @var{partname}
513-
@cindex Option @code{-p ,--part} @var{partname}
514-
@cindex @code{-p, --part} @var{partname}
515-
513+
@cindex Option @code{-p} @var{partname}
514+
@cindex Option @code{--part} @var{partname}
515+
@cindex @code{-p} @var{partname}
516+
@cindex @code{--part} @var{partname}
516517
This option tells AVRDUDE what part (MCU) is connected to the programmer.
517518
The @var{partname} parameter is the part's id listed in the configuration
518519
file. To see a list of currently supported MCUs use @code{?} as partname,
@@ -535,17 +536,21 @@ listing of supported parts.
535536

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

545548
@item -b @var{baudrate}
546549
@item --baud @var{baudrate}
547-
@cindex Option @code{-b, --baud} @var{baudrate}
548-
@cindex @code{-b, baud} @var{baudrate}
550+
@cindex Option @code{-b} @var{baudrate}
551+
@cindex Option @code{--baud} @var{baudrate}
552+
@cindex @code{-b} @var{baudrate}
553+
@cindex @code{--baud} @var{baudrate}
549554
Override the RS-232 connection baud rate specified in the respective
550555
programmer's @code{baudrate} entry of the configuration file
551556
or defined by the @code{default_baudrate} entry in your
@@ -554,8 +559,10 @@ file if no @code{baudrate} entry was provided for this programmer.
554559

555560
@item -B @var{bitclock}
556561
@item --bitclock @var{bitclock}
557-
@cindex Option @code{-B, --bitclock} @var{bitclock}
558-
@cindex @code{-B, --bitclock} @var{bitclock}
562+
@cindex Option @code{-B} @var{bitclock}
563+
@cindex Option @code{--bitclock} @var{bitclock}
564+
@cindex @code{-B} @var{bitclock}
565+
@cindex @code{--bitclock} @var{bitclock}
559566
Specify the bit clock period for the JTAG, PDI, TPI, UPDI, or ISP
560567
interface. The value is a floating-point number in microseconds.
561568
Alternatively, the value might be suffixed with Hz, kHz or
@@ -582,9 +589,10 @@ the computer.
582589

583590
@item -c @var{programmer-id}
584591
@item --programmer @var{programmer-id}
585-
@cindex Option @code{-c, --programmer} @var{programmer-id}
586-
@cindex @code{-c, --programmer} @var{programmer-id}
587-
592+
@cindex Option @code{-c} @var{programmer-id}
593+
@cindex Option @code{--programmer} @var{programmer-id}
594+
@cindex @code{-c} @var{programmer-id}
595+
@cindex @code{--programmer} @var{programmer-id}
588596
Specify the programmer to be used. AVRDUDE knows about quite a few
589597
programmers. The @var{programmer-id} parameter is the programmer's id
590598
listed in the configuration file. Specify @code{-c ?} to list all
@@ -602,17 +610,21 @@ of known programmers.
602610

603611
@item -c @var{wildcard/flags}
604612
@item --programmer @var{wildcard/flags}
605-
@cindex Option @code{-c, --programmer} @var{wildcard/flags}
606-
@cindex @code{-c, --programmer} @var{wildcard/flags}
613+
@cindex Option @code{-c} @var{wildcard/flags}
614+
@cindex Option @code{--programmer} @var{wildcard/flags}
615+
@cindex @code{-c} @var{wildcard/flags}
616+
@cindex @code{--programmer} @var{wildcard/flags}
607617
Run developer options for programmers that are matched by @var{wildcard}.
608618
Whilst their main use is for developers some @var{flags} can be of utility
609619
for users, e.g., @code{avrdude -c usbtiny/S} shows AVRDUDE's understanding of
610620
usbtiny's properties; for more information run @code{avrdude -c x/h}.
611621

612622
@item -C @var{config-file}
613623
@item --config @var{config-file}
614-
@cindex Option @code{-C, --config} @var{config-file}
615-
@cindex @code{-C, --config} @var{config-file}
624+
@cindex Option @code{-c} @var{config-file}
625+
@cindex Option @code{--config} @var{config-file}
626+
@cindex @code{-C} @var{config-file}
627+
@cindex @code{--config} @var{config-file}
616628
@cindex Configuration files
617629
Use the specified config file for configuration data. This file
618630
contains all programmer and part definitions that AVRDUDE knows about.
@@ -642,8 +654,10 @@ line.
642654

643655
@item -N
644656
@item --noconfig
645-
@cindex Option @code{-N, --noconfig}
646-
@cindex @code{-N, --noconfig}
657+
@cindex Option @code{-N}
658+
@cindex Option @code{--noconfig}
659+
@cindex @code{-N}
660+
@cindex @code{--noconfig}
647661
Do not load the personal configuration file that is usually located at
648662
@code{~/.config/avrdude/avrdude.rc}, @code{~/.avrduderc} or in the same
649663
directory as the avrdude executable.
@@ -663,8 +677,10 @@ The popular Arduino bootloader exhibits this behaviour; for this reason
663677

664678
@item -D
665679
@item --noerase
666-
@cindex Option @code{-D, --noerase}
667-
@cindex @code{-D, --noerase}
680+
@cindex Option @code{-D}
681+
@cindex Option @code{--noerase}
682+
@cindex @code{-D}
683+
@cindex @code{--noerase}
668684
@cindex @code{flash}
669685
Disable auto-erase for flash. When the @code{-U} option for writing to any
670686
flash memory is specified, avrdude will perform a chip erase before
@@ -678,8 +694,10 @@ contents. Setting @code{-D} implies @code{-A}.
678694

679695
@item -e
680696
@item --erase
681-
@cindex Option @code{-e, --erase}
682-
@cindex @code{-e, --erase}
697+
@cindex Option @code{-e}
698+
@cindex Option @code{--erase}
699+
@cindex @code{-e}
700+
@cindex @code{--erase}
683701
@cindex @code{flash}
684702
@cindex @code{eeprom}
685703
Causes a chip erase to be executed. This will reset the contents of the
@@ -757,24 +775,30 @@ slow machines.
757775

758776
@item -l @var{logfile}
759777
@item --logfile @var{logfile}
760-
@cindex Option @code{-l, --logfile} @var{logfile}
761-
@cindex @code{-l, --logfile} @var{logfile}
778+
@cindex Option @code{-l} @var{logfile}
779+
@cindex Option @code{--logfile} @var{logfile}
780+
@cindex @code{-l} @var{logfile}
781+
@cindex @code{--logfile} @var{logfile}
762782
Use @var{logfile} rather than @var{stderr} for diagnostics output.
763783
Note that initial diagnostic messages (during option parsing) are still
764784
written to @var{stderr} anyway.
765785

766786
@item -n
767787
@item --test-memory
768-
@cindex Option @code{-n, --test-memory}
769-
@cindex @code{-n, --test-memory}
788+
@cindex Option @code{-n}
789+
@cindex Option @code{--test-memory}
790+
@cindex @code{-n}
791+
@cindex @code{--test-memory}
770792
No-write: disables writing data to the MCU whilst processing @code{-U}
771793
(useful for debugging AVRDUDE). The terminal mode continues to write to
772794
the device.
773795

774796
@item -O
775797
@item --osccal
776-
@cindex Option @code{-O, --osccal}
777-
@cindex @code{-O, --osccal}
798+
@cindex Option @code{-O}
799+
@cindex Option @code{--osccal}
800+
@cindex @code{-O}
801+
@cindex @code{--osccal}
778802
@cindex @code{calibration}
779803
Perform a RC oscillator run-time calibration according to Atmel
780804
application note AVR053.
@@ -785,9 +809,10 @@ Note that the result will be stored in the EEPROM cell at address 0.
785809

786810
@item -P @var{port}
787811
@item --port @var{port}
788-
@cindex Option @code{-P, --port} @var{port}
789-
@cindex @code{-P, --port} @var{port}
790-
812+
@cindex Option @code{-P} @var{port}
813+
@cindex Option @code{--port} @var{port}
814+
@cindex @code{-P} @var{port}
815+
@cindex @code{--port} @var{port}
791816
Use @var{port} to identify the connection through which the programmer is
792817
attached. This can be a parallel, serial, spi or linuxgpio connection. The
793818
programmer normally specifies the connection type; in absence of a @code{-P}
@@ -873,8 +898,10 @@ Posix systems (by now).
873898

874899
@item -r
875900
@item --reconnect
876-
@cindex Option @code{-r, --reconnect}
877-
@cindex @code{-r, --reconnect}
901+
@cindex Option @code{-r}
902+
@cindex Option @code{--reconnect}
903+
@cindex @code{-r}
904+
@cindex @code{--reconnect}
878905
Opens the serial port at 1200 baud and immediately closes it, waits 400 ms
879906
for each @code{-r} on the command line and then establishes communication
880907
with the programmer. This is commonly known as a "1200bps touch", and is
@@ -885,8 +912,10 @@ powerful hosts.
885912

886913
@item -q
887914
@item --quell
888-
@cindex Option @code{-q, --quell}
889-
@cindex @code{-q, --quell}
915+
@cindex Option @code{-q}
916+
@cindex Option @code{--quell}
917+
@cindex @code{-q}
918+
@cindex @code{--quell}
890919
Disable (or quell) output of the progress bar while reading or writing
891920
to the device. Specify it a second time for even quieter operation.
892921

@@ -908,16 +937,20 @@ terminal commands.
908937

909938
@item -t
910939
@item --terminal
911-
@cindex Option @code{-t, --terminal}
912-
@cindex @code{-t, --terminal}
940+
@cindex Option @code{-t}
941+
@cindex Option @code{--terminal}
942+
@cindex @code{-t}
943+
@cindex @code{--terminal}
913944
Tells AVRDUDE to run an interactive terminal when it is its turn in
914945
relation to other @code{-t} interactive terminals, @code{-T}
915946
terminal commands and @code{-U} memory operations.
916947

917948
@item -U @var{memory}:@var{op}:@var{filename}[:@var{format}]
918949
@item --memory @var{memory}:@var{op}:@var{filename}[:@var{format}]
919-
@cindex Option @code{-U, --memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]
920-
@cindex @code{-U, --memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]
950+
@cindex Option @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
951+
@cindex Option @code{--memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]
952+
@cindex @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
953+
@cindex @code{--memory} @var{memory}:@var{op}:@var{filename}[:@var{format}]
921954

922955
Perform a memory operation when it is its turn in relation to other
923956
@code{-t} interactive terminals, @code{-T} terminal commands and @code{-U}
@@ -1094,15 +1127,19 @@ interpreted as memory, and the single character as memory operation.
10941127

10951128
@item -v
10961129
@item --verbose
1097-
@cindex Option @code{-v, --verbose}
1098-
@cindex @code{-v, --verbose}
1130+
@cindex Option @code{-v}
1131+
@cindex Option @code{--verbose}
1132+
@cindex @code{-v}
1133+
@cindex @code{--verbose}
10991134
Enable verbose output.
11001135
More @code{-v} options increase verbosity level.
11011136

11021137
@item -V
11031138
@item --noverify-memory
1104-
@cindex Option @code{-V, --noverify-memory}
1105-
@cindex @code{-V, --noverify-memory}
1139+
@cindex Option @code{-V}
1140+
@cindex Option @code{--noverify-memory}
1141+
@cindex @code{-V}
1142+
@cindex @code{--noverify-memory}
11061143
Disable automatic verify check when writing data to the AVR with @code{-U}.
11071144

11081145
@item -x @var{extended_param}

0 commit comments

Comments
 (0)