source: rtems/doc/relnotes/install.texi @ 0660b4f8

4.104.114.84.95
Last change on this file since 0660b4f8 was 0660b4f8, checked in by Joel Sherrill <joel.sherrill@…>, on 11/16/99 at 19:50:56

Changed copyright date to 1999.

  • Property mode set to 100644
File size: 6.3 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1999.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@ifinfo
10@node Installation Procedure, Installation Procedure Introduction, Introduction Documentation, Top
11@end ifinfo
12@chapter Installation Procedure
13@ifinfo
14@menu
15* Installation Procedure Introduction::
16* Installation Procedure RTEMS FTP Site Organization::
17* Installation Procedure Unarchiving the RTEMS and GNU Components::
18* Installation Procedure Installing a Cross-Development GNU Toolset::
19* Installation Procedure Installing RTEMS::
20@end menu
21@end ifinfo
22
23@ifinfo
24@node Installation Procedure Introduction, Installation Procedure RTEMS FTP Site Organization, Installation Procedure, Installation Procedure
25@end ifinfo
26@section Introduction
27
28This chapter describes the process of installing and
29configuring RTEMS and a cross-development environment based on
30freely available tools and libraries.
31
32@ifinfo
33@node Installation Procedure RTEMS FTP Site Organization, Installation Procedure Unarchiving the RTEMS and GNU Components, Installation Procedure Introduction, Installation Procedure
34@end ifinfo
35@section RTEMS FTP Site Organization
36
37RTEMS is distributed only via anonymous ftp.
38
39This section will discuss how to navigate the RTEMS
40ftp site and unarchive the files in the RTEMS and GNU package
41distributions.  All example commands will be given in a shell
42independent fashion unless otherwise noted.
43
44Throughout the rest of this manual
45<RTEMS_distribution> will be used as the parent of components
46within the RTEMS distribution.  For persons using the ftp
47distribution found on the primary ftp site for RTEMS,
48<RTEMS_distribution> is
49ftp://ftp.OARcorp.com/oarcorp/rtems/@value{RELEASE}.
50
51The archive files for RTEMS Release @value{RELEASE} are found
52under the directory <RTEMS_distribution>.  This directory
53contains the files which comprise this relase as well as any
54patches which may be required for other tools.
55
56The complete source code and documentation set for
57the C language implementation of RTEMS is provided.
58
59Documentation other than this on-line version is available to
60OAR support customers.  Please contact OAR for more information.
61
62@ifinfo
63@node Installation Procedure Unarchiving the RTEMS and GNU Components, Installation Procedure Installing a Cross-Development GNU Toolset, Installation Procedure RTEMS FTP Site Organization, Installation Procedure
64@end ifinfo
65@section Unarchiving the RTEMS and GNU Components
66
67Many of the components of the RTEMS release are
68"tarred, zipped" files and have the .tar.gz or .tgz extension.
69The GNU zip package is required to unarchives these files on the
70RTEMS ftp site.  If this package is not installed, the source
71can be found in the files
72ftp://prep.ai.mit.edu/pub/gnu/gzip-1.2.4.shar or
73ftp://prep.ai.mit.edu/pub/gnu/gzip-1.2.4.tar.  It may be
74restored using a command similar to the following:
75
76@example
77@group
78tar xvf gzip-1.2.4.tar
79
80OR
81
82sh gzip-1.2.4.shar
83@end group
84@end example
85
86This will create a subdirectory gzip-1.2.4 in the
87current directory.  Please examine the files README and INSTALL
88and follow the instructions provided there.
89
90[Note: The GNU tools follow a standard packaging procedure
91They will unarchive into a directory based on the package name and version
92number.  For detailed instructions on compilation and
93installation of the GNU tools, please refer to the instructions for
94each GNU tool.]
95
96Files which have been "tarred, zipped" (i.e.  .tar.gz
97or .tgz extension) may be unarchived with a command similar to
98one of the following:
99
100@example
101@group
102gzcat <file>.tgz | tar xvof -
103
104OR
105
106gunzip -c <file>.tgz | tar xvof -
107
108OR
109
110gtar xzvf <file>.tgz
111@end group
112@end example
113
114NOTE: gunzip -c is equivalent to gzcat, while gtar is GNU tar.
115
116Given that the necessary utility programs are
117installed, any of the above commands will extract the contents
118of <file>.tar.gz into the current directory.  All of the RTEMS
119components will be extracted into the subdirectory rtems-@value{RELEASE}.
120To view the contents of a component without restoring any files,
121use a command similar to the following:
122
123@example
124@group
125gzcat <file>.tgz | tar tvf -
126@end group
127@end example
128
129@ifinfo
130@node Installation Procedure Installing a Cross-Development GNU Toolset, Installation Procedure Installing RTEMS, Installation Procedure Unarchiving the RTEMS and GNU Components, Installation Procedure
131@end ifinfo
132@section Installing a Cross-Development GNU Toolset
133
134This sections describes how to build and install the
135FSF GNU tools for use as a cross-compilation system.  These
136tools are used by the RTEMS developers.  Every effort has been
137made to make these instructions accurate and complete.  However,
138it is recommended that the individual doing the installation
139read the appropriate installation notes for each of the tools in
140the cross toolset.  This will help insure that there are no
141special requirements for a particular host.
142
143If the host and target processors are the same, then
144it may be possible to use the host development tools.  An
145example of this scenario is using a SPARC based workstation
146to develop an RTEMS application for the SPARC processor.  Although
147the native toolset is useable in this scenario, it is ultimately
148more desirable to build a toolset specifically for the embedded environment.
149
150Instructions for building a cross environment using the GNU
151tools is provided in the crossgcc FAQ available from ftp.cygnus.com
152in /pub/embedded/crossgcc.  It is recommended that the user following
153these instructions.
154
155After the cross development toolset has been built
156and installed, it will be necessary to modify the environment of
157each RTEMS application developer to reflect at least the path of
158the newly installed cross development toolset.
159
160The documentation for the FSF GNU and Cygnus tools is
161formatted using TeX.  The RTEMS developers use TeX 3.14t3 to
162format the manuals for their own use.  This document does not
163contain instructions on the acquisition or installation of TeX
164and supporting tools.
165
166NOTE: For "UNIX" processors, the native compiler binary utilities
167should be used.
168
169@ifinfo
170@node Installation Procedure Installing RTEMS, Development Environment Status, Installation Procedure Installing a Cross-Development GNU Toolset, Installation Procedure
171@end ifinfo
172@section Installing RTEMS
173
174For instructions on building and installing RTEMS, please refer to
175the file README.configure in the source distribution.
176
Note: See TracBrowser for help on using the repository browser.