| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 1 | dsymutil - manipulate archived DWARF debug symbol files |
| 2 | ======================================================= |
| 3 | |
| 4 | SYNOPSIS |
| 5 | -------- |
| 6 | |
| 7 | | :program:`dsymutil` [*options*] *executable* |
| 8 | |
| 9 | DESCRIPTION |
| 10 | ----------- |
| 11 | |
| 12 | :program:`dsymutil` links the DWARF debug information found in the object files |
| 13 | for an executable *executable* by using debug symbols information contained in |
| 14 | its symbol table. By default, the linked debug information is placed in a |
| 15 | ``.dSYM`` bundle with the same name as the executable. |
| 16 | |
| 17 | OPTIONS |
| 18 | ------- |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 19 | .. option:: --arch=<arch> |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 20 | |
| 21 | Link DWARF debug information only for specified CPU architecture types. |
| 22 | Architectures may be specified by name. When using this option, an error will |
| 23 | be returned if any architectures can not be properly linked. This option can |
| 24 | be specified multiple times, once for each desired architecture. All CPU |
| 25 | architectures will be linked by default and any architectures that can't be |
| 26 | properly linked will cause :program:`dsymutil` to return an error. |
| 27 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 28 | .. option:: --dump-debug-map |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 29 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 30 | Dump the *executable*'s debug-map (the list of the object files containing the |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 31 | debug information) in YAML format and exit. Not DWARF link will take place. |
| 32 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 33 | .. option:: -f, --flat |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 34 | |
| 35 | Produce a flat dSYM file. A ``.dwarf`` extension will be appended to the |
| 36 | executable name unless the output file is specified using the -o option. |
| 37 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 38 | .. option:: --no-odr |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 39 | |
| 40 | Do not use ODR (One Definition Rule) for uniquing C++ types. |
| 41 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 42 | .. option:: --no-output |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 43 | |
| 44 | Do the link in memory, but do not emit the result file. |
| 45 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 46 | .. option:: --no-swiftmodule-timestamp |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 47 | |
| 48 | Don't check the timestamp for swiftmodule files. |
| 49 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 50 | .. option:: -j <n>, --num-threads=<n> |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 51 | |
| 52 | Specifies the maximum number (``n``) of simultaneous threads to use when |
| 53 | linking multiple architectures. |
| 54 | |
| 55 | .. option:: -o <filename> |
| 56 | |
| 57 | Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM |
| 58 | bundle path is created by appending ``.dSYM`` to the executable name. |
| 59 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 60 | .. option:: --oso-prepend-path=<path> |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 61 | |
| 62 | Specifies a ``path`` to prepend to all debug symbol object file paths. |
| 63 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 64 | .. option:: -s, --symtab |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 65 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 66 | Dumps the symbol table found in *executable* or object file(s) and exits. |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 67 | |
| Adrian Prantl | 3c6491d | 2017-11-06 16:52:05 +0000 | [diff] [blame] | 68 | .. option:: -v, --verbose |
| Jonas Devlieghere | fb7bf1d | 2017-11-02 18:44:54 +0000 | [diff] [blame] | 69 | |
| 70 | Display verbose information when linking. |
| 71 | |
| 72 | .. option:: --version |
| 73 | |
| 74 | Display the version of the tool. |
| 75 | |
| 76 | .. option:: -y |
| 77 | |
| 78 | Treat *executable* as a YAML debug-map rather than an executable. |
| 79 | |
| 80 | EXIT STATUS |
| 81 | ----------- |
| 82 | |
| 83 | :program:`dsymutil` returns 0 if the DWARF debug information was linked |
| 84 | successfully. Otherwise, it returns 1. |
| 85 | |
| 86 | SEE ALSO |
| 87 | -------- |
| 88 | |
| 89 | :manpage:`llvm-dwarfdump(1)` |