OLD | NEW |
| (Empty) |
1 // Copyright 2015 The Crashpad Authors. All rights reserved. | |
2 // | |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 // you may not use this file except in compliance with the License. | |
5 // You may obtain a copy of the License at | |
6 // | |
7 // http://www.apache.org/licenses/LICENSE-2.0 | |
8 // | |
9 // Unless required by applicable law or agreed to in writing, software | |
10 // distributed under the License is distributed on an "AS IS" BASIS, | |
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 // See the License for the specific language governing permissions and | |
13 // limitations under the License. | |
14 | |
15 :doctype: manpage | |
16 | |
17 = crashpad_database_util(1) | |
18 | |
19 == Name | |
20 | |
21 crashpad_database_util - Operate on Crashpad crash report databases | |
22 | |
23 == Synopsis | |
24 | |
25 [verse] | |
26 *crashpad_database_util* ['OPTION…'] | |
27 | |
28 == Description | |
29 | |
30 Operates on Crashpad crash report databases. The database’s settings can be | |
31 queried and modified, and information about crash reports stored in the | |
32 database can be displayed. | |
33 | |
34 When this program is requested to both show and set information in a single | |
35 invocation, all “show” operations will be completed prior to beginning any “set” | |
36 operation. | |
37 | |
38 Programs that use the Crashpad client library directly will not normally use | |
39 this tool, but may use the database through the programmatic interfaces in the | |
40 client library. This tool exists to allow developers to manipulate a Crashpad | |
41 database. | |
42 | |
43 == Options | |
44 *--create*:: | |
45 Creates the database identified by *--database* if it does not exist, provided | |
46 that the parent directory of 'PATH' exists. | |
47 | |
48 *-d*, *--database*='PATH':: | |
49 Use 'PATH' as the path to the Crashpad crash report database. This option is | |
50 required. The database must already exist unless *--create* is also specified. | |
51 | |
52 *--show-client-id*:: | |
53 Show the client ID stored in the database’s settings. The client ID is formatted | |
54 as a UUID. The client ID is set when the database is created. | |
55 man_link:crashpad_handler[8] retrieves the client ID and stores it in crash | |
56 reports as they are written. | |
57 | |
58 *--show-uploads-enabled*:: | |
59 Show the status of the uploads-enabled bit stored in the database’s settings. | |
60 man_link:crashpad_handler[8] does not upload reports when this bit is false. | |
61 This bit is false when a database is created, and is under an application’s | |
62 control via the Crashpad client library interface. | |
63 + | |
64 See also *--set-uploads-enabled*. | |
65 | |
66 *--show-last-upload-attempt-time*:: | |
67 Show the last-upload-attempt time stored in the database’s settings. This value | |
68 is +0+, meaning “never,” when the database is created. | |
69 man_link:crashpad_handler[8] consults this value before attempting an upload to | |
70 implement its rate-limiting behavior. The database updates this value whenever | |
71 an upload is attempted. | |
72 + | |
73 See also *--set-last-upload-attempt-time*. | |
74 | |
75 *--show-pending-reports*:: | |
76 Show reports eligible for upload. | |
77 | |
78 *--show-completed-reports*:: | |
79 Show reports not eligible for upload. A report is moved from the “pending” state | |
80 to the “completed” state by man_link:crashpad_handler[8]. This may happen when a | |
81 report is successfully uploaded, when a report is not uploaded because uploads | |
82 are disabled, or when a report upload attempt fails and will not be retried. | |
83 | |
84 *--show-all-report-info*:: | |
85 With *--show-pending-reports* or *--show-completed-reports*, show all metadata | |
86 for each report displayed. Without this option, only report IDs will be shown. | |
87 | |
88 *--show-report*='UUID':: | |
89 Show a report from the database looked up by its identifier, 'UUID', which must | |
90 be formatted in string representation per RFC 4122 §3. All metadata for each | |
91 report found via a *--show-report* option will be shown. If 'UUID' is not found, | |
92 the string +"not found"+ will be printed. If this program is only requested to | |
93 show a single report and it is not found, it will treat this as a failure for | |
94 the purposes of determining its exit status. This option may appear multiple | |
95 times. | |
96 | |
97 *--set-report-uploads-enabled*='BOOL':: | |
98 Enable or disable report upload in the database’s settings. 'BOOL' is a string | |
99 representation of a boolean value, such as +"0"+ or +"true"+. | |
100 + | |
101 See also *--show-uploads-enabled*. | |
102 | |
103 *--set-last-upload-attempt-time*='TIME':: | |
104 Set the last-upload-attempt time in the database’s settings. 'TIME' is a string | |
105 representation of a time, which may be in 'yyyy-mm-dd hh:mm:ss' format, a | |
106 numeric +time_t+ value, or the special string +"never"+. | |
107 + | |
108 See also *--show-last-upload-attempt-time*. | |
109 | |
110 *--new-report*='PATH':: | |
111 Submit a new report located at 'PATH' to the database. If 'PATH' is +"-"+, the | |
112 new report will be read from standard input. The new report will be in the | |
113 “pending” state. The UUID assigned to the new report will be printed. This | |
114 option may appear multiple times. | |
115 | |
116 *--utc*:: | |
117 When showing times, do so in UTC as opposed to the local time zone. When setting | |
118 times, interpret ambiguous time strings in UTC as opposed to the local time | |
119 zone. | |
120 | |
121 *--help*:: | |
122 Display help and exit. | |
123 | |
124 *--version*:: | |
125 Output version information and exit. | |
126 | |
127 == Examples | |
128 | |
129 Shows all crash reports in a crash report database that are in the “completed” | |
130 state. | |
131 [subs="quotes"] | |
132 ---- | |
133 $ *crashpad_database_util --database /tmp/crashpad_database \ | |
134 --show-completed-reports* | |
135 23f9512b-63e1-4ead-9dcd-e2e21fbccc68 | |
136 4bfca440-039f-4bc6-bbd4-6933cef5efd4 | |
137 56caeff8-b61a-43b2-832d-9e796e6e4a50 | |
138 ---- | |
139 | |
140 Disables report upload in a crash report database’s settings, and then verifies | |
141 that the change was made. | |
142 [subs="quotes"] | |
143 ---- | |
144 $ *crashpad_database_util --database /tmp/crashpad_database \ | |
145 --set-uploads-enabled false* | |
146 $ *crashpad_database_util --database /tmp/crashpad_database \ | |
147 --show-uploads-enabled* | |
148 false | |
149 ---- | |
150 | |
151 == Exit Status | |
152 | |
153 *0*:: | |
154 Success. | |
155 | |
156 *1*:: | |
157 Failure, with a message printed to the standard error stream. | |
158 | |
159 == See Also | |
160 | |
161 man_link:crashpad_handler[8] | |
162 | |
163 include::../doc/support/man_footer.ad[] | |
OLD | NEW |