Changeset 922 for trunk/flashrom.8


Ignore:
Timestamp:
Mar 7, 2010, 12:11:08 PM (5 years ago)
Author:
mkarcher
Message:

Refactor man page

This patch puts the description of the different programmers into a
separate section of the manpage instead of having them one after the
other without visual structuring in the description of "-p". It is
made as a preparation of a man-page patch that adds the background
of board enables into flashrom.8 that would really blow up the OPTIONS
section.

The only differences in content are:

  • The parameter for serprog is mandatory, not optional
  • Default behaviour of it87spi (using BIOS-set I/O address) is mentioned.
  • Default speed of buspiratespi is mentioned.

Signed-off-by: Michael Karcher <flashrom@…>
Acked-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@…>

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/flashrom.8

    r908 r922  
    132132easily pasted into the wiki page at http://www.flashrom.org/.
    133133.TP
    134 .B "\-p, \-\-programmer <name>"
     134.B "\-p, \-\-programmer <name>[:parameters]"
    135135Specify the programmer device. Currently supported are:
    136136.sp
     
    157157.BR "* buspiratespi" " (for flash ROMs attached to a Bus Pirate)"
    158158.sp
    159 The dummy programmer has an optional parameter specifying the bus types it
     159Some programmers have optional or mandatory parameters which are described
     160in detail in the
     161.B PROGRAMMER SPECIFIC INFO
     162section. Support for some programmers can be disabled at compile time.
     163.B "flashrom -h"
     164lists all supported programmers.
     165.TP
     166.B "\-h, \-\-help"
     167Show a help text and exit.
     168.TP
     169.B "\-R, \-\-version"
     170Show version information and exit.
     171.SH PROGRAMMER SPECIFIC INFO
     172Some programmer drivers accept further parameters to set programmer-specific
     173parameters. These parameters are seperated from the programmer name by a
     174colon. While some programmers take arguments at fixed positions, other
     175programmers use a key/value interface in which the key and value is separated
     176by an equal sign and different pairs are separated by a comma or a colon.
     177.TP
     178.BR "dummy " programmer
     179An optional parameter specifies the bus types it
    160180should support. For that you have to use the
    161181.B "flashrom -p dummy:type"
     
    168188Example:
    169189.B "flashrom -p dummy:lpc,fwh"
    170 .sp
    171 If you have multiple supported PCI cards which can program flash chips
    172 (NICs, SATA/IDE controllers, etc.) in your system, you must use the
     190.TP
     191.BR "nic3com" , " gfxnvidia" , " satasii" and " atahpt " programmers
     192These programmers have an option to specify the PCI address of the card
     193your want to use, which must be specified if more than one card supported
     194by the selected programmer is installed in your system. The syntax is
    173195.B "flashrom -p xxxx:bb:dd.f"
    174 syntax to explicitly select one of them, where
     196, where
    175197.B xxxx
    176198is the name of the programmer
     
    184206Example:
    185207.B "flashrom -p nic3com:05:04.0"
    186 .sp
    187 Currently the following programmers support this mechanism:
    188 .BR nic3com ,
    189 .BR gfxnvidia ,
    190 .BR satasii ,
    191 .BR atahpt .
    192 .sp
    193 The it87spi programmer has an optional parameter which will set the I/O base
    194 port of the IT87* SPI controller interface to the port specified in the
    195 parameter. For that you have to use the
     208.TP
     209.BR "it87spi " programmer
     210An optional parameter sets the I/O base port of the IT87* SPI controller
     211interface to the port specified in the parameter instead of using the port
     212address set by the BIOS. For that you have to use the
    196213.B "flashrom -p it87spi:port=portnum"
    197214syntax where
    198215.B portnum
    199216is an I/O port number which must be a multiple of 8.
    200 .sp
    201 The ft2232spi programmer has an optional parameter specifying the controller
     217.TP
     218.BR "ft2232spi " programmer
     219An optional parameter species the controller
    202220type and interface/port it should support. For that you have to use the
    203221.B "flashrom -p ft2232spi:model,port=interface"
     
    209227.B interface
    210228can be any of
    211 .B A
    212 .BR B .
     229.BR "A B" .
    213230The default model is
    214231.B 4232H
    215232and the default interface is
    216233.BR B .
    217 .sp
    218 The serprog programmer has an optional parameter specifying either a serial
     234.TP
     235.BR "serprog " programmer
     236A mandatory parameter specifies either a serial
    219237device/baud combination or an IP/port combination for communication with the
    220 programmer. For serial, you have to use the
     238programmer. In the device/baud combination, the device has to start with a
     239slash. For serial, you have to use the
    221240.B "flashrom -p serprog:/dev/device:baud"
    222241syntax and for IP, you have to use
     
    224243instead. More information about serprog is available in serprog-protocol.txt in
    225244the source distribution.
    226 .sp
    227 The buspiratespi programmer has a required dev parameter specifying the Bus
    228 Pirate device node and an optional spispeed parameter specifying the frequency
    229 of the SPI bus. The parameter delimiter is a comma. Syntax is
     245.TP
     246.BR "buspiratespi " programmer
     247A required dev parameter specifyies the Bus Pirate device node and an optional
     248spispeed parameter specifyies the frequency of the SPI bus. The parameter
     249delimiter is a comma. Syntax is
     250.sp
    230251.B "flashrom -p buspiratespi:dev=/dev/device,spispeed=frequency"
     252.sp
    231253where
    232254.B frequency
    233255can be any of
    234256.B 30k 125k 250k 1M 2M 2.6M 4M 8M
    235 (in Hz).
    236 .sp
    237 Support for some programmers can be disabled at compile time.
    238 .B "flashrom -h"
    239 lists all supported programmers.
    240 .TP
    241 .B "\-h, \-\-help"
    242 Show a help text and exit.
    243 .TP
    244 .B "\-R, \-\-version"
    245 Show version information and exit.
     257(in Hz). The default is the maximum frequency of 8 MHz.
    246258.SH EXIT STATUS
    247259flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
Note: See TracChangeset for help on using the changeset viewer.