Commit | Line | Data |
---|---|---|
027e2a04 | 1 | .\" Copyright (c) 1993, 2004 Free Software Foundation |
c906108c SS |
2 | .\" See section COPYING for conditions for redistribution |
3 | .TH run 1 "13oct1993" "GNU Tools" "GNU Tools" | |
4 | .de BP | |
5 | .sp | |
6 | .ti -.2i | |
7 | \(** | |
8 | .. | |
9 | ||
10 | .SH NAME | |
11 | run\(em\&Simulator front-end | |
12 | ||
13 | .SH SYNOPSIS | |
14 | .hy 0 | |
15 | .na | |
16 | .TP | |
17 | .B run | |
18 | .RB "[\|" \-v "\|]" | |
19 | ." .RB "[\|" \-t "\|]" | |
20 | .RB "[\|" \-p | |
21 | .IR freq "\|]" | |
22 | .RB "[\|" \-m | |
23 | .IR memory "\|]" | |
027e2a04 HPN |
24 | .RB "[\|" \--sysroot |
25 | .IR filepath "\|]" | |
c906108c SS |
26 | .I program |
27 | .ad b | |
28 | .hy 1 | |
29 | .SH DESCRIPTION | |
30 | ||
31 | Use `\|\c | |
32 | .BI run " program"\c | |
33 | \&\|' to execute a binary by interpreting machine instructions on your | |
34 | host computer. | |
35 | ||
36 | .B run | |
37 | is the same emulator used by GDB's `\|\c | |
38 | .B target sim\c | |
39 | \&\|' command. You can run it directly by executing | |
40 | .B run | |
41 | if you just want to see your program execute, and do not need any | |
42 | debugger functionality. You can also use | |
43 | .B run | |
44 | to generate profiling information for analysis with | |
45 | .BR gprof . | |
46 | ||
47 | .SH OPTIONS | |
48 | ||
49 | .TP | |
50 | .B \-v | |
51 | Verbose output. Display the name of the program to run before | |
52 | execution; after execution, display the number of instructions | |
53 | executed, the number of machine cycles emulated, the number of | |
54 | pipeline stalls, the real time taken, the emulated execution time | |
55 | taken, and a summary of how much profiling information was generated. | |
56 | ." | |
57 | ." .TP | |
58 | ." .B \-t | |
59 | ." `trace', calls a sim_trace routine that does nothing. | |
60 | ||
61 | .TP | |
62 | .BI \-p " freq" | |
63 | Generate profile information (for use with | |
64 | .B gprof\c | |
65 | \&). | |
66 | .I freq | |
67 | is the profiling frequency. Write the profiling information to a file called | |
68 | .BR gmon.out . | |
69 | ||
70 | .TP | |
71 | .BI \-m " memory" | |
72 | Set the memory size for the emulated machine to two to the power | |
73 | .IR memory . | |
74 | The default value is 19, emulating a board with 524288 bytes of memory. | |
75 | ||
027e2a04 HPN |
76 | .TP |
77 | .BI \--sysroot " filepath" | |
78 | Prepend | |
79 | .IR filepath | |
80 | to all simulator system calls that pass absolute file paths. | |
81 | Change working directory to | |
82 | .IR filepath | |
83 | at program start. Not all simulators support this option; those | |
84 | that don't, will ignore it. | |
85 | ||
c906108c SS |
86 | .PP |
87 | ||
88 | .SH "SEE ALSO" | |
89 | .RB "`\|" gprof "\|'" | |
90 | entry in | |
91 | .B info\c | |
92 | \&; | |
93 | .RB "`\|" gdb "\|'" | |
94 | entry in | |
95 | .B info\c | |
96 | \&; | |
97 | .I | |
98 | Using GDB: A Guide to the GNU Source-Level Debugger\c | |
99 | , Richard M. Stallman and Roland H. Pesch. | |
100 | ||
101 | .SH COPYING | |
2a1aa0e9 | 102 | Copyright (c) 1993, 2000 Free Software Foundation, Inc. |
c906108c | 103 | .PP |
2a1aa0e9 NC |
104 | This document is distributed under the terms of the GNU Free |
105 | Documentation License, version 1.1. That license is described in the | |
106 | sources for this manual page, but it is not displayed here in order to | |
107 | make this manual more consise. Copies of this license can also be | |
108 | obtained from: http://www.gnu.org/copyleft/. | |
109 | ||
110 | \" GNU Free Documentation License | |
111 | \" Version 1.1, March 2000 | |
112 | ||
113 | \" Copyright (C) 2000 Free Software Foundation, Inc. | |
114 | \" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
115 | ||
116 | \" Everyone is permitted to copy and distribute verbatim | |
117 | \" copies of this license document, but changing it is | |
118 | \" not allowed. | |
119 | \" .PP | |
120 | \" 0. PREAMBLE | |
121 | \" .PP | |
122 | \" The purpose of this License is to make a manual, textbook, or other | |
123 | \" written document "free" in the sense of freedom: to assure everyone | |
124 | \" the effective freedom to copy and redistribute it, with or without | |
125 | \" modifying it, either commercially or noncommercially. Secondarily, | |
126 | \" this License preserves for the author and publisher a way to get | |
127 | \" credit for their work, while not being considered responsible for | |
128 | \" modifications made by others. | |
129 | \" .PP | |
130 | \" This License is a kind of "copyleft", which means that derivative | |
131 | \" works of the document must themselves be free in the same sense. It | |
132 | \" complements the GNU General Public License, which is a copyleft | |
133 | \" license designed for free software. | |
134 | \" .PP | |
135 | \" We have designed this License in order to use it for manuals for free | |
136 | \" software, because free software needs free documentation: a free | |
137 | \" program should come with manuals providing the same freedoms that the | |
138 | \" software does. But this License is not limited to software manuals; | |
139 | \" it can be used for any textual work, regardless of subject matter or | |
140 | \" whether it is published as a printed book. We recommend this License | |
141 | \" principally for works whose purpose is instruction or reference. | |
142 | \" .PP | |
143 | \" 1. APPLICABILITY AND DEFINITIONS | |
144 | \" .PP | |
145 | \" This License applies to any manual or other work that contains a | |
146 | \" notice placed by the copyright holder saying it can be distributed | |
147 | \" under the terms of this License. The "Document", below, refers to any | |
148 | \" such manual or work. Any member of the public is a licensee, and is | |
149 | \" addressed as "you". | |
150 | \" .PP | |
151 | \" A "Modified Version" of the Document means any work containing the | |
152 | \" Document or a portion of it, either copied verbatim, or with | |
153 | \" modifications and/or translated into another language. | |
154 | \" .PP | |
155 | \" A "Secondary Section" is a named appendix or a front-matter section of | |
156 | \" the Document that deals exclusively with the relationship of the | |
157 | \" publishers or authors of the Document to the Document's overall subject | |
158 | \" (or to related matters) and contains nothing that could fall directly | |
159 | \" within that overall subject. (For example, if the Document is in part a | |
160 | \" textbook of mathematics, a Secondary Section may not explain any | |
161 | \" mathematics.) The relationship could be a matter of historical | |
162 | \" connection with the subject or with related matters, or of legal, | |
163 | \" commercial, philosophical, ethical or political position regarding | |
164 | \" them. | |
165 | \" .PP | |
166 | \" The "Invariant Sections" are certain Secondary Sections whose titles | |
167 | \" are designated, as being those of Invariant Sections, in the notice | |
168 | \" that says that the Document is released under this License. | |
169 | \" .PP | |
170 | \" The "Cover Texts" are certain short passages of text that are listed, | |
171 | \" as Front-Cover Texts or Back-Cover Texts, in the notice that says that | |
172 | \" the Document is released under this License. | |
173 | \" .PP | |
174 | \" A "Transparent" copy of the Document means a machine-readable copy, | |
175 | \" represented in a format whose specification is available to the | |
176 | \" general public, whose contents can be viewed and edited directly and | |
177 | \" straightforwardly with generic text editors or (for images composed of | |
178 | \" pixels) generic paint programs or (for drawings) some widely available | |
179 | \" drawing editor, and that is suitable for input to text formatters or | |
180 | \" for automatic translation to a variety of formats suitable for input | |
181 | \" to text formatters. A copy made in an otherwise Transparent file | |
182 | \" format whose markup has been designed to thwart or discourage | |
183 | \" subsequent modification by readers is not Transparent. A copy that is | |
184 | \" not "Transparent" is called "Opaque". | |
185 | \" .PP | |
186 | \" Examples of suitable formats for Transparent copies include plain | |
187 | \" ASCII without markup, Texinfo input format, LaTeX input format, SGML | |
188 | \" or XML using a publicly available DTD, and standard-conforming simple | |
189 | \" HTML designed for human modification. Opaque formats include | |
190 | \" PostScript, PDF, proprietary formats that can be read and edited only | |
191 | \" by proprietary word processors, SGML or XML for which the DTD and/or | |
192 | \" processing tools are not generally available, and the | |
193 | \" machine-generated HTML produced by some word processors for output | |
194 | \" purposes only. | |
195 | \" .PP | |
196 | \" The "Title Page" means, for a printed book, the title page itself, | |
197 | \" plus such following pages as are needed to hold, legibly, the material | |
198 | \" this License requires to appear in the title page. For works in | |
199 | \" formats which do not have any title page as such, "Title Page" means | |
200 | \" the text near the most prominent appearance of the work's title, | |
201 | \" preceding the beginning of the body of the text. | |
202 | \" .PP | |
203 | \" 2. VERBATIM COPYING | |
204 | \" .PP | |
205 | \" You may copy and distribute the Document in any medium, either | |
206 | \" commercially or noncommercially, provided that this License, the | |
207 | \" copyright notices, and the license notice saying this License applies | |
208 | \" to the Document are reproduced in all copies, and that you add no other | |
209 | \" conditions whatsoever to those of this License. You may not use | |
210 | \" technical measures to obstruct or control the reading or further | |
211 | \" copying of the copies you make or distribute. However, you may accept | |
212 | \" compensation in exchange for copies. If you distribute a large enough | |
213 | \" number of copies you must also follow the conditions in section 3. | |
214 | \" .PP | |
215 | \" You may also lend copies, under the same conditions stated above, and | |
216 | \" you may publicly display copies. | |
217 | \" .PP | |
218 | \" 3. COPYING IN QUANTITY | |
219 | \" .PP | |
220 | \" If you publish printed copies of the Document numbering more than 100, | |
221 | \" and the Document's license notice requires Cover Texts, you must enclose | |
222 | \" the copies in covers that carry, clearly and legibly, all these Cover | |
223 | \" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on | |
224 | \" the back cover. Both covers must also clearly and legibly identify | |
225 | \" you as the publisher of these copies. The front cover must present | |
226 | \" the full title with all words of the title equally prominent and | |
227 | \" visible. You may add other material on the covers in addition. | |
228 | \" Copying with changes limited to the covers, as long as they preserve | |
229 | \" the title of the Document and satisfy these conditions, can be treated | |
230 | \" as verbatim copying in other respects. | |
231 | \" .PP | |
232 | \" If the required texts for either cover are too voluminous to fit | |
233 | \" legibly, you should put the first ones listed (as many as fit | |
234 | \" reasonably) on the actual cover, and continue the rest onto adjacent | |
235 | \" pages. | |
236 | \" .PP | |
237 | \" If you publish or distribute Opaque copies of the Document numbering | |
238 | \" more than 100, you must either include a machine-readable Transparent | |
239 | \" copy along with each Opaque copy, or state in or with each Opaque copy | |
240 | \" a publicly-accessible computer-network location containing a complete | |
241 | \" Transparent copy of the Document, free of added material, which the | |
242 | \" general network-using public has access to download anonymously at no | |
243 | \" charge using public-standard network protocols. If you use the latter | |
244 | \" option, you must take reasonably prudent steps, when you begin | |
245 | \" distribution of Opaque copies in quantity, to ensure that this | |
246 | \" Transparent copy will remain thus accessible at the stated location | |
247 | \" until at least one year after the last time you distribute an Opaque | |
248 | \" copy (directly or through your agents or retailers) of that edition to | |
249 | \" the public. | |
250 | \" .PP | |
251 | \" It is requested, but not required, that you contact the authors of the | |
252 | \" Document well before redistributing any large number of copies, to give | |
253 | \" them a chance to provide you with an updated version of the Document. | |
254 | \" .PP | |
255 | \" 4. MODIFICATIONS | |
256 | \" .PP | |
257 | \" You may copy and distribute a Modified Version of the Document under | |
258 | \" the conditions of sections 2 and 3 above, provided that you release | |
259 | \" the Modified Version under precisely this License, with the Modified | |
260 | \" Version filling the role of the Document, thus licensing distribution | |
261 | \" and modification of the Modified Version to whoever possesses a copy | |
262 | \" of it. In addition, you must do these things in the Modified Version: | |
263 | \" .PP | |
264 | \" A. Use in the Title Page (and on the covers, if any) a title distinct | |
265 | \" from that of the Document, and from those of previous versions | |
266 | \" (which should, if there were any, be listed in the History section | |
267 | \" of the Document). You may use the same title as a previous version | |
268 | \" if the original publisher of that version gives permission. | |
269 | \" .PP | |
270 | \" B. List on the Title Page, as authors, one or more persons or entities | |
271 | \" responsible for authorship of the modifications in the Modified | |
272 | \" Version, together with at least five of the principal authors of the | |
273 | \" Document (all of its principal authors, if it has less than five). | |
274 | \" .PP | |
275 | \" C. State on the Title page the name of the publisher of the | |
276 | \" Modified Version, as the publisher. | |
277 | \" .PP | |
278 | \" D. Preserve all the copyright notices of the Document. | |
279 | \" .PP | |
280 | \" E. Add an appropriate copyright notice for your modifications | |
281 | \" adjacent to the other copyright notices. | |
282 | \" .PP | |
283 | \" F. Include, immediately after the copyright notices, a license notice | |
284 | \" giving the public permission to use the Modified Version under the | |
285 | \" terms of this License, in the form shown in the Addendum below. | |
286 | \" Preserve in that license notice the full lists of Invariant Sections | |
287 | \" and required Cover Texts given in the Document's license notice. | |
288 | \" .PP | |
289 | \" H. Include an unaltered copy of this License. | |
290 | \" .PP | |
291 | \" I. Preserve the section entitled "History", and its title, and add to | |
292 | \" it an item stating at least the title, year, new authors, and | |
293 | \" publisher of the Modified Version as given on the Title Page. If | |
294 | \" there is no section entitled "History" in the Document, create one | |
295 | \" stating the title, year, authors, and publisher of the Document as | |
296 | \" given on its Title Page, then add an item describing the Modified | |
297 | \" Version as stated in the previous sentence. | |
298 | \" .PP | |
299 | \" J. Preserve the network location, if any, given in the Document for | |
300 | \" public access to a Transparent copy of the Document, and likewise | |
301 | \" the network locations given in the Document for previous versions | |
302 | \" it was based on. These may be placed in the "History" section. | |
303 | \" You may omit a network location for a work that was published at | |
304 | \" least four years before the Document itself, or if the original | |
305 | \" publisher of the version it refers to gives permission. | |
306 | \" .PP | |
307 | \" K. In any section entitled "Acknowledgements" or "Dedications", | |
308 | \" preserve the section's title, and preserve in the section all the | |
309 | \" substance and tone of each of the contributor acknowledgements | |
310 | \" and/or dedications given therein. | |
311 | \" .PP | |
312 | \" L. Preserve all the Invariant Sections of the Document, | |
313 | \" unaltered in their text and in their titles. Section numbers | |
314 | \" or the equivalent are not considered part of the section titles. | |
315 | \" .PP | |
316 | \" M. Delete any section entitled "Endorsements". Such a section | |
317 | \" may not be included in the Modified Version. | |
318 | \" .PP | |
319 | \" N. Do not retitle any existing section as "Endorsements" | |
320 | \" or to conflict in title with any Invariant Section. | |
321 | \" .PP | |
322 | \" If the Modified Version includes new front-matter sections or | |
323 | \" appendices that qualify as Secondary Sections and contain no material | |
324 | \" copied from the Document, you may at your option designate some or all | |
325 | \" of these sections as invariant. To do this, add their titles to the | |
326 | \" list of Invariant Sections in the Modified Version's license notice. | |
327 | \" These titles must be distinct from any other section titles. | |
328 | \" .PP | |
329 | \" You may add a section entitled "Endorsements", provided it contains | |
330 | \" nothing but endorsements of your Modified Version by various | |
331 | \" parties--for example, statements of peer review or that the text has | |
332 | \" been approved by an organization as the authoritative definition of a | |
333 | \" standard. | |
334 | \" .PP | |
335 | \" You may add a passage of up to five words as a Front-Cover Text, and a | |
336 | \" passage of up to 25 words as a Back-Cover Text, to the end of the list | |
337 | \" of Cover Texts in the Modified Version. Only one passage of | |
338 | \" Front-Cover Text and one of Back-Cover Text may be added by (or | |
339 | \" through arrangements made by) any one entity. If the Document already | |
340 | \" includes a cover text for the same cover, previously added by you or | |
341 | \" by arrangement made by the same entity you are acting on behalf of, | |
342 | \" you may not add another; but you may replace the old one, on explicit | |
343 | \" permission from the previous publisher that added the old one. | |
344 | \" .PP | |
345 | \" The author(s) and publisher(s) of the Document do not by this License | |
346 | \" give permission to use their names for publicity for or to assert or | |
347 | \" imply endorsement of any Modified Version. | |
348 | \" .PP | |
349 | ||
350 | \" 5. COMBINING DOCUMENTS | |
351 | \" .PP | |
352 | \" You may combine the Document with other documents released under this | |
353 | \" License, under the terms defined in section 4 above for modified | |
354 | \" versions, provided that you include in the combination all of the | |
355 | \" Invariant Sections of all of the original documents, unmodified, and | |
356 | \" list them all as Invariant Sections of your combined work in its | |
357 | \" license notice. | |
358 | \" .PP | |
359 | \" The combined work need only contain one copy of this License, and | |
360 | \" multiple identical Invariant Sections may be replaced with a single | |
361 | \" copy. If there are multiple Invariant Sections with the same name but | |
362 | \" different contents, make the title of each such section unique by | |
363 | \" adding at the end of it, in parentheses, the name of the original | |
364 | \" author or publisher of that section if known, or else a unique number. | |
365 | \" Make the same adjustment to the section titles in the list of | |
366 | \" Invariant Sections in the license notice of the combined work. | |
367 | \" .PP | |
368 | \" In the combination, you must combine any sections entitled "History" | |
369 | \" in the various original documents, forming one section entitled | |
370 | \" "History"; likewise combine any sections entitled "Acknowledgements", | |
371 | \" and any sections entitled "Dedications". You must delete all sections | |
372 | \" entitled "Endorsements." | |
373 | \" .PP | |
374 | ||
375 | \" 6. COLLECTIONS OF DOCUMENTS | |
376 | \" .PP | |
377 | \" You may make a collection consisting of the Document and other documents | |
378 | \" released under this License, and replace the individual copies of this | |
379 | \" License in the various documents with a single copy that is included in | |
380 | \" the collection, provided that you follow the rules of this License for | |
381 | \" verbatim copying of each of the documents in all other respects. | |
382 | \" .PP | |
383 | \" You may extract a single document from such a collection, and distribute | |
384 | \" it individually under this License, provided you insert a copy of this | |
385 | \" License into the extracted document, and follow this License in all | |
386 | \" other respects regarding verbatim copying of that document. | |
387 | \" .PP | |
388 | ||
389 | \" 7. AGGREGATION WITH INDEPENDENT WORKS | |
390 | \" .PP | |
391 | \" A compilation of the Document or its derivatives with other separate | |
392 | \" and independent documents or works, in or on a volume of a storage or | |
393 | \" distribution medium, does not as a whole count as a Modified Version | |
394 | \" of the Document, provided no compilation copyright is claimed for the | |
395 | \" compilation. Such a compilation is called an "aggregate", and this | |
396 | \" License does not apply to the other self-contained works thus compiled | |
397 | \" with the Document, on account of their being thus compiled, if they | |
398 | \" are not themselves derivative works of the Document. | |
399 | \" .PP | |
400 | \" If the Cover Text requirement of section 3 is applicable to these | |
401 | \" copies of the Document, then if the Document is less than one quarter | |
402 | \" of the entire aggregate, the Document's Cover Texts may be placed on | |
403 | \" covers that surround only the Document within the aggregate. | |
404 | \" Otherwise they must appear on covers around the whole aggregate. | |
405 | \" .PP | |
406 | ||
407 | \" 8. TRANSLATION | |
408 | \" .PP | |
409 | \" Translation is considered a kind of modification, so you may | |
410 | \" distribute translations of the Document under the terms of section 4. | |
411 | \" Replacing Invariant Sections with translations requires special | |
412 | \" permission from their copyright holders, but you may include | |
413 | \" translations of some or all Invariant Sections in addition to the | |
414 | \" original versions of these Invariant Sections. You may include a | |
415 | \" translation of this License provided that you also include the | |
416 | \" original English version of this License. In case of a disagreement | |
417 | \" between the translation and the original English version of this | |
418 | \" License, the original English version will prevail. | |
419 | \" .PP | |
420 | ||
421 | \" 9. TERMINATION | |
422 | \" .PP | |
423 | \" You may not copy, modify, sublicense, or distribute the Document except | |
424 | \" as expressly provided for under this License. Any other attempt to | |
425 | \" copy, modify, sublicense or distribute the Document is void, and will | |
426 | \" automatically terminate your rights under this License. However, | |
427 | \" parties who have received copies, or rights, from you under this | |
428 | \" License will not have their licenses terminated so long as such | |
429 | \" parties remain in full compliance. | |
430 | \" .PP | |
c906108c | 431 | |
2a1aa0e9 NC |
432 | \" 10. FUTURE REVISIONS OF THIS LICENSE |
433 | \" .PP | |
434 | \" The Free Software Foundation may publish new, revised versions | |
435 | \" of the GNU Free Documentation License from time to time. Such new | |
436 | \" versions will be similar in spirit to the present version, but may | |
437 | \" differ in detail to address new problems or concerns. See | |
438 | \" http://www.gnu.org/copyleft/. | |
439 | \" .PP | |
440 | \" Each version of the License is given a distinguishing version number. | |
441 | \" If the Document specifies that a particular numbered version of this | |
442 | \" License "or any later version" applies to it, you have the option of | |
443 | \" following the terms and conditions either of that specified version or | |
444 | \" of any later version that has been published (not as a draft) by the | |
445 | \" Free Software Foundation. If the Document does not specify a version | |
446 | \" number of this License, you may choose any version ever published (not | |
447 | \" as a draft) by the Free Software Foundation. | |
448 | \" .PP | |
c906108c | 449 | |
2a1aa0e9 NC |
450 | \" ADDENDUM: How to use this License for your documents |
451 | \" .PP | |
452 | \" To use this License in a document you have written, include a copy of | |
453 | \" the License in the document and put the following copyright and | |
454 | \" license notices just after the title page: | |
455 | \" .PP | |
456 | \" Copyright (c) YEAR YOUR NAME. | |
457 | \" Permission is granted to copy, distribute and/or | |
458 | \" modify this document under the terms of the GNU | |
459 | \" Free Documentation License, Version 1.1 or any later | |
460 | \" version published by the Free Software Foundation; | |
461 | \" with the Invariant Sections being LIST THEIR TITLES, | |
462 | \" with the Front-Cover Texts being LIST, and with the | |
463 | \" Back-Cover Texts being LIST. A copy of the license | |
464 | \" is included in the section entitled "GNU Free | |
465 | \" Documentation License". | |
466 | \" .PP | |
467 | \" If you have no Invariant Sections, write "with no Invariant Sections" | |
468 | \" instead of saying which ones are invariant. If you have no | |
469 | \" Front-Cover Texts, write "no Front-Cover Texts" instead of | |
470 | \" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. | |
471 | \" .PP | |
472 | \" If your document contains nontrivial examples of program code, we | |
473 | \" recommend releasing these examples in parallel under your choice of | |
474 | \" free software license, such as the GNU General Public License, | |
475 | \" to permit their use in free software. |