Changeset 998 for trunk/flashrom.8


Ignore:
Timestamp:
05/15/10 17:04:37 (2 years ago)
Author:
hailfinger
Message:

Fix assorted documentation, frontend and printing bugs.
Change the command line interface to make file names positional.
Add more sanity checks to the command line parser.

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/flashrom.8

    r996 r998  
    1 .TH FLASHROM 8 "May 21, 2009" 
     1.TH FLASHROM 8 "Apr 29, 2010" 
    22.SH NAME 
    33flashrom \- detect, read, write, verify and erase flash chips 
    44.SH SYNOPSIS 
    5 .B flashrom \fR[\fB\-VfLzhRn\fR] [\fB\-E\fR|\fB\-r\fR file|\fB\-w\fR file|\fB\-v\fR file] [\fB\-c\fR chipname] 
    6          [\fB\-m\fR [vendor:]part] [\fB\-l\fR file] [\fB\-i\fR image] [\fB\-p\fR programmer] 
     5.B flashrom \fR[\fB\-n\fR] [\fB\-V\fR] [\fB\-f\fR] [\fB\-h\fR|\fB\-R\fR|\ 
     6\fB\-L\fR|\fB\-z\fR|\fB\-E\fR|\fB\-r\fR <file>|\fB\-w\fR <file>|\ 
     7\fB\-v\fR <file>] 
     8         [\fB\-c\fR <chipname>] [\fB\-m\fR [<vendor>:]<part>] \ 
     9[\fB\-l\fR <file>] 
     10         [\fB\-i\fR <image>] [\fB\-p\fR <programmername>[:<parameters>]] 
    711.SH DESCRIPTION 
    812.B flashrom 
    … …  
    2125checking that your flashrom version won't interpret options in a different way. 
    2226.PP 
    23 You can specify one of \-E, \-r, \-w, \-v or no operation. 
    24 If no operation is specified, then all that happens 
    25 is that flash info is dumped and the flash chip is set to writable. It is 
     27You can specify one of \-h, \-R, \-L, \-z, \-E, \-r, \-w, \-v or no operation. 
     28If no operation is specified, flashrom will only probe for flash chips. It is 
    2629recommended that if you try flashrom the first time on a system, you run it 
    2730in probe only mode and check the output. Also you are advised to make a 
    … …  
    3437.TP 
    3538.B "\-w, \-\-write <file>" 
    36 Write file into flash ROM. 
     39Write 
     40.B <file> 
     41into flash ROM. 
    3742.TP 
    3843.B "\-n, \-\-noverify" 
    39 Do 
    40 .B not 
    41 verify the flash ROM contents after writing them to the chip. Using this 
     44Skip the automatic verification of flash ROM contents after writing. Using this 
    4245option is 
    4346.B not 
    44 recommended, you should only use it if you know what you are doing and you 
     47recommended, you should only use it if you know what you are doing and if you 
    4548feel that the time for verification takes too long. 
    4649.sp 
    4750Typical usage is: 
    48 .B "flashrom -wn file" 
     51.B "flashrom -n -w file" 
    4952.sp 
    5053This option is only useful in combination with 
    … …  
    6770without the vendor name. Please note that the chip name is case sensitive. 
    6871.TP 
    69 .B "\-m, \-\-mainboard" <[vendor:]part> 
     72.B "\-m, \-\-mainboard" [<vendor>:]<part> 
    7073Override mainboard settings. 
    7174.sp 
    … …  
    7477specify \-m, e.g.: 
    7578.sp 
    76 .B "  flashrom -w --mainboard AGAMI:ARUMA agami_aruma.rom" 
     79.B "  flashrom --mainboard AGAMI:ARUMA -w agami_aruma.rom" 
    7780.sp 
    7881See the 'Supported mainboards' section in the output of 'flashrom \-L' for 
    … …  
    109112If you only want to update the normal image in a ROM you can say: 
    110113.sp 
    111 .B "  flashrom -w --layout rom.layout --image normal agami_aruma.rom" 
     114.B "  flashrom --layout rom.layout --image normal -w agami_aruma.rom" 
    112115.sp 
    113116To update normal and fallback but leave the VGA BIOS alone, say: 
    114117.sp 
    115 .B "  flashrom -w -l rom.layout -i normal \" 
    116 .br 
    117 .B "           -i fallback agami_aruma.rom" 
     118.B "  flashrom -l rom.layout -i normal \" 
     119.br 
     120.B "           -i fallback -w agami_aruma.rom" 
    118121.sp 
    119122Currently overlapping sections are not supported. 
    120 .sp 
    121 ROM layouts should replace the \-s and \-e option since they are more 
    122 flexible and they should lead to a ROM update file format with the 
    123 ROM layout and the ROM image in one file (cpio, zip or something?). 
    124123.TP 
    125124.B "\-i, \-\-image <name>" 
    … …  
    142141.BR \-\-list\-supported , 
    143142but outputs the supported hardware in MediaWiki syntax, so that it can be 
    144 easily pasted into the wiki page at http://www.flashrom.org/. 
     143easily pasted into the wiki page at http://www.flashrom.org/. Please note 
     144that MediaWiki output is not compiled in by default. 
    145145.TP 
    146146.B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]" 
    … …  
    238238If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus 
    239239translation, flashrom should autodetect that configuration. You can use 
     240.sp 
    240241.B "flashrom -p internal:it87spiport=portnum" 
    241242syntax as explained in the 
    … …  
    383384Markus Boas <ryven@ryven.de> 
    384385.br 
     386Michael Karcher <flashrom@mkarcher.dialup.fu-berlin.de> 
     387.br 
    385388Nikolay Petukhov <nikolay.petukhov@gmail.com> 
    386389.br 
    … …  
    392395.br 
    393396Ronald Hoogenboom <ronald@zonnet.nl> 
     397.br 
     398Sean Nelson <audiohacked@gmail.com> 
    394399.br 
    395400Stefan Reinauer <stepan@coresystems.de> 
    … …  
    407412some others  
    408413.PP 
    409 This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>. 
     414This manual page was written by Uwe Hermann <uwe@hermann-uwe.de> and Carl-Daniel 
     415Hailfinger. 
    410416It is licensed under the terms of the GNU GPL (version 2 or later). 
Note: See TracChangeset for help on using the changeset viewer.