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