1dsymutil - manipulate archived DWARF debug symbol files
2=======================================================
3
4.. program:: dsymutil
5
6SYNOPSIS
7--------
8
9| :program:`dsymutil` [*options*] *executable*
10
11DESCRIPTION
12-----------
13
14:program:`dsymutil` links the DWARF debug information found in the object files
15for an executable *executable* by using debug symbols information contained in
16its symbol table. By default, the linked debug information is placed in a
17``.dSYM`` bundle with the same name as the executable.
18
19OPTIONS
20-------
21.. option:: --accelerator=<accelerator type>
22
23 Specify the desired type of accelerator table. Valid options are 'Apple',
24 'Dwarf' and 'Default'.
25
26.. option:: --arch=<arch>
27
28 Link DWARF debug information only for specified CPU architecture types.
29 Architectures may be specified by name. When using this option, an error will
30 be returned if any architectures can not be properly linked.  This option can
31 be specified multiple times, once for each desired architecture. All CPU
32 architectures will be linked by default and any architectures that can't be
33 properly linked will cause :program:`dsymutil` to return an error.
34
35.. option:: --dump-debug-map
36
37 Dump the *executable*'s debug-map (the list of the object files containing the
38 debug information) in YAML format and exit. Not DWARF link will take place.
39
40.. option:: -f, --flat
41
42 Produce a flat dSYM file. A ``.dwarf`` extension will be appended to the
43 executable name unless the output file is specified using the ``-o`` option.
44
45.. option:: -h, --help
46
47 Print this help output.
48
49.. option:: -j <n>, --num-threads=<n>
50
51 Specifies the maximum number (``n``) of simultaneous threads to use when
52 linking multiple architectures.
53
54.. option:: --no-odr
55
56 Do not use ODR (One Definition Rule) for uniquing C++ types.
57
58.. option:: --no-output
59
60 Do the link in memory, but do not emit the result file.
61
62.. option:: --no-swiftmodule-timestamp
63
64 Don't check the timestamp for swiftmodule files.
65
66.. option:: --object-prefix-map=<prefix=remapped>
67
68 Remap object file paths (but no source paths) before processing.  Use
69 this for Clang objects where the module cache location was remapped using
70 ``-fdebug-prefix-map``; to help dsymutil find the Clang module cache.
71
72.. option:: --oso-prepend-path=<path>
73
74 Specifies a ``path`` to prepend to all debug symbol object file paths.
75
76.. option:: -o <filename>, --out <filename>
77
78 Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM
79 bundle path is created by appending ``.dSYM`` to the executable name.
80
81.. option:: --papertrail
82
83 When running dsymutil as part of your build system, it can be desirable for
84 warnings to be part of the end product, rather than just being emitted to the
85 output stream. When enabled warnings are embedded in the linked DWARF debug
86 information.
87
88.. option:: --remarks-output-format <format>
89
90 Specify the format to be used when serializing the linked remarks.
91
92.. option:: --remarks-prepend-path <path>
93
94 Specify a directory to prepend the paths of the external remark files.
95
96.. option:: --statistics
97
98 Print statistics about the contribution of each object file to the linked
99 debug info. This prints a table after linking with the object file name, the
100 size of the debug info in the object file (in bytes) and the size contributed
101 (in bytes) to the linked dSYM. The table is sorted by the output size listing
102 the obj ect files with the largest contribution first.
103
104.. option:: --symbol-map <bcsymbolmap>
105
106 Update the existing dSYMs inplace using symbol map specified.
107
108.. option:: -s, --symtab
109
110 Dumps the symbol table found in *executable* or object file(s) and exits.
111
112.. option:: -S
113
114 Output textual assembly instead of a binary dSYM companion file.
115
116.. option:: --toolchain <toolchain>
117
118 Embed the toolchain in the dSYM bundle's property list.
119
120.. option:: -u, --update
121
122 Update an existing dSYM file to contain the latest accelerator tables and
123 other DWARF optimizations. This option will rebuild the '.apple_names' and
124 '.apple_types' hashed accelerator tables.
125
126.. option:: --verbose
127
128 Display verbose information when linking.
129
130.. option:: --verify
131
132 Run the DWARF verifier on the linked DWARF debug info.
133
134.. option:: -v, --version
135
136 Display the version of the tool.
137
138.. option:: -y
139
140 Treat *executable* as a YAML debug-map rather than an executable.
141
142.. option:: -z, --minimize
143
144 When used when creating a dSYM file, this option will suppress the emission of
145 the .debug_inlines, .debug_pubnames, and .debug_pubtypes sections since
146 dsymutil currently has better equivalents: .apple_names and .apple_types. When
147 used in conjunction with ``--update`` option, this option will cause redundant
148 accelerator tables to be removed.
149
150EXIT STATUS
151-----------
152
153:program:`dsymutil` returns 0 if the DWARF debug information was linked
154successfully. Otherwise, it returns 1.
155
156SEE ALSO
157--------
158
159:manpage:`llvm-dwarfdump(1)`
160