← Back to branch summary

~ubuntu-branches/ubuntu/dapper/fpc/dapper

« back to all changes in this revision

Viewing changes to docs/dxeload.xml

  • Committer: Bazaar Package Importer
  • Author(s): Carlos Laviola
  • Date: 2005-05-30 11:59:10 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20050530115910-x5pbzm4qqta4i94h
Tags: 2.0.0-2
http://bugs.debian.org/310907
debian/fp-compiler.postinst.in: forgot to reapply the patch that
correctly creates the slave link to pc(1).  (Closes: #310907)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/dxeload.xml
 
1
<?xml version="1.0" encoding="ISO8859-1"?>
 
2
<fpdoc-descriptions>
 
3
<!--  
 
4
 
 
5
   $Id: dxeload.xml,v 1.2 2004/10/16 16:12:36 michael Exp $ 
 
6
   This file is part of the FPC documentation. 
 
7
   Copyright (C) 1997, by Michael Van Canneyt 
 
8
 
 
9
   The FPC documentation is free text; you can redistribute it and/or 
 
10
   modify it under the terms of the GNU Library General Public License as 
 
11
   published by the Free Software Foundation; either version 2 of the 
 
12
   License, or (at your option) any later version. 
 
13
 
 
14
   The FPC Documentation is distributed in the hope that it will be useful, 
 
15
   but WITHOUT ANY WARRANTY; without even the implied warranty of 
 
16
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
 
17
   Library General Public License for more details. 
 
18
 
 
19
   You should have received a copy of the GNU Library General Public 
 
20
   License along with the FPC documentation; see the file COPYING.LIB.  If not, 
 
21
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 
 
22
   Boston, MA 02111-1307, USA. 
 
23
 -->
 
24
<package name="rtl">
 
25
<module name="dxeload">
 
26
<short>Load DXE file in to memory</short>
 
27
<descr>
 
28
<p>
 
29
The <file>dxeload</file> unit was implemented by Pierre Mueller for dos,
 
30
it allows to load a DXE file (an object file with 1 entry point)
 
31
into memory and return a pointer to the entry point.
 
32
</p>
 
33
<p>
 
34
It exists only for dos.
 
35
</p>
 
36
</descr>
 
37
 
 
38
<element name="DXE_MAGIC">
 
39
<short> Magic number, found in the header of a DXE file.</short>>
 
40
</element>
 
41
 
 
42
<element name="dxe_header">
 
43
<short>Record with header of DXE file</short>
 
44
<descr>
 
45
The <var>dxe_header</var> record describes the header of a DXE file. It is used to
 
46
determine the magic number of the DXE file and number of relocations that 
 
47
must be done when the object file is loaded in memory.
 
48
</descr>
 
49
</element>
 
50
 
 
51
<element name="dxe_load">
 
52
<short>Load DXE file in memory</short>
 
53
<descr>
 
54
<p>
 
55
<var>dxe_load</var> loads the contents of the file <var>filename</var> into memory.
 
56
It performs the necessary relocations in the object code, and returns then
 
57
a pointer to the entry point of the code.
 
58
</p>
 
59
<p>
 
60
For an example, see the <link id="#rtl.emu387">emu387</link> unit in the RTL.
 
61
</p>
 
62
</descr>
 
63
<errors>
 
64
If an error occurs during the load or relocations, <var>Nil</var> is returned.
 
65
</errors>
 
66
</element>
 
67
 
 
68
</module>
 
69
</package>
 
70
</fpdoc-descriptions>