| OLD | NEW |
| (Empty) |
| 1 // Copyright 2014 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 = generate_dump(1) | |
| 18 | |
| 19 == Name | |
| 20 | |
| 21 generate_dump - Generate a minidump file containing a snapshot of a running | |
| 22 process | |
| 23 | |
| 24 == Synopsis | |
| 25 | |
| 26 [verse] | |
| 27 *generate_dump* ['OPTION…'] 'PID' | |
| 28 | |
| 29 == Description | |
| 30 | |
| 31 Generates a minidump file containing a snapshot of a running process whose | |
| 32 process identifier is 'PID'. By default, the target process will be suspended | |
| 33 while the minidump is generated, and the minidump file will be written to | |
| 34 +minidump.PID+. After the minidump file is generated, the target process resumes | |
| 35 running. | |
| 36 | |
| 37 The minidump file will contain information about the process, its threads, its | |
| 38 modules, and the system. It will not contain any exception information because | |
| 39 it will be generated from a live running process, not as a result of an | |
| 40 exception occurring. | |
| 41 | |
| 42 This program uses +task_for_pid()+ to access the process’ task port. This | |
| 43 operation may be restricted to use by the superuser, executables signed by an | |
| 44 authority trusted by the system, and processes otherwise permitted by | |
| 45 taskgated(8). Consequently, this program must normally either be signed or be | |
| 46 invoked by root. It is possible to install this program as a setuid root | |
| 47 executable to overcome this limitation. | |
| 48 | |
| 49 This program is similar to the gcore(1) program available on some operating | |
| 50 systems. | |
| 51 | |
| 52 == Options | |
| 53 | |
| 54 *-r*, *--no-suspend*:: | |
| 55 The target process will continue running while the minidump file is generated. | |
| 56 Normally, the target process is suspended during this operation, which | |
| 57 guarantees that the minidump file will contain an atomic snapshot of the | |
| 58 process. | |
| 59 + | |
| 60 This option may be useful when attempting to generate a minidump from a process | |
| 61 that dump generation has an interprocess dependency on, such as a system server | |
| 62 like launchd(8) or opendirectoryd(8). Deadlock could occur if any portion of the | |
| 63 dump generation operation blocks while waiting for a response from one of these | |
| 64 servers while they are suspended. | |
| 65 | |
| 66 *-o*, *--output*='FILE':: | |
| 67 The minidump will be written to 'FILE' instead of +minidump.PID+. | |
| 68 | |
| 69 *--help*:: | |
| 70 Display help and exit. | |
| 71 | |
| 72 *--version*:: | |
| 73 Output version information and exit. | |
| 74 | |
| 75 == Examples | |
| 76 | |
| 77 Generate a minidump file in +/tmp/minidump+ containing a snapshot of the process | |
| 78 with PID 1234. | |
| 79 [subs="quotes"] | |
| 80 ---- | |
| 81 $ *generate_dump --output=/tmp/minidump 1234* | |
| 82 ---- | |
| 83 | |
| 84 == Exit Status | |
| 85 | |
| 86 *0*:: | |
| 87 Success. | |
| 88 | |
| 89 *1*:: | |
| 90 Failure, with a message printed to the standard error stream. | |
| 91 | |
| 92 == See Also | |
| 93 | |
| 94 man_link:catch_exception_tool[1] | |
| 95 | |
| 96 include::../doc/support/man_footer.ad[] | |
| OLD | NEW |