Skip to content

Commit 6ba5044

Browse files
authored
Add longopts to texinfo document
1 parent 2b0eced commit 6ba5044

File tree

1 file changed

+60
-46
lines changed

1 file changed

+60
-46
lines changed

src/doc/avrdude.texi

Lines changed: 60 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -509,8 +509,9 @@ following options are recognized:
509509

510510
@table @code
511511
@item -p @var{partno}
512-
@cindex Option @code{-p} @var{partno}
513-
@cindex @code{-p} @var{partno}
512+
@item --part @var{partno}
513+
@cindex Option @code{-p ,--part} @var{partno}
514+
@cindex @code{-p, --part} @var{partno}
514515

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

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

543545
@item -b @var{baudrate}
544-
@cindex Option @code{-b} @var{baudrate}
545-
@cindex @code{-b} @var{baudrate}
546+
@item --baud @var{baudrate}
547+
@cindex Option @code{-b, --baud} @var{baudrate}
548+
@cindex @code{-b, baud} @var{baudrate}
546549
Override the RS-232 connection baud rate specified in the respective
547550
programmer's @code{baudrate} entry of the configuration file
548551
or defined by the @code{default_baudrate} entry in your
549552
@code{~/.config/avrdude/avrdude.rc} or @code{~/.avrduderc} configuration
550553
file if no @code{baudrate} entry was provided for this programmer.
551554

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

579583
@item -c @var{programmer-id}
580-
@cindex Option @code{-c} @var{programmer-id}
581-
@cindex @code{-c} @var{programmer-id}
584+
@item --programmer @var{programmer-id}
585+
@cindex Option @code{-c, --programmer} @var{programmer-id}
586+
@cindex @code{-c, --programmer} @var{programmer-id}
582587

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

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

606612
@item -C @var{config-file}
607-
@cindex Option @code{-C} @var{config-file}
608-
@cindex @code{-C} @var{config-file}
613+
@item --config @var{config-file}
614+
@cindex Option @code{-C, --config} @var{config-file}
615+
@cindex @code{-C, --config} @var{config-file}
609616
@cindex Configuration files
610617
Use the specified config file for configuration data. This file
611618
contains all programmer and part definitions that AVRDUDE knows about.
@@ -634,8 +641,9 @@ several times, the files are read in same order as given on the command
634641
line.
635642

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

656664
@item -D
657-
@cindex Option @code{-D}
658-
@cindex @code{-D}
665+
@item --noerase
666+
@cindex Option @code{-D, --noerase}
667+
@cindex @code{-D, --noerase}
659668
@cindex @code{flash}
660669
Disable auto-erase for flash. When the @code{-U} option for writing to any
661670
flash memory is specified, avrdude will perform a chip erase before
@@ -668,8 +677,9 @@ page not affected by the current operation will retain its previous
668677
contents. Setting @code{-D} implies @code{-A}.
669678

670679
@item -e
671-
@cindex Option @code{-e}
672-
@cindex @code{-e}
680+
@item --erase
681+
@cindex Option @code{-e, --erase}
682+
@cindex @code{-e, --erase}
673683
@cindex @code{flash}
674684
@cindex @code{eeprom}
675685
Causes a chip erase to be executed. This will reset the contents of the
@@ -746,22 +756,25 @@ microsecond is assumed that might be off a bit for very fast or very
746756
slow machines.
747757

748758
@item -l @var{logfile}
749-
@cindex Option @code{-l} @var{logfile}
750-
@cindex @code{-l} @var{logfile}
759+
@item --logfile @var{logfile}
760+
@cindex Option @code{-l, --logfile} @var{logfile}
761+
@cindex @code{-l, --logfile} @var{logfile}
751762
Use @var{logfile} rather than @var{stderr} for diagnostics output.
752763
Note that initial diagnostic messages (during option parsing) are still
753764
written to @var{stderr} anyway.
754765

755766
@item -n
756-
@cindex Option @code{-n}
757-
@cindex @code{-n}
767+
@item --test
768+
@cindex Option @code{-n, --test}
769+
@cindex @code{-n, --test}
758770
No-write: disables writing data to the MCU whilst processing @code{-U}
759771
(useful for debugging AVRDUDE). The terminal mode continues to write to
760772
the device.
761773

762774
@item -O
763-
@cindex Option @code{-O}
764-
@cindex @code{-O}
775+
@item --osccal
776+
@cindex Option @code{-O, --osccal}
777+
@cindex @code{-O, --osccal}
765778
@cindex @code{calibration}
766779
Perform a RC oscillator run-time calibration according to Atmel
767780
application note AVR053.
@@ -771,8 +784,9 @@ hardware.
771784
Note that the result will be stored in the EEPROM cell at address 0.
772785

773786
@item -P @var{port}
774-
@cindex Option @code{-P} @var{port}
775-
@cindex @code{-P} @var{port}
787+
@item --port @var{port}
788+
@cindex Option @code{-P, --port} @var{port}
789+
@cindex @code{-P, --port} @var{port}
776790

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

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

871886
@item -q
872-
@cindex Option @code{-q}
873-
@cindex @code{-q}
887+
@item --quell
888+
@cindex Option @code{-q, --quell}
889+
@cindex @code{-q, --quell}
874890
Disable (or quell) output of the progress bar while reading or writing
875891
to the device. Specify it a second time for even quieter operation.
876892

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

893909
@item -t
894-
@cindex Option @code{-t}
895-
@cindex @code{-t}
910+
@item --terminal
911+
@cindex Option @code{-t, --terminal}
912+
@cindex @code{-t, --terminal}
896913
Tells AVRDUDE to run an interactive terminal when it is its turn in
897914
relation to other @code{-t} interactive terminals, @code{-T}
898915
terminal commands and @code{-U} memory operations.
899916

900917
@item -U @var{memory}:@var{op}:@var{filename}[:@var{format}]
901-
@cindex Option @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
902-
@cindex @code{-U} @var{memory}:@var{op}:@var{filename}[:@var{format}]
918+
@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}]
903921

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

10771095
@item -v
1078-
@cindex Option @code{-v}
1079-
@cindex @code{-v}
1096+
@item --verbose
1097+
@cindex Option @code{-v, --verbose}
1098+
@cindex @code{-v, --verbose}
10801099
Enable verbose output.
10811100
More @code{-v} options increase verbosity level.
10821101

10831102
@item -V
1084-
@cindex Option @code{-V}
1085-
@cindex @code{-V}
1103+
@item --noverify
1104+
@cindex Option @code{-V, --noverify}
1105+
@cindex @code{-V, --noverify}
10861106
Disable automatic verify check when writing data to the AVR with @code{-U}.
10871107

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

0 commit comments

Comments
 (0)