summaryrefslogtreecommitdiffstats
path: root/ps3-flash-util.8.in
blob: 4a5687f8523c3203c2556e4d8707436158e3358e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
.\" PS3 flash memory utility
.\"
.\" Copyright (C) 2008 Sony Computer Entertainment Inc.
.\" Copyright 2008 Sony Corp.
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; version 2 of the License.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
.\"
.\" Maintainer's Notes:
.\"  * For syntax help see the man pages for 'mdoc' and 'mdoc.samples'.
.\"  * To check syntax use this:
.\"    'groff -C -mtty-char -Tutf8 -man ps3-flash-util.8'.
.\"  * To check format use this: 'less ps3-flash-util.8'.
.\"
.Dd ""
.Dt ps3-flash-util 8
.Os
.\"
.Sh NAME
.\" ====
.Nm ps3-flash-util
.Nd PS3 flash memory utility
.\"
.Sh SYNOPSIS
.\" ========
.Nm
.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 t, -game-time
.Op Fl T, -db-test
.Op Fl F, -db-format
.Op Fl P, -db-print Ar owner Ar key
.Op Fl D, -db-write-dword Ar owner Ar key Ar dword
.Op Fl W, -db-write-word Ar owner Ar key Ar word
.Op Fl H, -db-write-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 V, -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 d, -device Ar flash-dev
Use the flash device node
.Ar flash-dev
(default=/dev/ps3flash).
.\"
.It Fl s, -show-settings
Show the current flash settings (non-destructive).
.\"
.It Fl w, -write-image Ar image-file
Write the Other OS image
.Ar image-file
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-game-os
Set the system boot flag to Game OS.
.\"
.It Fl o, -set-other-os
Set the system boot flag to Other OS.
.\"
.It Fl r, -set-raw
Set the Other OS image compression flag to raw (not compressed).
.\"
.It Fl z, -set-gzip
Set the Other OS image compression flag to gzip compressed.
.\"
.It Fl t, -game-time
Print the Game OS RTC diff value.
.\"
.It Fl T, -db-test
Test for the existence of an Other OS database in flash memory.
Exits with a zero status if a database is found.
.\"
.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, -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, -db-write-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, -db-write-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, -db-write-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, -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, -db-list-known
List known database owners and keys.
.\"
.It Fl h, -help
Print a help message.
.\"
.It Fl v, -verbose
Program verbosity level.  The level is additive.
.\"
.It Fl V, -version
Display the program version number.
.El
.\"
.Sh RETURN VALUE
.\" ============
Returns 0 on success, 1 on error.
.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
.\" ==============
Send bug reports to @PACKAGE_BUGREPORT@.