ps3-flash-util.8: General cleanups.

1 files changed, 65 insertions, 35 deletions

diff --git a/ps3-flash-util.8 b/ps3-flash-util.8
index e5cbe8a..e49f765 100644
--- a/ps3-flash-util.8
+++ b/ps3-flash-util.8
@@ -17,90 +17,120 @@
 .\" License along with this library; if not, write to the Free Software
 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 .\"
+.\" Maintainer's note: For syntax help see the man pages for 'mdoc' and
+.\" 'mdoc.samples'.
+.\"
 .Dd ""
 .Dt ps3-flash-util 8
 .Os
+.\"
 .Sh NAME
+.\" ====
 .Nm ps3-flash-util
 .Nd PS3 flash memory utility
+.\"
 .Sh SYNOPSIS
+.\" ========
 .Nm
-.Op Fl hsgorzFLv
-.Op Fl d Ar flash-dev
-.Op Fl w Ar image-file
-.Op Fl P Ar owner Ar key
-.Op Fl D Ar owner Ar key Ar dword
-.Op Fl W Ar owner Ar key Ar word
-.Op Fl H Ar owner Ar key Ar half
-.Op Fl R Ar owner Ar key
+.Op Fl d, -device Ar flash-dev
+.Op Fl s, -show-settings
+.Op Fl w, -write-image Ar image-file
+.Op Fl g, -set-game-os | Fl o, -set-other-os
+.Op Fl r, -set-raw | Fl z, -set-gzip
+.Op Fl F, -db-format
+.Op Fl P, -db-print Ar owner Ar key
+.Op Fl D, -db-dword Ar owner Ar key Ar dword
+.Op Fl W, -db-word Ar owner Ar key Ar word
+.Op Fl H, -db-half Ar owner Ar key Ar half
+.Op Fl R, -db-remove Ar owner Ar key
+.Op Fl L, -db-list-known
+.Op Fl h, -help
+.Op Fl v, -verbose
+.Op Fl -version
+.\"
 .Sh DESCRIPTION
+.\" ===========
 The ps3-flash-util utility is used to operate on the system flash ROM
 of the PS3 game console.
+.\"
 .Sh OPTIONS
+.\" =======
 .Bl -tag -width indent
 .\"
-.It Fl h
-Print a help message.
-.\"
-.It Fl d Ar flash-dev
-Use the flash device node 
+.It Fl d, -device Ar flash-dev
+Use the flash device node
 .Ar flash-dev
 (default=/dev/ps3flash).
 .\"
-.It Fl s
-Show the current flash settings.
+.It Fl s, -show-settings
+Show the current flash settings (non-destructive).
 .\"
-.It Fl w Ar image-file
-Write the Other OS image 
+.It Fl w, -write-image Ar image-file
+Write the Other OS image
 .Ar image-file
-to flash memory ('-' for data on stdin).
+to flash memory and update the OS area header with information for the
+new image.  This is the option to use to write a new bootloader image
+to flash memory.  Use '-' for data on stdin.
 .\"
-.It Fl g
-Set the boot flag to Game OS.
+.It Fl g, -set-game-os
+Set the system boot flag to Game OS.
 .\"
-.It Fl o
-Set the boot flag to Other OS.
+.It Fl o, -set-other-os
+Set the system boot flag to Other OS.
 .\"
-.It Fl r
-Set the compression flag to raw (not compressed).
+.It Fl r, -set-raw
+Set the Other OS image compression flag to raw (not compressed).
 .\"
-.It Fl z
-Set the compression flag to gzip compressed.
+.It Fl z, -set-gzip
+Set the Other OS image compression flag to gzip compressed.
 .\"
-.It Fl F
+.It Fl F, -db-format
 Format (write) an empty Other OS database to flash memory.
 Any existing data in the flash memory will be lost.
 .\"
-.It Fl P Ar owner Ar key
+.It Fl P, -db-print Ar owner Ar key
 Print owner:key database entries.  A negative one (-1) value for owner or key
 can be used as a wildcard to match any owner or key.
 .\"
-.It Fl D Ar owner Ar key Ar dword
+.It Fl D, -db-dword Ar owner Ar key Ar dword
 Add or update a 64 bit owner:key database entry.  The
 .Ar dword
 argument supports input matching the scanf "%Li" format specification.
 .\"
-.It Fl W Ar owner Ar key Ar word
+.It Fl W, -db-word Ar owner Ar key Ar word
 Add or update a 32 bit owner:key database entry.  The
 .Ar word
 argument supports input matching the scanf "%Li" format specification.
 .\"
-.It Fl H Ar owner Ar key Ar half
+.It Fl H, -db-half Ar owner Ar key Ar half
 Add or update a 16 bit owner:key database entry.  The
 .Ar half
 argument supports input matching the scanf "%Li" format specification.
 .\"
-.It Fl R Ar owner Ar key
+.It Fl R, -db-remove Ar owner Ar key
 Remove an owner:key entry from the database.  A negative one (-1) value for owner or key
 can be used as a wildcard to match any owner or key.
 .\"
-.It Fl L
+.It Fl L, -db-list-known
 List known database owners and keys.
 .\"
-.It Fl v
+.It Fl h, -help
+Print a help message.
+.\"
+.It Fl v, -verbose
 Program verbosity level.  The level is additive.
+.\"
+.It Fl -version
+Display the program version number.
 .El
+.Sh SEE ALSO
+.\" ========
+.Xr ps3-boot-game-os 8 , Xr ps3-dump-bootloader 8
+.\"
 .Sh AUTHOR
+.\" ======
 Written by Masato Noguchi and Geoff Levand.
-.SH REPORTING BUGS
+.\"
+.Sh REPORTING BUGS
+.\" ==============
 Report bugs to Geoff Levand <geoffrey.levand@am.sony.com>.