source: rtems/doc/index.html.in @ deeecc1

4.104.114.84.95
Last change on this file since deeecc1 was 2ba8875, checked in by Joel Sherrill <joel.sherrill@…>, on 04/26/00 at 18:02:26

Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius <corsepiu@…>
which contains the bulk of converting the documentation tree to automake
and GNU conventions. Comments follow:

This is the automake port of rtemsdoc.

To apply:

cvs co rtemsdoc
cd rtemsdoc
sh cvs-rm.sh
patch -p0 < rtemsdoc-4.5.0-rc-0.diff
sh cvs-add.sh

[Attention: cvs-rm.sh and cvs-add.sh directly modify cvs]

Known bugs:
1) src2html is not supported (yet? - Is this supposed to work?)
2) all *.pdf images now are generated on-the-fly, but not yet deleted
during "make distclean"
3) All supplements, including the templated ones, get build and
installed.
4) Building outside of the source tree is completely untested and very
likely does not work.
5) Make [ps|pdf] are not (yet) supported, make [dvi|info] are supported
by automake's default texinfo rules.

Fixing 2, 3 and 5 is almost trivial and needs to be done.
4) is a matter of testing and tool-properties, for now it is simply
untested.

General issues:

  • gif vs jpg vs png. I would recommend to replace all images with pngs to avoid potential copyright issues (gif) or lack in quality (jpg, jpg is good for real world photographs, but extremely poor on artificial images, graphs).
  • pdf images do net get placed correctly in pdf-documents.
  • texinfo: We now use a local copy of texinfo-4.0's texinfo.tex in texinfo/texinfo.tex for generating infos. However pdftex's system-wide texinfo.tex and pdftexinfo.tex are used for generating *.dvi, *.ps, *.pdf.
  • .cvsignore files still missing.
  • I have renamed the supplements filename not to use c_<supplement>, because automake seems to have problems with it.

Notes:

  • Again, I recommend not to put any generated files into CVS. Here, this comprises some *texi, all *.pdf and many *.html pages. Ie. I recommend to run make maintainer-clean before checking in any files.
  • To get building started, this should be sufficient: ./bootstrap ./configure cd tools; make; cd .. make info
  • To make a public tarball: [cvs co ; ./bootstrap] ./configure cd tools; make; cd .. make info [make clean] make dist

=> This generates a rtems-<version>.tar.gz in the toplevel directory.
=> Building the tools only is required after a "cvs co", but not in a

distribution tarball.
  • Property mode set to 100644
