1 | .. comment SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
2 | |
---|
3 | RTEMS Specific Utilities |
---|
4 | ######################## |
---|
5 | |
---|
6 | This section describes the additional commands |
---|
7 | available within the *RTEMS Development Environment*. Although |
---|
8 | some of these commands are of general use, most are included to |
---|
9 | provide some capability necessary to perform a required function |
---|
10 | in the development of the RTEMS executive, one of its support |
---|
11 | components, or an RTEMS based application. |
---|
12 | |
---|
13 | Some of the commands are implemented as C programs. |
---|
14 | However, most commands are implemented as Bourne shell scripts. |
---|
15 | Even if the current user has selected a different shell, the |
---|
16 | scripts will automatically invoke the Bourne shell during their |
---|
17 | execution lifetime. |
---|
18 | |
---|
19 | The commands are presented in UNIX manual page style |
---|
20 | for compatibility and convenience. A standard set of paragraph |
---|
21 | headers were used for all of the command descriptions. If a |
---|
22 | section contained no data, the paragraph header was omitted to |
---|
23 | conserve space. Each of the permissible paragraph headers and |
---|
24 | their contents are described below: |
---|
25 | |
---|
26 | ``SYNOPSIS`` |
---|
27 | describes the command syntax |
---|
28 | |
---|
29 | ``DESCRIPTION`` |
---|
30 | a full description of the command |
---|
31 | |
---|
32 | ``OPTIONS`` |
---|
33 | describes each of the permissible options for the command |
---|
34 | |
---|
35 | ``NOTES`` |
---|
36 | lists any special noteworthy comments about the command |
---|
37 | |
---|
38 | ``ENVIRONMENT`` |
---|
39 | describes all environment variables utilized by the command |
---|
40 | |
---|
41 | ``EXAMPLES`` |
---|
42 | illustrates the use of the command with specific examples |
---|
43 | |
---|
44 | ``FILES`` |
---|
45 | provides a list of major files that the command references |
---|
46 | |
---|
47 | ``SEE ALSO`` |
---|
48 | lists any relevant commands which can be consulted |
---|
49 | |
---|
50 | Most environment variables referenced by the commands |
---|
51 | are defined for the RTEMS Development Environment during the |
---|
52 | login procedure. During login, the user selects a default RTEMS |
---|
53 | environment through the use of the Modules package. This tool |
---|
54 | effectively sets the environment variables to provide a |
---|
55 | consistent development environment for a specific user. |
---|
56 | Additional environment variables within the RTEMS environment |
---|
57 | were set by the system administrator during installation. When |
---|
58 | specifying paths, a command description makes use of these |
---|
59 | environment variables. |
---|
60 | |
---|
61 | When referencing other commands in the SEE ALSO |
---|
62 | paragraph, the following notation is used: command(code). |
---|
63 | Where command is the name of a related command, and code is a |
---|
64 | section number. Valid section numbers are as follows: |
---|
65 | |
---|
66 | ``1`` |
---|
67 | Section 1 of the standard UNIX documentation |
---|
68 | |
---|
69 | ``1G`` |
---|
70 | Section 1 of the GNU documentation |
---|
71 | |
---|
72 | ``1R`` |
---|
73 | a manual page from this document, the RTEMS Development Environment Guide |
---|
74 | |
---|
75 | For example, ls(1) means see the standard ls command |
---|
76 | in section 1 of the UNIX documentation. gcc020(1G) means see |
---|
77 | the description of gcc020 in section 1 of the GNU documentation. |
---|
78 | |
---|
79 | .. COMMENT: packhex |
---|
80 | |
---|
81 | packhex - Compress Hexadecimal File |
---|
82 | =================================== |
---|
83 | |
---|
84 | **SYNOPSIS** |
---|
85 | |
---|
86 | .. code:: c |
---|
87 | |
---|
88 | packhex <source >destination |
---|
89 | |
---|
90 | **DESCRIPTION** |
---|
91 | |
---|
92 | packhex accepts Intel Hexadecimal or Motorola Srecord |
---|
93 | on its standard input and attempts to pack as many contiguous |
---|
94 | bytes as possible into a single hexadecimal record. Many |
---|
95 | programs output hexadecimal records which are less than 80 bytes |
---|
96 | long (for human viewing). The overhead required by each |
---|
97 | unnecessary record is significant and packhex can often reduce |
---|
98 | the size of the download image by 20%. packhex attempts to |
---|
99 | output records which are as long as the hexadecimal format |
---|
100 | allows. |
---|
101 | |
---|
102 | **OPTIONS** |
---|
103 | |
---|
104 | This command has no options. |
---|
105 | |
---|
106 | **EXAMPLES** |
---|
107 | |
---|
108 | Assume the current directory contains the Motorola |
---|
109 | Srecord file download.sr. Then executing the command: |
---|
110 | .. code:: c |
---|
111 | |
---|
112 | packhex <download.sr >packed.sr |
---|
113 | |
---|
114 | will generate the file packed.sr which is usually |
---|
115 | smaller than download.sr. |
---|
116 | |
---|
117 | **CREDITS** |
---|
118 | |
---|
119 | The source for packhex first appeared in the May 1993 |
---|
120 | issue of Embedded Systems magazine. The code was downloaded |
---|
121 | from their BBS. Unfortunately, the author's name was not |
---|
122 | provided in the listing. |
---|
123 | |
---|
124 | .. COMMENT: unhex |
---|
125 | |
---|
126 | unhex - Convert Hexadecimal File into Binary Equivalent |
---|
127 | ======================================================= |
---|
128 | |
---|
129 | **SYNOPSIS** |
---|
130 | |
---|
131 | .. code:: c |
---|
132 | |
---|
133 | unhex \[-valF] \[-o file] \[file \[file ...] ] |
---|
134 | |
---|
135 | **DESCRIPTION** |
---|
136 | |
---|
137 | unhex accepts Intel Hexadecimal, Motorola Srecord, or |
---|
138 | TI 'B' records and converts them to their binary equivalent. |
---|
139 | The output may sent to standout or may be placed in a specified |
---|
140 | file with the -o option. The designated output file may not be |
---|
141 | an input file. Multiple input files may be specified with their |
---|
142 | outputs logically concatenated into the output file. |
---|
143 | |
---|
144 | **OPTIONS** |
---|
145 | |
---|
146 | This command has the following options: |
---|
147 | |
---|
148 | ``v`` |
---|
149 | Verbose |
---|
150 | |
---|
151 | ``a base`` |
---|
152 | First byte of output corresponds with base |
---|
153 | address |
---|
154 | |
---|
155 | ``l`` |
---|
156 | Linear Output |
---|
157 | |
---|
158 | ``o file`` |
---|
159 | Output File |
---|
160 | |
---|
161 | ``F k_bits`` |
---|
162 | Fill holes in input with 0xFFs up to k_bits * 1024 bits |
---|
163 | |
---|
164 | **EXAMPLES** |
---|
165 | |
---|
166 | The following command will create a binary equivalent |
---|
167 | file for the two Motorola S record files in the specified output |
---|
168 | file binary.bin: |
---|
169 | .. code:: c |
---|
170 | |
---|
171 | unhex -o binary.bin downloadA.sr downloadB.sr |
---|
172 | |
---|