source: rtems/doc/develenv/utils.t @ 818ab36a

4.104.114.84.95
Last change on this file since 818ab36a was 818ab36a, checked in by Joel Sherrill <joel.sherrill@…>, on Mar 24, 2003 at 4:40:49 PM

2003-03-24 Joel Sherrill <joel@…>

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