source: rtems/doc/develenv/utils.texi @ 6449498

4.104.114.84.95
Last change on this file since 6449498 was 6449498, checked in by Joel Sherrill <joel.sherrill@…>, on Jan 17, 2002 at 9:47:47 PM

2001-01-17 Joel Sherrill <joel@…>

  • SUPPORT, LICENSE: New files.
  • Numerous files touched as part of merging the 4.5 branch onto the mainline development trunk and ensuring that the script that cuts snapshots and releases works on the documentation.
  • Property mode set to 100644
File size: 8.9 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-2002.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@ifinfo
10@node RTEMS Specific Utilities, RTEMS Specific Utilities C Language Specific Utilities, Sample Applications Paranoia Floating Point Application, Top
11@end ifinfo
12@chapter RTEMS Specific Utilities
13@ifinfo
14@menu
15* RTEMS Specific Utilities C Language Specific Utilities::
16* RTEMS Specific Utilities Ada Language Specific Utilities::
17@end menu
18@end ifinfo
19
20This section describes the additional commands
21available within the RTEMS Development Environment.  Although
22some of these commands are of general use, most are included to
23provide some capability necessary to perform a required function
24in the development of the RTEMS executive, one of its support
25components, or an RTEMS based application.  The commands have
26been classified into the following categories for clarity:
27
28@itemize @bullet
29@item C Language Specific Utilities
30
31@item Ada Language Specific Utilities
32@end itemize
33
34Some of the commands are implemented as C programs.
35However, most commands are implemented as Bourne shell scripts.
36Even if the current user has selected a different shell, the
37scripts will automatically invoke the Bourne shell during their
38execution lifetime.
39
40The commands are presented in UNIX manual page style
41for compatibility and convenience.  A standard set of paragraph
42headers were used for all of the command descriptions.  If a
43section contained no data, the paragraph header was omitted to
44conserve space.  Each of the permissible paragraph headers and
45their contents are described below:
46
47@table @code
48@item SYNOPSIS
49describes the command syntax
50
51@item DESCRIPTION
52a full description of the command
53
54@item OPTIONS
55describes each of the permissible options for the command
56
57@item NOTES
58lists any special noteworthy comments about the command
59
60@item ENVIRONMENT
61describes all environment variables utilized by the command
62
63@item EXAMPLES
64illustrates the use of the command with specific examples
65
66@item FILES
67provides a list of major files that the command references
68
69@item SEE ALSO
70lists any relevant commands which can be consulted
71@end table
72
73Most environment variables referenced by the commands
74are defined for the RTEMS Development Environment during the
75login procedure.  During login, the user selects a default RTEMS
76environment through the use of the Modules package.  This tool
77effectively sets the environment variables to provide a
78consistent development environment for a specific user.
79Additional environment variables within the RTEMS environment
80were set by the system administrator during installation.  When
81specifying paths, a command description makes use of these
82environment variables.
83
84When referencing other commands in the SEE ALSO
85paragraph, the following notation is used:   command(code).
86Where command is the name of a related command, and code is a
87section number.  Valid section numbers are as follows:
88
89@table @code
90@item 1
91Section 1 of the standard UNIX documentation
92
93@item  1G
94Section 1 of the GNU documentation
95
96@item  1R
97a manual page from this document, the RTEMS Development Environment Guide
98@end table
99
100For example, ls(1) means see the standard ls command
101in section 1 of the UNIX documentation.  gcc020(1G) means see
102the description of gcc020 in section 1 of the GNU documentation.
103
104@ifinfo
105@node RTEMS Specific Utilities C Language Specific Utilities, packhex - Compress Hexadecimal File, RTEMS Specific Utilities, RTEMS Specific Utilities
106@end ifinfo
107@section C Language Specific Utilities
108@ifinfo
109@menu
110* packhex - Compress Hexadecimal File::
111* unhex - Convert Hexadecimal File into Binary::
112* size_rtems - report RTEMS size information::
113@end menu
114@end ifinfo
115
116The C language utilities provide a powerful set of
117tools which combine to allow operations within the RTEMS
118Development Environment to be consistent and easy to use.  Much
119effort was devoted to providing as close to the standard UNIX
120and GNU style of operations as possible.  Each of these
121utilities are described in the section below.
122
123@ifinfo
124@node packhex - Compress Hexadecimal File, unhex - Convert Hexadecimal File into Binary, RTEMS Specific Utilities C Language Specific Utilities, RTEMS Specific Utilities C Language Specific Utilities
125@end ifinfo
126@subsection packhex - Compress Hexadecimal File
127
128@subheading SYNOPSIS
129
130@example
131packhex <source >destination
132@end example
133
134@subheading DESCRIPTION
135
136packhex accepts Intel Hexadecimal or Motorola Srecord
137on its standard input and attempts to pack as many contiguous
138bytes as possible into a single hexadecimal record.  Many
139programs output hexadecimal records which are less than 80 bytes
140long (for human viewing).  The overhead required by each
141unnecessary record is significant and packhex can often reduce
142the size of the download image by 20%.  packhex attempts to
143output records which are as long as the hexadecimal format
144allows.
145
146@subheading OPTIONS
147
148This command has no options.
149
150@subheading EXAMPLES
151
152Assume the current directory contains the Motorola
153Srecord file download.sr. Then executing the command:
154
155@example
156packhex <download.sr >packed.sr
157@end example
158
159will generate the file packed.sr which is usually
160smaller than download.sr.
161
162@subheading CREDITS
163
164The source for packhex first appeared in the May 1993
165issue of Embedded Systems magazine.  The code was downloaded
166from their BBS.  Unfortunately, the author's name was not
167provided in the listing.
168
169@ifinfo
170@node unhex - Convert Hexadecimal File into Binary, size_rtems - report RTEMS size information, packhex - Compress Hexadecimal File, RTEMS Specific Utilities C Language Specific Utilities
171@end ifinfo
172@subsection unhex - Convert Hexadecimal File into Binary Equivalent
173
174@subheading SYNOPSIS
175
176@example
177unhex [-valF] [-o file] [file [file ...] ]
178@end example
179
180@subheading DESCRIPTION
181
182unhex accepts Intel Hexadecimal, Motorola Srecord, or
183TI 'B' records and converts them to their binary equivalent.
184The output may sent to standout or may be placed in a specified
185file with the -o option.  The designated output file may not be
186an input file.  Multiple input files may be specified with their
187outputs logically concatenated into the output file.
188
189@subheading OPTIONS
190
191This command has the following options:
192
193@table @code
194@item v
195Verbose
196
197@item a base
198First byte of output corresponds with base
199address
200
201@item l
202Linear Output
203
204@item o file
205Output File
206
207@item F k_bits
208Fill holes in input with 0xFFs up to k_bits * 1024 bits
209@end table
210
211@subheading EXAMPLES
212
213The following command will create a binary equivalent
214file for the two Motorola S record files in the specified output
215file binary.bin:
216
217@example
218unhex -o binary.bin downloadA.sr downloadB.sr
219@end example
220
221@ifinfo
222@node size_rtems - report RTEMS size information, RTEMS Specific Utilities Ada Language Specific Utilities, unhex - Convert Hexadecimal File into Binary, RTEMS Specific Utilities C Language Specific Utilities
223@end ifinfo
224@subsection size_rtems - report RTEMS size information
225
226@subheading SYNOPSIS
227
228@example
229size_rtems
230@end example
231
232@subheading DESCRIPTION
233
234size_rtems analyzes RTEMS and determines all of the
235critical sizing information which is reported in the related
236documentation.
237
238@subheading EXAMPLES
239
240To generate the RTEMS size report for the currently
241configured processor, execute the following command:
242
243@example
244size_rtems
245@end example
246
247Although the actual size information will differ, a
248report of the following format will be output:
249
250@example
251     RTEMS SIZE REPORT
252
253CODE  DATA    BSS
254==================
255MANAGERS: 15988 0       0
256CORE    : 4568  0       0
257CPU     : 364   0       0
258OVERALL : 20556 0       0
259MINIMUM : 8752  0       0
260
261init    : 1592  0       0
262tasks   : 2440  0       0
263intr    : 64    0       0
264clock   : 2252  0       0
265sem     : 876   0       0
266msg     : 1624  0       0
267event   : 604   0       0
268signal  : 212   0       0
269part    : 872   0       0
270region  : 844   0       0
271dpmem   : 532   0       0
272timer   : 424   0       0
273io      : 288   0       0
274fatal   : 40    0       0
275rtmon   : 764   0       0
276mp      : 2984  0       0
277
278sem     : 4     0       0
279msg     : 4     0       0
280event   : 4     0       0
281signal  : 4     0       0
282part    : 4     0       0
283region  : 4     0       0
284timer   : 4     0       0
285dpmem   : 4     0       0
286io      : 4     0       0
287rtmon   : 4     0       0
288mp      : 8     0       0
289@end example
290
291@subheading SEE ALSO
292
293gsize020(1G), gsize386(1G), gsize960(1G)
294
295
296@ifinfo
297@node RTEMS Specific Utilities Ada Language Specific Utilities, Command and Variable Index, size_rtems - report RTEMS size information, RTEMS Specific Utilities
298@end ifinfo
299@section Ada Language Specific Utilities
300
301The Ada language utilities provide a powerful set of
302tools which combine to allow operations within the RTEMS
303Development Environment to be consistent and easy to use.  Much
304effort was devoted to providing as close to the standard UNIX
305and GNU style of operations as possible.  Each of these
306utilities are described in the section below.
307
308NOTE:  The Ada implementation is not included in this
309release.
310
311
312
Note: See TracBrowser for help on using the repository browser.