From db1a46c6eef45264d7987c45b7ef9f5c43884e20 Mon Sep 17 00:00:00 2001 From: hinni Date: Tue, 10 Feb 2004 00:20:51 +0000 Subject: [PATCH] * avrdude.1, doc/avrdude.texi, doc/TODO: Removed the deprecated options from documentation git-svn-id: svn://svn.savannah.nongnu.org/avrdude/trunk/avrdude@411 81a1dc3b-b13d-400b-aceb-764788c761c2 --- ChangeLog | 5 ++ avrdude.1 | 105 +++++++++------------------------------ doc/TODO | 4 +- doc/avrdude.texi | 125 ++++++++++++++++++++--------------------------- 4 files changed, 81 insertions(+), 158 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2638029c..eb96fcaa 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2004-02-10 Jan-Hinnerk Reichert + + * avrdude.1, doc/avrdude.texi, doc/TODO: + Removed the deprecated options from documentation + 2004-02-10 Jan-Hinnerk Reichert * main.c: Removed deprecated options. diff --git a/avrdude.1 b/avrdude.1 index 9a1297ec..024ddf76 100644 --- a/avrdude.1 +++ b/avrdude.1 @@ -35,11 +35,7 @@ .Oo Fl E Ar exitspec Ns .Op \&, Ns Ar exitspec .Oc -.Op Fl f Ar format .Op Fl F -.Op Fl i Ar filename -.Op Fl m Ar memtype -.Op Fl o Ar filename .Op Fl n .Op Fl P Ar port .Op Fl q @@ -189,11 +185,6 @@ option with flash memory is specified, will perform a chip erase before starting any of the programming operations, since it generally is a mistake to program the flash without performing an erase first. This option disables that. -However, to remain backward compatible, the -.Fl i , -and -.Fl m -options automatically disable the auto erase feature. .It Fl e Causes a chip erase to be executed. This will reset the contents of the flash ROM and EEPROM to the value @@ -257,32 +248,6 @@ pins of the parallel port down at program exit. Multiple .Ar exitspec arguments can be separated with commas. -.It Fl f Ar format -(Deprecated, use -.Fl U -instead.) This option specifies the file format for the input or -output files to be processed. -.Ar Format -can be one of: -.Bl -tag -width sss -.It Ar i -Intel Hex -.It Ar s -Motorola S-record -.It Ar r -raw binary; little-endian byte order, in the case of the flash ROM data -.It Ar m -immediate; actual byte values specified on the command line, seperated -by commas or spaces. This is good for programming fuse bytes without -having to create a single-byte file or enter terminal mode. -.It Ar a -auto detect; valid for input only, and only if the input is not -provided at -.Em stdin . -.El -.Pp -The default is to use auto detection for input files, and raw binary -format for output files. .It Fl F Normally, .Nm @@ -291,55 +256,10 @@ reasonable before continuing. Since it can happen from time to time that a device has a broken (erased or overwritten) device signature but is otherwise operating normally, this options is provided to override the check. -.It Fl i Ar filename -(Deprecated, use -.Fl U -instead.) Specifies the input file to be programmed into the MCU. -Can be specified as -.Ql \&- -to use -.Em stdin -as the input. -.It Fl I Ar data -(Deprecated, use -.Fl U -instead.) Same as specifying -.Fl i -and -.Fl f Ar m -together, i.e., this is a shortcut for using immediate file input mode -where the filename field is used as the data itself. Useful for -programming single byte memories such as fuse bytes without having to -use single byte files or enter interactive terminal mode. -.It Fl m Ar memtype -(Deprecated, use -.Fl U -instead.) Specifies which program area of the MCU to read or write; -allowable values depend on the MCU being programmed, but most support -at least -.Em eeprom -for the EEPROM, and -.Em flash -for the flash ROM. Use the -.Fl v -option on the command line or the -.Ar part -command from terminal mode to display all the memory types supported -by a particular device. The default is -.Em flash . .It Fl n No-write - disables actually writing data to the MCU (useful for debugging .Nm avrdude ). -.It Fl o Ar filename -(Deprecated, use -.Fl U -instead.) Specifies the name of the output file to write, and causes -the respective memory area to be read from the MCU. Can be specified -as -.Ql \&- -to write to -.Em stdout . .It Fl P Ar port Use .Ar port @@ -384,9 +304,28 @@ field indicates the name of the file to read or write. The .Ar format field is optional and contains the format of the file to read or -write. See the -.Fl f -option for possible values. +write. +.Ar Format +can be one of: +.Bl -tag -width sss +.It Ar i +Intel Hex +.It Ar s +Motorola S-record +.It Ar r +raw binary; little-endian byte order, in the case of the flash ROM data +.It Ar m +immediate; actual byte values specified on the command line, seperated +by commas or spaces. This is good for programming fuse bytes without +having to create a single-byte file or enter terminal mode. +.It Ar a +auto detect; valid for input only, and only if the input is not +provided at +.Em stdin . +.El +.Pp +The default is to use auto detection for input files, and raw binary +format for output files. Note that if .Ar filename contains a colon, the diff --git a/doc/TODO b/doc/TODO index cb650fdc..76eebd95 100644 --- a/doc/TODO +++ b/doc/TODO @@ -4,11 +4,9 @@ - Website needs to link to docs: http://savannah.nongnu.org/download/avrdude/doc/avrdude-html/ -- Remove old options from manpage and texinfo-documentation - - [Windows Port] Use Windows API for serial port communications (ser_win32.c). (In Progress) - + - Add "skip empty pages" optimization on avr910 paged write. The stk500 has this optimization already. diff --git a/doc/avrdude.texi b/doc/avrdude.texi index a11002b3..a953b16e 100644 --- a/doc/avrdude.texi +++ b/doc/avrdude.texi @@ -420,10 +420,60 @@ program exit. Multiple @var{exitspec} arguments can be separated with commas. +@item -F +Normally, AVRDUDE tries to verify that the device signature read from +the part is reasonable before continuing. Since it can happen from time +to time that a device has a broken (erased or overwritten) device +signature but is otherwise operating normally, this options is provided +to override the check. -@item -f @var{format} -This option specifies the file format for the input or output files to -be processed. Format can be one of: +@item -n +No-write - disables actually writing data to the MCU (useful for +debugging AVRDUDE). + +@item -P @var{port} +Use port to identify the device to which the programmer is attached. +Normally, the default parallel port is used, but if the programmer type +normally connects to the serial port, the default serial port will be +used. See Appendix A, Platform Dependent Information, to find out the +default port names for your platform. If you need to use a different +parallel or serial port, use this option to specify the alternate port name. + +@item -q +Disable (or quell) output of the progress bar while reading or writing +to the device. + +@item -t +Tells AVRDUDE to enter the interactive ``terminal'' mode instead of up- +or downloading files. See below for a detailed description of the +terminal mode. + +@item -U @var{memtype}:@var{op}:@var{filename}[:@var{format}] +Perform a memory operation, equivalent to specifing the @option{-m}, +@option{-i} or @option{-o}, and @option{-f} options, except that +multiple @option{-U} optins can be specified in order to operate on +mulitple memories on the same command-line invocation. The +@var{memtype} field specifies the memory type to operate on. Use +the @option{-v} option on the command line or the @code{part} command from +terminal mode to display all the memory types supported by a particular +device. +The @var{op} field specifies what operation to perform: + +@table @code +@itemx r +read the specified device memory and write to the specified file + +@itemx w +read the specified file and write it to the specified device memory + +@itemx v +read the specified device memory and the specified file and perform a verify operation + +@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 file to read or write. Possible values are: @table @code @itemx i @@ -454,75 +504,6 @@ at stdin. The default is to use auto detection for input files, and raw binary format for output files. -@item -F -Normally, AVRDUDE tries to verify that the device signature read from -the part is reasonable before continuing. Since it can happen from time -to time that a device has a broken (erased or overwritten) device -signature but is otherwise operating normally, this options is provided -to override the check. - -@item -i @var{filename} -Specifies the input file to be programmed into the MCU. Can be -specified as `-' to use stdin as the input. - -@item -m @var{memtype} -Specifies which program area of the MCU to read or write; allowable -values depend on the MCU being programmed, but most support at least -@code{eeprom} for the EEPROM, and @code{flash} for the flash ROM. Use -the @option{-v} option on the command line or the @code{part} command from -terminal mode to display all the memory types supported by a particular -device. The default is @code{flash}. - -@item -n -No-write - disables actually writing data to the MCU (useful for -debugging AVRDUDE). - -@item -o @var{filename} -Specifies the name of the output file to write, and causes the -respective memory area to be read from the MCU. Can be specified as `-' -to write to stdout. - -@item -P @var{port} -Use port to identify the device to which the programmer is attached. -Normally, the default parallel port is used, but if the programmer type -normally connects to the serial port, the default serial port will be -used. See Appendix A, Platform Dependent Information, to find out the -default port names for your platform. If you need to use a different -parallel or serial port, use this option to specify the alternate port name. - -@item -q -Disable (or quell) output of the progress bar while reading or writing -to the device. - -@item -t -Tells AVRDUDE to enter the interactive ``terminal'' mode instead of up- -or downloading files. See below for a detailed description of the -terminal mode. - -@item -U @var{memtype}:@var{op}:@var{filename}[:@var{format}] -Perform a memory operation, equivalent to specifing the @option{-m}, -@option{-i} or @option{-o}, and @option{-f} options, except that -multiple @option{-U} optins can be specified in order to operate on -mulitple memories on the same command-line invocation. The -@var{memtype} field specifies the memory type to operate on. The -@var{op} field specifies what operation to perform: - -@table @code -@itemx r -read the specified device memory and write to the specified file - -@itemx w -read the specified file and write it to the specified device memory - -@itemx v -read the specified device memory and the specified file and perform a verify operation - -@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 file to read or write. See the @option{-f} option for possible -values. Note that if @var{filename} contains a colon, the @var{format} field is no longer optional since the filename part following the colon would otherwise be misinterpreted as @var{format}.