OLD | NEW |
1 // Copyright 2014 The Crashpad Authors. All rights reserved. | 1 // Copyright 2014 The Crashpad Authors. All rights reserved. |
2 // | 2 // |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
4 // you may not use this file except in compliance with 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 | 5 // You may obtain a copy of the License at |
6 // | 6 // |
7 // http://www.apache.org/licenses/LICENSE-2.0 | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
8 // | 8 // |
9 // Unless required by applicable law or agreed to in writing, software | 9 // Unless required by applicable law or agreed to in writing, software |
10 // distributed under the License is distributed on an "AS IS" BASIS, | 10 // distributed under the License is distributed on an "AS IS" BASIS, |
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
90 required. Crash reports are written to this database, and if uploads are | 90 required. Crash reports are written to this database, and if uploads are |
91 enabled, uploaded from this database to a crash report collection server. If the | 91 enabled, uploaded from this database to a crash report collection server. If the |
92 database does not exist, it will be created, provided that the parent directory | 92 database does not exist, it will be created, provided that the parent directory |
93 of 'PATH' exists. | 93 of 'PATH' exists. |
94 | 94 |
95 *--handshake-fd*='FD':: | 95 *--handshake-fd*='FD':: |
96 Perform the handshake with the initial client on the file descriptor at 'FD'. | 96 Perform the handshake with the initial client on the file descriptor at 'FD'. |
97 Either this option or *--mach-service*, but not both, is required. This option | 97 Either this option or *--mach-service*, but not both, is required. This option |
98 is only valid on OS X. | 98 is only valid on OS X. |
99 | 99 |
| 100 *--handshake-handle*='HANDLE':: |
| 101 Perform the handshake with the initial client on the HANDLE at 'HANDLE'. Either |
| 102 this option or *--pipe-name*, but not both, is required. This option is only |
| 103 valid on Windows. |
| 104 + |
| 105 When this option is present, the server creates a new named pipe at a random |
| 106 name and informs its client of the name. The server waits for at least one |
| 107 client to register, and exits when all clients have exited, after waiting for |
| 108 any uploads in progress to complete. |
| 109 |
100 *--mach-service*='SERVICE':: | 110 *--mach-service*='SERVICE':: |
101 Check in with the bootstrap server under the name 'SERVICE'. Either this option | 111 Check in with the bootstrap server under the name 'SERVICE'. Either this option |
102 or *--handshake-fd*, but not both, is required. This option is only valid on OS | 112 or *--handshake-fd*, but not both, is required. This option is only valid on OS |
103 X. | 113 X. |
104 + | 114 + |
105 'SERVICE' may already be reserved with the bootstrap server in cases where this | 115 'SERVICE' may already be reserved with the bootstrap server in cases where this |
106 tool is started by launchd(8) as a result of a message being sent to a service | 116 tool is started by launchd(8) as a result of a message being sent to a service |
107 declared in a job’s +MachServices+ dictionary (see launchd.plist(5)). The | 117 declared in a job’s +MachServices+ dictionary (see launchd.plist(5)). The |
108 service name may also be completely unknown to the system. | 118 service name may also be completely unknown to the system. |
109 | 119 |
110 *--handshake-handle*='HANDLE':: | 120 *--no-rate-limit*:: |
111 Perform the handshake with the initial client on the HANDLE at 'HANDLE'. Either | 121 Do not rate limit the upload of crash reports. By default uploads are throttled |
112 this option or *--pipe-name*, but not both, is required. This option is only | 122 to one per hour. Using this option disables that behavior, and Crashpad will |
113 valid on Windows. | 123 attempt to upload all captured reports. |
114 + | |
115 When this option is present, the server creates a new named pipe at a random | |
116 name and informs its client of the name. The server waits for at least one | |
117 client to register, and exits when all clients have exited, after waiting for | |
118 any uploads in progress to complete. | |
119 | 124 |
120 *--pipe-name*='PIPE':: | 125 *--pipe-name*='PIPE':: |
121 Listen on the given pipe name for connections from clients. 'PIPE' must be of | 126 Listen on the given pipe name for connections from clients. 'PIPE' must be of |
122 the form +\\.\pipe\<somename>+. Either this option or *--handshake-handle*, but | 127 the form +\\.\pipe\<somename>+. Either this option or *--handshake-handle*, but |
123 not both, is required. This option is only valid on Windows. | 128 not both, is required. This option is only valid on Windows. |
124 + | 129 + |
125 When this option is present, the server creates a named pipe at 'PIPE', a name | 130 When this option is present, the server creates a named pipe at 'PIPE', a name |
126 known to both the server and its clients. The server continues running even | 131 known to both the server and its clients. The server continues running even |
127 after all clients have exited. | 132 after all clients have exited. |
128 | 133 |
(...skipping 26 matching lines...) Expand all Loading... |
155 Failure, with a message printed to the standard error stream. | 160 Failure, with a message printed to the standard error stream. |
156 | 161 |
157 == See Also | 162 == See Also |
158 | 163 |
159 man_link:catch_exception_tool[1], | 164 man_link:catch_exception_tool[1], |
160 man_link:crashpad_database_util[1], | 165 man_link:crashpad_database_util[1], |
161 man_link:generate_dump[1], | 166 man_link:generate_dump[1], |
162 man_link:run_with_crashpad[1] | 167 man_link:run_with_crashpad[1] |
163 | 168 |
164 include::../doc/support/man_footer.ad[] | 169 include::../doc/support/man_footer.ad[] |
OLD | NEW |