diff options
Diffstat (limited to '')
| -rw-r--r-- | develenv/utilities.rst | 122 |
1 files changed, 53 insertions, 69 deletions
diff --git a/develenv/utilities.rst b/develenv/utilities.rst index a5e37a3..70e493e 100644 --- a/develenv/utilities.rst +++ b/develenv/utilities.rst @@ -3,25 +3,22 @@ RTEMS Specific Utilities ######################## -This section describes the additional commands -available within the *RTEMS Development Environment*. Although -some of these commands are of general use, most are included to -provide some capability necessary to perform a required function -in the development of the RTEMS executive, one of its support +This section describes the additional commands available within the *RTEMS +Development Environment*. Although some of these commands are of general use, +most are included to provide some capability necessary to perform a required +function in the development of the RTEMS executive, one of its support components, or an RTEMS based application. -Some of the commands are implemented as C programs. -However, most commands are implemented as Bourne shell scripts. -Even if the current user has selected a different shell, the -scripts will automatically invoke the Bourne shell during their -execution lifetime. +Some of the commands are implemented as C programs. However, most commands are +implemented as Bourne shell scripts. Even if the current user has selected a +different shell, the scripts will automatically invoke the Bourne shell during +their execution lifetime. -The commands are presented in UNIX manual page style -for compatibility and convenience. A standard set of paragraph -headers were used for all of the command descriptions. If a -section contained no data, the paragraph header was omitted to -conserve space. Each of the permissible paragraph headers and -their contents are described below: +The commands are presented in UNIX manual page style for compatibility and +convenience. A standard set of paragraph headers were used for all of the +command descriptions. If a section contained no data, the paragraph header was +omitted to conserve space. Each of the permissible paragraph headers and their +contents are described below: ``SYNOPSIS`` describes the command syntax @@ -47,21 +44,18 @@ their contents are described below: ``SEE ALSO`` lists any relevant commands which can be consulted -Most environment variables referenced by the commands -are defined for the RTEMS Development Environment during the -login procedure. During login, the user selects a default RTEMS -environment through the use of the Modules package. This tool -effectively sets the environment variables to provide a -consistent development environment for a specific user. -Additional environment variables within the RTEMS environment -were set by the system administrator during installation. When -specifying paths, a command description makes use of these +Most environment variables referenced by the commands are defined for the RTEMS +Development Environment during the login procedure. During login, the user +selects a default RTEMS environment through the use of the Modules package. +This tool effectively sets the environment variables to provide a consistent +development environment for a specific user. Additional environment variables +within the RTEMS environment were set by the system administrator during +installation. When specifying paths, a command description makes use of these environment variables. -When referencing other commands in the SEE ALSO -paragraph, the following notation is used: command(code). -Where command is the name of a related command, and code is a -section number. Valid section numbers are as follows: +When referencing other commands in the SEE ALSO paragraph, the following +notation is used: command(code). Where command is the name of a related +command, and code is a section number. Valid section numbers are as follows: ``1`` Section 1 of the standard UNIX documentation @@ -72,31 +66,27 @@ section number. Valid section numbers are as follows: ``1R`` a manual page from this document, the RTEMS Development Environment Guide -For example, ls(1) means see the standard ls command -in section 1 of the UNIX documentation. gcc020(1G) means see -the description of gcc020 in section 1 of the GNU documentation. - -.. COMMENT: packhex +For example, ``ls(1)`` means see the standard ls command in section 1 of the +UNIX documentation. gcc020(1G) means see the description of gcc020 in section +1 of the GNU documentation. packhex - Compress Hexadecimal File =================================== **SYNOPSIS** -.. code:: c +.. code-block:: c packhex <source >destination **DESCRIPTION** -packhex accepts Intel Hexadecimal or Motorola Srecord -on its standard input and attempts to pack as many contiguous -bytes as possible into a single hexadecimal record. Many -programs output hexadecimal records which are less than 80 bytes -long (for human viewing). The overhead required by each -unnecessary record is significant and packhex can often reduce -the size of the download image by 20%. packhex attempts to -output records which are as long as the hexadecimal format +packhex accepts Intel Hexadecimal or Motorola Srecord on its standard input and +attempts to pack as many contiguous bytes as possible into a single hexadecimal +record. Many programs output hexadecimal records which are less than 80 bytes +long (for human viewing). The overhead required by each unnecessary record is +significant and packhex can often reduce the size of the download image by 20%. +packhex attempts to output records which are as long as the hexadecimal format allows. **OPTIONS** @@ -105,41 +95,37 @@ This command has no options. **EXAMPLES** -Assume the current directory contains the Motorola -Srecord file download.sr. Then executing the command: -.. code:: c +Assume the current directory contains the Motorola Srecord file +download.sr. Then executing the command: + +.. code-block:: c packhex <download.sr >packed.sr -will generate the file packed.sr which is usually -smaller than download.sr. +will generate the file packed.sr which is usually smaller than download.sr. **CREDITS** -The source for packhex first appeared in the May 1993 -issue of Embedded Systems magazine. The code was downloaded -from their BBS. Unfortunately, the author's name was not -provided in the listing. - -.. COMMENT: unhex +The source for packhex first appeared in the May 1993 issue of Embedded Systems +magazine. The code was downloaded from their BBS. Unfortunately, the author's +name was not provided in the listing. unhex - Convert Hexadecimal File into Binary Equivalent ======================================================= **SYNOPSIS** -.. code:: c +.. code-block:: c - unhex \[-valF] \[-o file] \[file \[file ...] ] + unhex [-valF] [-o file] [file [file ...] ] **DESCRIPTION** -unhex accepts Intel Hexadecimal, Motorola Srecord, or -TI 'B' records and converts them to their binary equivalent. -The output may sent to standout or may be placed in a specified -file with the -o option. The designated output file may not be -an input file. Multiple input files may be specified with their -outputs logically concatenated into the output file. +unhex accepts Intel Hexadecimal, Motorola Srecord, or TI 'B' records and +converts them to their binary equivalent. The output may sent to standout or +may be placed in a specified file with the -o option. The designated output +file may not be an input file. Multiple input files may be specified with +their outputs logically concatenated into the output file. **OPTIONS** @@ -149,8 +135,7 @@ This command has the following options: Verbose ``a base`` - First byte of output corresponds with base - address + First byte of output corresponds with base address ``l`` Linear Output @@ -163,10 +148,9 @@ This command has the following options: **EXAMPLES** -The following command will create a binary equivalent -file for the two Motorola S record files in the specified output -file binary.bin: -.. code:: c +The following command will create a binary equivalent file for the two Motorola +S record files in the specified output file binary.bin: - unhex -o binary.bin downloadA.sr downloadB.sr +.. code-block:: c + unhex -o binary.bin downloadA.sr downloadB.sr |