openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-27 23:22:37 +02:00
Code Issues Releases Wiki Activity

Document --output in the man page

Browse Source 
Add an examples section to the man page.

Corresponding to flashrom svn r1550.

Signed-off-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>
Acked-by: Paul Menzel <paulepanter@users.sourceforge.net>
This commit is contained in:
Carl-Daniel Hailfinger 2012-07-21 16:56:04 +00:00
parent 32508eb304
commit 0b9af36772
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
flashrom.8
View File

@ -8,6 +8,7 @@ flashrom \- detect, read, write, verify and erase flash chips
[\fB\-c\fR <chipname>] \ [\fB\-c\fR <chipname>] \
[\fB\-l\fR <file>] [\fB\-l\fR <file>]
[\fB\-i\fR <image>] [\fB\-p\fR <programmername>[:<parameters>]] [\fB\-i\fR <image>] [\fB\-p\fR <programmername>[:<parameters>]]
[\fB-o\fR <logfile>]
.SH DESCRIPTION .SH DESCRIPTION
.B flashrom .B flashrom
is a utility for detecting, reading, writing, verifying and erasing flash is a utility for detecting, reading, writing, verifying and erasing flash
@ -220,6 +221,13 @@ lists all supported programmers.
.B "\-h, \-\-help" .B "\-h, \-\-help"
Show a help text and exit. Show a help text and exit.
.TP .TP
.B "\-o, \-\-output <logfile>"
Save the full debug log to
.BR <logfile> .
If the file already exists, it will be overwritten. This is the recommended
way to gather logs from flashrom because they will be verbose even if the
on-screen messages are not verbose.
.TP
.B "\-R, \-\-version" .B "\-R, \-\-version"
Show version information and exit. Show version information and exit.
.SH PROGRAMMER SPECIFIC INFO .SH PROGRAMMER SPECIFIC INFO
@ -697,6 +705,25 @@ syntax where
is the Linux device node for your SPI controller. is the Linux device node for your SPI controller.
.sp .sp
Please note that the linux_spi driver only works on Linux. Please note that the linux_spi driver only works on Linux.
.SH EXAMPLES
To back up and update your BIOS, run
.sp
.B flashrom -p internal -r backup.rom -o backuplog.txt
.br
.B flashrom -p internal -w newbios.rom -o writelog.txt
.sp
Please make sure to copy backup.rom to some external media before you try
to write. That makes offline recovery easier.
.br
If writing fails and flashrom complains about the chip being in an unknown
state, you can try to restore the backup by running
.sp
.B flashrom -p internal -w backup.rom -o restorelog.txt
.sp
If you encounter any problems, please contact us and supply
backuplog.txt, writelog.txt and restorelog.txt. See section
.B BUGS
for contact info.
.SH EXIT STATUS .SH EXIT STATUS
flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
(/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails. (/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.