1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
@c ----------------------------------------------------------------------------
@c This is the Texinfo source file for the gp-display-src man page.
@c
@c Author: Ruud van der Pas
@c ----------------------------------------------------------------------------
@ifset man
\input texinfo @c -*-texinfo-*-
@setfilename gp-display-src
@settitle Display source code and optionally disassembly of the target object
@include gp-macros.texi
@end ifset
@c ----------------------------------------------------------------------------
@c This is from the man-pages(7) man page
@c
@c "The list below shows conventional or suggested sections. Most manual pages
@c should include at least the highlighted sections. Arrange a new manual
@c page so that sections are placed in the order shown in the list."
@c
@c NAME
@c SYNOPSIS
@c CONFIGURATION [Normally only in Section 4]
@c DESCRIPTION
@c OPTIONS [Normally only in Sections 1, 8]
@c EXIT STATUS [Normally only in Sections 1, 8]
@c RETURN VALUE [Normally only in Sections 2, 3]
@c ERRORS [Typically only in Sections 2, 3]
@c ENVIRONMENT
@c FILES
@c VERSIONS [Normally only in Sections 2, 3]
@c ATTRIBUTES [Normally only in Sections 2, 3]
@c CONFORMING TO
@c NOTES
@c BUGS
@c EXAMPLES
@c AUTHORS [Discouraged]
@c REPORTING BUGS [Not used in man-pages]
@c COPYRIGHT [Not used in man-pages]
@c SEE ALSO
@c
@c This is what the texi2pod.pl tool recognizes:
@c
@c for $sect (qw(NAME SYNOPSIS TARGET DESCRIPTION OPTIONS ENVIRONMENT FILES
@c BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) {
@c
@c What is interesting is that it places "SEE ALSO" before "COPYRIGHT", which
@c makes sense and adhered to for the other formats.
@c ----------------------------------------------------------------------------
@c ----------------------------------------------------------------------------
@c NAME section
@c ----------------------------------------------------------------------------
@ManPageStart{NAME}
@c man begin NAME
gp-display-src - Display the source code, optionally interleaved with the
disassembly of the target object
@c man end
@ManPageEnd{}
@c ----------------------------------------------------------------------------
@c SYNOPSIS section
@c ----------------------------------------------------------------------------
@ManPageStart{SYNOPSIS}
@c man begin SYNOPSIS
@command{gprofng display src} [@var{option(s)}] @var{target-file}
@c man end
@ManPageEnd{}
@c ----------------------------------------------------------------------------
@c DESCRIPTION section
@c ----------------------------------------------------------------------------
@ManPageStart{DESCRIPTION}
@c man begin DESCRIPTION
Display the source code listing, or source code interleaved with disassembly
code, as extracted from the target file (an executable, shared object, object
file, or a Java .class file).
For example, this command displays the source code and disassembly listing for
a function called @samp{mxv_core} that is part of object file @samp{mxv.o}:
@smallexample
$ gprofng display src -disasm mxv_core mxv.o
@end smallexample
To list the source code and disassembly for all the functions in this file,
use the following command:
@smallexample
$ gprofng display src -disasm all -1 mxv.o
@end smallexample
The @var{target-file} is the name of an executable, a shared object, an object
file (.o), or a Java .class file.
If no options are given, the source code listing of the @var{target-file}
is shown. This is equivalent to @samp{-source all -1}. If this information
is not available, a message to this extent is printed.
@c man end
@ManPageEnd{}
@c ----------------------------------------------------------------------------
@c OPTIONS section
@c ----------------------------------------------------------------------------
@ManPageStart{OPTIONS}
@c man begin OPTIONS
@table @gcctabopt
@item --version
@ifclear man
@IndexSubentry{Options, @code{--version}}
@end ifclear
Print the version number and exit.
@item --help
@ifclear man
@IndexSubentry{Options, @code{--help}}
@end ifclear
Print usage information and exit.
@item -functions
@ifclear man
@IndexSubentry{Options, @code{-functions}}
@IndexSubentry{Commands, @code{functions}}
@end ifclear
List all the functions from the given object.
@item -source @var{item} @var{tag}
@ifclear man
@IndexSubentry{Options, @code{-source}}
@IndexSubentry{Commands, @code{source}}
@end ifclear
Show the source code for @var{item} in @var{target-file}. The @var{tag}
is used to differentiate in case there are multiple occurences with the same
name.
See the @samp{NOTES} section for the definition of @var{item} and @var{tag}.
@item -disasm @var{item} @var{tag}
@ifclear man
@IndexSubentry{Options, @code{-disasm}}
@IndexSubentry{Commands, @code{disasm}}
@end ifclear
Include the disassembly in the source listing. The default listing does not
include the disassembly. If the source code is not available, show a listing
of the disassembly only.
See the @samp{NOTES} section for the definition of @var{item} and @var{tag}.
@item -outfile @var{filename}
@ifclear man
@IndexSubentry{Options, @code{-outfile}}
@IndexSubentry{Commands, @code{outfile}}
@end ifclear
Write results to file @var{filename}. A dash (@minus{}) writes to stdout.
This is also the default. Note that this option only affects those options
included to the right of the option.
@end table
@c man end
@ManPageEnd{}
@c ----------------------------------------------------------------------------
@c NOTES section
@c ----------------------------------------------------------------------------
@ManPageStart{NOTES}
@c man begin NOTES
Use @var{item} to specify the name of a function, or of a source or object
file that was used to build the executable, or shared object.
The @var{tag} is an index used to determine which item is being referred
to when multiple functions have the same name. It is required, but will
be ignored if not necessary to resolve the function.
The @var{item} may also be specified in the form @samp{function`file`}, in
which case the source or disassembly of the named function in the source
context of the named file will be used.
The special @var{item} and @var{tag} combination @samp{all -1}, is used to
indicate generating the source, or disassembly, for all functions in the
@var{target-file}.
@c man end
@ManPageEnd{}
@c ----------------------------------------------------------------------------
@c SEEALSO section
@c ----------------------------------------------------------------------------
@ManPageStart{SEE ALSO}
@c man begin SEEALSO
gprofng(1),
gp-archive(1),
gp-collect-app(1),
gp-display-gui(1),
gp-display-html(1),
gp-display-text(1)
@iftex
@vspace{1}
@end iftex
The user guide for gprofng is maintained as a Texinfo manual. If the info
and gprofng programs are correctly installed, the command
@command{info gprofng} should give access to this document.
@c man end
@ManPageEnd{}
@c ----------------------------------------------------------------------------
@c COPYRIGHT section
@c ----------------------------------------------------------------------------
@ManPageStart{COPYRIGHT}
@c man begin COPYRIGHT
Copyright @copyright{} 2022-2024 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, with no Front-Cover Texts, and with no
Back-Cover Texts. A copy of the license is included in the
section entitled ``GNU Free Documentation License''.
@c man end
@ManPageEnd{}
@c ----------------------------------------------------------------------------
@c If this text is used for a man page, exit. Otherwise we need to continue.
@c ----------------------------------------------------------------------------
@ifset man
@bye
@end ifset
|
