source: rtems/doc/develenv/utils.t @ aa41429

4.104.114.84.95
Last change on this file since aa41429 was aa41429, checked in by Joel Sherrill <joel.sherrill@…>, on Feb 18, 2003 at 4:16:12 PM

2003-02-18 Joel Sherrill <joel@…>

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