File size: 11.4 KB
Line 
1<HTML>
2<HEAD><TITLE>RTEMS @RTEMS_VERSION@ On-Line Library</TITLE></HEAD>
3<BODY BGCOLOR="FFFFFF">
4<A HREF="http://www.oarcorp.com" target="Text Frame">
5  <IMG align=right BORDER=0 SRC="images/oaronly.jpg" ALT="OAR"> </A>
6<H1>RTEMS @RTEMS_VERSION@ On-Line Library</H1>
7<HR>
8<BODY>
9<MENU>
10    <LI>
11        <A HREF="../pdf/FAQ.pdf">
12                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
13        <A HREF="../ps/FAQ.ps">
14                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
15        <A HREF="../dvi/FAQ.dvi">
16                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
17        <A HREF="FAQ/index.html">RTEMS FAQ</A>
18        </LI>
19    <LI>C/C++ Manuals</LI>
20    <MENU>
21        <LI><A HREF="BAD.html">
22                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
23            <A HREF="../ps/started.ps">
24                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
25            <A HREF="../dvi/started.dvi">
26                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
27            <A HREF="started/index.html">
28               Getting Started with RTEMS for C/C++ Users</A>
29            </LI>
30
31        <LI><A HREF="../pdf/c_user.pdf">
32                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
33            <A HREF="../ps/c_user.ps">
34                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
35            <A HREF="../dvi/c_user.dvi">
36                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
37            <A HREF="c_user/index.html">
38               RTEMS Applications C User's Guide</A>
39            </LI>
40       
41        <LI><A HREF="../pdf/posix_users.pdf">
42                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
43            <A HREF="../ps/posix_users.ps">
44                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
45            <A HREF="../dvi/posix_users.dvi">
46                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
47            <A HREF="posix_users/index.html">
48               RTEMS POSIX API User's Guide</A>
49            </LI>
50
51        <LI><A HREF="../pdf/itron.pdf">
52                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
53            <A HREF="../ps/itron.ps">
54                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
55            <A HREF="../dvi/itron.dvi">
56                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
57            <A HREF="itron/index.html">
58               RTEMS ITRON 3.0 API User's Guide</A>
59            </LI>
60
61        <LI><A HREF="../pdf/networking.pdf">
62                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
63            <A HREF="../ps/networking.ps">
64                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
65            <A HREF="../dvi/networking.dvi">
66                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
67            <A HREF="networking/index.html">
68               RTEMS Network Supplement</A>
69            </LI>
70    </MENU>
71    <LI>Ada Manuals</LI>
72    <MENU>
73        <LI><A HREF="BAD.html">
74                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
75            <A HREF="../ps/started_ada.ps">
76                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
77            <A HREF="../dvi/started_ada.dvi">
78                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
79            <A HREF="started_ada/index.html">
80               Getting Started with GNAT/RTEMS</A>
81            </LI>
82        <LI><A HREF="../pdf/ada_user.pdf">
83                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
84            <A HREF="../ps/ada_user.ps">
85                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
86            <A HREF="../dvi/ada_user.dvi">
87                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
88            <A HREF="ada_user/index.html">
89               RTEMS Applications Ada User's Guide</A>
90            </LI>
91    </MENU>
92    <LI>Miscellaneous Manuals</LI>
93    <MENU>
94        <LI><A HREF="../pdf/develenv.pdf">
95                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
96            <A HREF="../ps/develenv.ps">
97                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
98            <A HREF="../dvi/develenv.dvi">
99                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
100            <A HREF="develenv/index.html">
101               RTEMS Development Environment Guide</A>
102            </LI>
103
104        <LI><A HREF="../pdf/rtems_gdb.pdf">
105                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
106            <A HREF="../ps/rtems_gdb.ps">
107                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
108            <A HREF="../dvi/rtems_gdb.dvi">
109                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
110            <A HREF="rtems_gdb/index.html">
111               RTEMS/GDB User's Guide</A>
112            </LI>
113
114        <LI><A HREF="../pdf/rgdb_specs.pdf">
115                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
116            <A HREF="../ps/rgdb_specs.ps">
117                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
118            <A HREF="../dvi/rgdb_specs.dvi">
119                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
120            <A HREF="rgdb_specs/index.html">
121               RTEMS Remote Debugger Server Specifications</A>
122            </LI>
123
124        <LI><A HREF="../pdf/bsp_howto.pdf">
125                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
126            <A HREF="../ps/bsp_howto.ps">
127                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
128            <A HREF="../dvi/bsp_howto.dvi">
129                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
130            <A HREF="bsp_howto/index.html">
131               RTEMS BSP and Device Driver Development Guide</A>
132            </LI>
133
134        <LI><A HREF="../pdf/porting.pdf">
135                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
136            <A HREF="../ps/porting.ps">
137                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
138            <A HREF="../dvi/porting.dvi">
139                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
140            <A HREF="porting/index.html">
141               RTEMS Porting Guide</A>
142            </LI>
143
144        <LI><A HREF="../pdf/filesystem.pdf">
145                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
146            <A HREF="../ps/filesystem.ps">
147                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
148            <A HREF="../dvi/filesystem.dvi">
149                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
150            <A HREF="filesystem/index.html">
151               RTEMS Filesystem Design Guide</A>
152            </LI>
153
154        <LI><A HREF="../pdf/posix1003_1.pdf">
155                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
156            <A HREF="../ps/posix1003_1.ps">
157                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
158            <A HREF="../dvi/posix1003_1.dvi">
159                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
160            <A HREF="posix1003_1/index.html">
161               RTEMS POSIX 1003.1 Compliance Guide</A>
162            </LI>
163    </MENU>
164
165
166<LI>CPU Supplements
167
168  <MENU>
169        <LI><A HREF="HELP.html">
170                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
171            <A HREF="HELP.html">
172                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
173            <A HREF="HELP.html">
174                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
175            <A HREF="HELP.html">
176               RTEMS AMD 29K Applications Supplement</A>
177            </LI>
178
179        <LI><A HREF="HELP.html">
180                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
181            <A HREF="HELP.html">
182                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
183            <A HREF="HELP.html">
184                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
185            <A HREF="HELP.html">
186               RTEMS Hitachi SH Applications Supplement</A>
187            </LI>
188
189        <LI><A HREF="../pdf/i386.pdf">
190                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
191            <A HREF="../ps/i386.ps">
192                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
193            <A HREF="../dvi/i386.dvi">
194                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
195            <A HREF="i386/index.html">
196               RTEMS Intel i386 Applications Supplement</A>
197            </LI>
198
199        <LI><A HREF="../pdf/i960.pdf">
200                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
201            <A HREF="../ps/i960.ps">
202                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
203            <A HREF="../dvi/i960.dvi">
204                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
205            <A HREF="i960/index.html">
206               RTEMS Intel i960 Applications Supplement</A>
207            </LI>
208
209        <LI><A HREF="HELP.html">
210                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
211            <A HREF="HELP.html">
212                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
213            <A HREF="HELP.html">
214                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
215            <A HREF="HELP.html">
216               RTEMS MIPS64 ORION Applications Supplement</A>
217            </LI>
218
219        <LI><A HREF="../pdf/m68k.pdf">
220                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
221            <A HREF="../ps/m68k.ps">
222                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
223            <A HREF="../dvi/m68k.dvi">
224                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
225            <A HREF="m68k/index.html">
226               RTEMS Motorola MC68xxx Applications Supplement</A>
227            </LI>
228
229        <LI><A HREF="../pdf/powerpc.pdf">
230                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
231            <A HREF="../ps/powerpc.ps">
232                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
233            <A HREF="../dvi/powerpc.dvi">
234                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
235            <A HREF="powerpc/index.html">
236               RTEMS PowerPC Applications Supplement</A>
237            </LI>
238
239        <LI><A HREF="../pdf/sparc.pdf">
240                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
241            <A HREF="../ps/sparc.ps">
242                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
243            <A HREF="../dvi/sparc.dvi">
244                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
245            <A HREF="sparc/index.html">
246               RTEMS SPARC Applications Supplement</A>
247            </LI>
248
249        <LI><A HREF="../pdf/hppa1_1.pdf">
250                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
251            <A HREF="../ps/hppa1_1.ps">
252                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
253            <A HREF="../dvi/hppa1_1.dvi">
254                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
255            <A HREF="hppa1_1/index.html">
256               RTEMS Hewlett Packard PA-RISC Applications Supplement</A>
257            </LI>
258
259        <LI><A HREF="HELP.html">
260                    <IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
261            <A HREF="HELP.html">
262                    <IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
263            <A HREF="HELP.html">
264                    <IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
265            <A HREF="HELP.html">
266               RTEMS UNIX Port Applications Supplement</A>
267            </LI>
268
269    </MENU>
270</LI>
271
272</MENU>
273<HR>
274Copyright &copy; 1988-2000 <A HREF="http://www.oarcorp.com" target="Text Frame">OAR Corporation</A>
275</BODY></HTML>
Note: See TracBrowser for help on using the repository browser.