2003-03-10 Theodore A. Roth * doc/avrdude.texi: Add comment before each node to make them stand out better. Use @option{} command for options instead of @code{}. Merge FreeBSD and Linux platform dependent information. Index: doc/avrdude.texi =================================================================== RCS file: /cvsroot/avrdude/avrdude/doc/avrdude.texi,v retrieving revision 1.5 diff -u -r1.5 avrdude.texi --- doc/avrdude.texi 6 Mar 2003 21:46:20 -0000 1.5 +++ doc/avrdude.texi 10 Mar 2003 19:43:53 -0000 @@ -103,6 +103,9 @@ * Platform Dependent Information:: @end menu address@hidden address@hidden Node address@hidden @node Introduction, Command Line Options, Top, Top @comment node-name, next, previous, up @chapter Introduction @@ -140,6 +143,9 @@ * History:: @end menu address@hidden address@hidden Node address@hidden @node History, , Introduction, Introduction @section History @@ -165,6 +171,9 @@ Roth. address@hidden address@hidden Node address@hidden @node Command Line Options, Terminal Mode Operation, Introduction, Top @chapter Command Line Options @cindex options @@ -174,6 +183,9 @@ * Example Command Line Invocations:: @end menu address@hidden address@hidden Node address@hidden @node Option Descriptions, Example Command Line Invocations, Command Line Options, Command Line Options @section Option Descriptions @@ -357,7 +369,7 @@ 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 @code{-v} option on the command line or the @code{part} command from +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}. @@ -391,7 +403,7 @@ @item -y Tells AVRDUDE to use the last four bytes of the connected parts' EEPROM memory to track the number of times the device has been erased. When -this option is used and the @code{-e} flag is specified to generate a +this option is used and the @option{-e} flag is specified to generate a chip erase, the previous counter will be saved before the chip erase, it is then incremented, and written back after the erase cycle com- pletes. Presumably, the device would only be erased just before being @@ -411,6 +423,9 @@ @end table address@hidden address@hidden Node address@hidden @node Example Command Line Invocations, , Option Descriptions, Command Line Options @section Example Command Line Invocations @@ -467,11 +482,14 @@ @end example address@hidden address@hidden Node address@hidden @node Terminal Mode Operation, Configuration File, Command Line Options, Top @chapter Terminal Mode Operation AVRDUDE has an interactive mode called @var{terminal mode} that is -enabled by the @code{-t} option. This mode allows one to enter +enabled by the @option{-t} option. This mode allows one to enter interactive commands to display and modify the various device memories, perform a chip erase, display the device signature bytes and part parameters, and to send raw programming commands. Commands and @@ -530,6 +548,9 @@ @end table address@hidden address@hidden Node address@hidden @node Terminal Mode Examples, , Terminal Mode Commands, Terminal Mode Operation @section Terminal Mode Examples @@ -629,6 +650,9 @@ @end example address@hidden address@hidden Node address@hidden @node Configuration File, Platform Dependent Information, Terminal Mode Operation, Top @chapter Configuration File @@ -646,7 +670,7 @@ dependent location. On Unix, this is usually @code{/usr/local/etc/avrdude.conf}, while on Windows it is usally in the same location as the executable file. The name of this file can be -changed using the @code{-C} command line option. After the system wide +changed using the @option{-C} command line option. After the system wide configuration file is parsed, AVRDUDE looks for a per-user configuration file to augment or override the system wide defaults. On Unix, the per-user file is @code{.avrduderc} within the user's home directory. On @@ -660,6 +684,9 @@ * Other Notes:: @end menu address@hidden address@hidden Node address@hidden @node AVRDUDE Defaults, Programmer Definitions, Configuration File, Configuration File @section AVRDUDE Defaults @@ -667,19 +694,22 @@ @item default_parallel = "@var{default-parallel-device}"; Assign the default parallel port device. Can be overidden using the address@hidden option. address@hidden option. @item default_serial = "@var{default-serial-device}"; Assign the default serial port device. Can be overidden using the address@hidden option. address@hidden option. @item default_programmer = "@var{default-programmer-id}"; -Assign the default programmer id. Can be overidden using the @code{-c} +Assign the default programmer id. Can be overidden using the @option{-c} option. @end table address@hidden address@hidden Node address@hidden @node Programmer Definitions, Part Definitions, AVRDUDE Defaults, Configuration File @section Programmer Definitions @@ -704,6 +734,9 @@ @end example address@hidden address@hidden Node address@hidden @node Part Definitions, Other Notes, Programmer Definitions, Configuration File @section Part Definitions @@ -746,6 +779,9 @@ * Instruction Format:: @end menu address@hidden address@hidden Node address@hidden @node Instruction Format, , Part Definitions, Part Definitions @subsection Instruction Format @@ -798,6 +834,9 @@ address@hidden address@hidden Node address@hidden @node Other Notes, , Part Definitions, Configuration File @section Other Notes @@ -837,27 +876,72 @@ @end itemize address@hidden address@hidden Node address@hidden @node Platform Dependent Information, , Configuration File, Top @appendix Platform Dependent Information @menu -* FreeBSD:: -* Linux:: +* Unix:: * Windows:: @end menu address@hidden FreeBSD, Linux, Platform Dependent Information, Platform Dependent Information address@hidden FreeBSD address@hidden address@hidden Node address@hidden address@hidden Unix, Windows, Platform Dependent Information, Platform Dependent Information address@hidden Unix + address@hidden +* Unix Installation:: +* Unix Configuration Files:: +* Unix Port Names:: +* Unix Documentation:: address@hidden menu + address@hidden address@hidden Node address@hidden address@hidden Unix Installation, Unix Configuration Files, Unix, Unix address@hidden Unix Installation + address@hidden +To build and install from the source tarball on Unix like systems: + address@hidden +$ gunzip -c address@hidden | tar xf - +$ cd address@hidden +$ ./configure +$ make +$ su root -c 'make install' address@hidden example + +The default location of the install is into @code{/usr/local} so you +will need to be sure that @code{/usr/local/bin} is in your @code{PATH} +environment variable. + +If you do not have root access to your system, you can do the the +following instead: + address@hidden +$ gunzip -c address@hidden | tar xf - +$ cd address@hidden +$ ./configure --prefix=$HOME/local +$ make +$ make install address@hidden example @menu * FreeBSD Installation:: -* FreeBsd Configuration Files:: -* FreeBSD Port Names:: -* FreeBSD Documentation:: +* Linux Installation:: @end menu address@hidden FreeBSD Installation, FreeBsd Configuration Files, FreeBSD, FreeBSD address@hidden Installation address@hidden address@hidden Node address@hidden address@hidden FreeBSD Installation, Linux Installation, Unix Installation, Unix Installation address@hidden FreeBSD Installation @noindent AVRDUDE is installed via the FreeBSD Ports Tree as follows: @@ -880,72 +964,115 @@ work, since that is where the source as well as the pre-built package is obtained. address@hidden address@hidden Node address@hidden address@hidden Linux Installation, , FreeBSD Installation, Unix Installation address@hidden Linux Installation address@hidden FreeBsd Configuration Files, FreeBSD Port Names, FreeBSD Installation, FreeBSD address@hidden Configuration Files +On rpm based linux systems (such as RedHat, SUSE, Mandrake, etc), you +can build and install the rpm binaries directly from the tarball: address@hidden -The default configuration file for FreeBSD is located at address@hidden/usr/local/etc/avrdude.conf}. This can be changed by using the address@hidden command line option. Additionally, the user's home directory -is search for a file named @code{.avrduderc}, and if found, is used to -augment the system default configuration file. - address@hidden FreeBSD Port Names, FreeBSD Documentation, FreeBsd Configuration Files, FreeBSD address@hidden Port Names address@hidden +$ su - root +# rpmbuild -tb address@hidden +# rpm -Uvh /usr/src/redhat/RPMS/i386/address@hidden address@hidden example address@hidden -AVRDUDE uses the FreeBSD ppi(4) interface for accessing the parallel -port and the sio(4) driver for serial port access. The default name -used for the parallel port is @code{/dev/ppi0}, while the default serial -port device is @code{/dev/cuaa0}. +Note that the path to the resulting rpm package, differs from system +to system. The above example is specific to RedHat. address@hidden FreeBSD Documentation, , FreeBSD Port Names, FreeBSD address@hidden Documentation address@hidden address@hidden Node address@hidden address@hidden Unix Configuration Files, Unix Port Names, Unix Installation, Unix address@hidden Unix Configuration Files @noindent -AVRDUDE installs a manual page as well as HTML and PDF documentation. -The manual page is installed in @code{/usr/local/man/man1} area, while -the HTML and PDF documentation is installed in address@hidden/usr/local/share/doc/avrdude} directory. - - address@hidden Linux, Windows, FreeBSD, Platform Dependent Information address@hidden Linux +When AVRDUDE is build using the default @option{--prefix} configure +option, the default configuration file for a Unix system is located at address@hidden/usr/local/etc/avrdude.conf}. This can be overridden by using the address@hidden command line option. Additionally, the user's home directory +is searched for a file named @code{.avrduderc}, and if found, is used to +augment the system default configuration file. @menu -* Linux Installation:: +* FreeBSD Configuration Files:: * Linux Configuration Files:: -* Linux Port Names:: -* Linux Documentation:: @end menu address@hidden Linux Installation, Linux Configuration Files, Linux, Linux address@hidden Installation - address@hidden -Empty. - address@hidden Linux Configuration Files, Linux Port Names, Linux Installation, Linux address@hidden Configuration Files - address@hidden -Empty. - address@hidden Linux Port Names, Linux Documentation, Linux Configuration Files, Linux address@hidden Port Names - address@hidden -Empty. - address@hidden Linux Documentation, , Linux Port Names, Linux address@hidden Documentation - address@hidden -Empty. - - address@hidden Windows, , Linux, Platform Dependent Information address@hidden address@hidden Node address@hidden address@hidden FreeBSD Configuration Files, Linux Configuration Files, Unix Configuration Files, Unix Configuration Files address@hidden FreeBSD Configuration Files + address@hidden +When AVRUDE is installed using the FreeBSD ports system, the system +configuration file is always @code{/usr/local/etc/avrdude.conf}. + address@hidden address@hidden Node address@hidden address@hidden Linux Configuration Files, , FreeBSD Configuration Files, Unix Configuration Files address@hidden Linux Configuration Files + address@hidden +When AVRDUDE is installed using from an rpm package, the system +configuration file will be always be @code{/etc/avrdude.conf}. + address@hidden address@hidden Node address@hidden address@hidden Unix Port Names, Unix Documentation, Unix Configuration Files, Unix address@hidden Unix Port Names + address@hidden +The parallel and serial port device file names are system specific. +The following table lists the default names for a given system. + address@hidden @columnfractions .30 .30 .30 address@hidden @strong{System} + @tab @strong{Default Parallel Port} + @tab @strong{Default Serial Port} address@hidden FreeBSD + @tab @code{/dev/ppi0} + @tab @code{/dev/cuaa0} address@hidden Linux + @tab @code{/dev/parport0} + @tab @code{/dev/ttyS0} address@hidden multitable + address@hidden +On FreeBSD systems, AVRDUDE uses the ppi(4) interface for +accessing the parallel port and the sio(4) driver for serial port +access. + address@hidden +On Linux systems, AVRDUDE uses the ppdev interface for +accessing the parallel port and the tty driver for serial port +access. + address@hidden address@hidden Node address@hidden address@hidden Unix Documentation, , Unix Port Names, Unix address@hidden Unix Documentation + address@hidden +AVRDUDE installs a manual page as well as info, HTML and PDF +documentation. The manual page is installed in address@hidden/usr/local/man/man1} area, while the HTML and PDF documentation +is installed in @code{/usr/local/share/doc/avrdude} directory. The +info manual is installed in @code{/usr/local/info/avrdude.info}. + +Note that these locations can be altered by various configure options +such as @option{--prefix}. + address@hidden address@hidden Node address@hidden address@hidden Windows, , Unix, Platform Dependent Information @section Windows @menu @@ -957,12 +1084,18 @@ * Credits.:: @end menu address@hidden address@hidden Node address@hidden @node Windows Installation, Windows Configuration Files, Windows, Windows @subsection Installation @noindent Empty. address@hidden address@hidden Node address@hidden @node Windows Configuration Files, Windows Port Names, Windows Installation, Windows @subsection Configuration Files @@ -971,6 +1104,9 @@ * How AVRDUDE finds the configuration files.:: @end menu address@hidden address@hidden Node address@hidden @node Configuration file names, How AVRDUDE finds the configuration files., Windows Configuration Files, Windows Configuration Files @subsubsection Configuration file names @@ -979,6 +1115,9 @@ @code{avrdude.conf} and looks for a user override configuration file of @code{avrdude.rc}. address@hidden address@hidden Node address@hidden @node How AVRDUDE finds the configuration files., , Configuration file names, Windows Configuration Files @subsubsection How AVRDUDE finds the configuration files. @@ -1012,6 +1151,9 @@ @end enumerate address@hidden address@hidden Node address@hidden @node Windows Port Names, Using the parallel port, Windows Configuration Files, Windows @subsection Port Names @@ -1020,6 +1162,9 @@ * Parallel Ports:: @end menu address@hidden address@hidden Node address@hidden @node Serial Ports, Parallel Ports, Windows Port Names, Windows Port Names @subsubsection Serial Ports @@ -1027,6 +1172,9 @@ When you select a serial port (i.e. when using an STK500) use the Windows serial port device names such as: com1, com2, etc. address@hidden address@hidden Node address@hidden @node Parallel Ports, , Serial Ports, Windows Port Names @subsubsection Parallel Ports @@ -1051,9 +1199,11 @@ using a laptop, you might have to use lpt3 instead of lpt1. Select the name of the port the corresponds to the base address of the parallel port that you want. - - + address@hidden address@hidden Node address@hidden @node Using the parallel port, Documentation, Windows Port Names, Windows @subsection Using the parallel port @@ -1062,6 +1212,9 @@ * Windows 95/98:: @end menu address@hidden address@hidden Node address@hidden @node Windows NT/2K/XP, Windows 95/98, Using the parallel port, Using the parallel port @subsubsection Windows NT/2K/XP @@ -1099,6 +1252,9 @@ be able to subsequently execute the batch file from any directory and have it successfully start the driver. address@hidden address@hidden Node address@hidden @node Windows 95/98, , Windows NT/2K/XP, Using the parallel port @subsubsection Windows 95/98 @@ -1106,12 +1262,18 @@ On Windows 95 and 98 the giveio.sys driver is not needed. address@hidden address@hidden Node address@hidden @node Documentation, Credits., Using the parallel port, Windows @subsection Documentation @noindent Empty. address@hidden address@hidden Node address@hidden @node Credits., , Documentation, Windows @subsection Credits.