llvm.org GIT mirror llvm / c64c5ea
[docs][llvm-nm] Add missing options to documentation There were several options missing from the documentation. This patch adds them as well as improving some wording and separating the Mach-O only options into a separate section. Fixes https://bugs.llvm.org/show_bug.cgi?id=42234. Reviewed by: MaskRay Differential Revision: https://reviews.llvm.org/D63655 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@364176 91177308-0d34-0410-b5e6-96231b3b80d8 James Henderson a month ago
1 changed file(s) with 96 addition(s) and 26 deletion(s). Raw diff Collapse all Expand all
121121
122122 .. program:: llvm-nm
123123
124 .. option:: -B (default)
125
126 Use BSD output format. Alias for `--format=bsd`.
127
128 .. option:: -P
129
130 Use POSIX.2 output format. Alias for `--format=posix`.
124 .. option:: -B
125
126 Use BSD output format. Alias for ``--format=bsd``.
131127
132128 .. option:: --debug-syms, -a
133129
134130 Show all symbols, even debugger only.
135131
136 .. option:: --defined-only
137
138 Print only symbols defined in this file (as opposed to
139 symbols which may be referenced by objects in this file, but not
140 defined in this file.)
132 .. option:: --defined-only, -U
133
134 Print only symbols defined in this file.
135
136 .. option:: --demangle, -C
137
138 Demangle symbol names.
141139
142140 .. option:: --dynamic, -D
143141
145143
146144 .. option:: --extern-only, -g
147145
148 Print only symbols whose definitions are external; that is, accessible
149 from other files.
150
151 .. option:: --no-weak, -W
152
153 Don't print any weak symbols in the output.
154
155 .. option:: --format=format, -f format
146 Print only symbols whose definitions are external; that is, accessible from
147 other files.
148
149 .. option:: --format=, -f
156150
157151 Select an output format; *format* may be *sysv*, *posix*, *darwin*, or *bsd*.
158152 The default is *bsd*.
161155
162156 Print a summary of command-line options and their meanings.
163157
158 .. option:: --help-list
159
160 Print an uncategorized summary of command-line options and their meanings.
161
162 .. option:: --just-symbol-name, -j
163
164 Print just the symbol names.
165
166 .. option:: -m
167
168 Use Darwin format. Alias for ``--format=darwin``.
169
170 .. option:: --no-demangle
171
172 Don't demangle symbol names. This is the default.
173
174 .. option:: --no-llvm-bc
175
176 Disable the LLVM bitcode reader.
177
164178 .. option:: --no-sort, -p
165179
166180 Shows symbols in order encountered.
167181
182 .. option:: --no-weak, -W
183
184 Don't print weak symbols.
185
168186 .. option:: --numeric-sort, -n, -v
169187
170188 Sort symbols by address.
171189
190 .. option:: --portability, -P
191
192 Use POSIX.2 output format. Alias for ``--format=posix``.
193
194 .. option:: --print-armap, -M
195
196 Print the archive symbol table, in addition to the symbols.
197
172198 .. option:: --print-file-name, -A, -o
173199
174200 Precede each symbol with the file it came from.
177203
178204 Show symbol size as well as address (not applicable for Mach-O).
179205
206 .. option:: --radix=, -t
207
208 Specify the radix of the symbol address(es). Values accepted are *d* (decimal),
209 *x* (hexadecimal) and *o* (octal).
210
211 .. option:: --reverse-sort, -r
212
213 Sort symbols in reverse order.
214
180215 .. option:: --size-sort
181216
182217 Sort symbols by size.
183218
219 .. option:: --special-syms
220
221 Ignored. For GNU compatibility only.
222
184223 .. option:: --undefined-only, -u
185224
186 Print only symbols referenced but not defined in this file.
187
188 .. option:: --radix=RADIX, -t
189
190 Specify the radix of the symbol address(es). Values accepted d(decimal),
191 x(hexadecimal) and o(octal).
225 Print only undefined symbols.
226
227 .. option:: --version
228
229 Display the version of this program. Does not stack with other commands.
230
231 .. option:: --without-aliases
232
233 Exclude aliases from the output.
192234
193235 .. option:: @
194236
195237 Read command-line options from response file ``.
238
239 MACH-O SPECIFIC OPTIONS
240 -----------------------
241
242 .. option:: --add-dyldinfo
243
244 Add symbols from the dyldinfo, if they are not already in the symbol table.
245 This is the default.
246
247 .. option:: --arch=
248
249 Dump the symbols from the specified architecture(s).
250
251 .. option:: --dyldinfo-only
252
253 Dump only symbols from the dyldinfo.
254
255 .. option:: --no-dyldinfo
256
257 Do not add any symbols from the dyldinfo.
258
259 .. option:: -s=
260
261 Dump only symbols from this segment and section name.
262
263 .. option:: -x
264
265 Print symbol entry in hex.
196266
197267 BUGS
198268 ----