X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fld65.sgml;h=d37beced749309c3cc5a50e03fe4cea46e77651d;hb=a7f392a96fefd667bbcabfc816bbb6b3e3de70ac;hp=45e231bbf086c6168d24dd4c236e43415377955c;hpb=4a518df5bc0246812bb4f2049427ba7ba299cb70;p=cc65

diff --git a/doc/ld65.sgml b/doc/ld65.sgml
index 45e231bbf..d37beced7 100644
--- a/doc/ld65.sgml
+++ b/doc/ld65.sgml
@@ -55,23 +55,30 @@ The linker is called as follows:
 ---------------------------------------------------------------------------
 Usage: ld65 [options] module ...
 Short options:
+  -(                    Start a library group
+  -)                    End a library group
   -C name               Use linker config file
+  -D sym=val            Define a symbol
   -L path               Specify a library search path
   -Ln name              Create a VICE label file
-  -Lp                   Mark write protected segments as such (VICE)
   -S addr               Set the default start address
   -V                    Print the linker version
   -h                    Help (this text)
   -m name               Create a map file
   -o name               Name the default output file
   -t sys                Set the target system
+  -u sym                Force an import of symbol `sym'
   -v                    Verbose mode
   -vm                   Verbose map file
 
 Long options:
   --cfg-path path       Specify a config file search path
   --config name         Use linker config file
+  --dbgfile name        Generate debug information
+  --define sym=val      Define a symbol
   --dump-config name    Dump a builtin configuration
+  --end-group           End a library group
+  --force-import sym    Force an import of symbol `sym'
   --help                Help (this text)
   --lib file            Link this library
   --lib-path path       Specify a library search path
@@ -80,6 +87,7 @@ Long options:
   --obj file            Link this object file
   --obj-path path       Specify an object file search path
   --start-addr addr     Set the default start address
+  --start-group         Start a library group
   --target sys          Set the target system
   --version             Print the linker version
 ---------------------------------------------------------------------------
@@ -92,6 +100,26 @@ Here is a description of all the command line options:
 
 <descrip>
 
+  <label id="option--start-group">
+  <tag><tt>-(, --start-group</tt></tag>
+
+  Start a library group. The libraries specified within a group are searched
+  multiple times to resolve crossreferences within the libraries. Normally,
+  crossreferences are only resolved within a library, that is the library is
+  searched multiple times. Libraries specified later on the command line
+  cannot reference otherwise unreferenced symbols in libraries specified
+  earlier, because the linker has already handled them. Library groups are
+  a solution for this problem, because the linker will search repeatedly
+  through all libraries specified in the group, until all possible open
+  symbol references have been satisfied.
+
+
+  <tag><tt>-), --end-group</tt></tag>
+
+  End a library group. See the explanation of the <tt><ref
+  id="option--start-group" name="--start-group"></tt> option.
+
+
   <tag><tt>-h, --help</tt></tag>
 
   Print the short option summary shown above.
@@ -127,6 +155,7 @@ Here is a description of all the command line options:
   <itemize>
   <item>none
   <item>apple2
+  <item>apple2enh
   <item>atari
   <item>atmos
   <item>c16 (works also for the c116 with memory up to 32K)
@@ -140,12 +169,29 @@ Here is a description of all the command line options:
   <item>lunix
   <item>atmos
   <item>nes
+  <item>supervision
   </itemize>
 
   There are a few more targets defined but neither of them is actually
   supported.
 
 
+  <tag><tt>-u sym[:addrsize], --force-import sym[:addrsize]</tt></tag>
+
+  Force an import of a symbol. While object files are always linked to the
+  output file, regardless if there are any references, object modules from
+  libraries get only linked in if an import can be satisfied by this module.
+  The <tt/--fore-import/ option may be used to add a reference to a symbol and
+  as a result force linkage of the module that exports the identifier.
+
+  The name of the symbol may optionally be followed by a colon and an address
+  size specifier. If no address size is specified, the default address size
+  for the target machine is used.
+
+  Please note that the symbol name needs to have the internal representation,
+  meaning you have to prepend an underline for C identifiers.
+
+
   <label id="option-v">
   <tag><tt>-v, --verbose</tt></tag>
 
@@ -171,6 +217,15 @@ Here is a description of all the command line options:
   id="option-t" name="-t"></tt>.
 
 
+  <label id="option-D">
+  <tag><tt>-D sym=value, --define sym=value</tt></tag>
+
+  This option allows to define an external symbol on the command line. Value
+  may start with a '&dollar;' sign or with <tt/0x/ for hexadecimal values,
+  otherwise a leading zero denotes octal values. See also the <ref
+  id="SYMBOLS" name="SYMBOLS section"> in the configuration file.
+
+
   <label id="option--lib-path">
   <tag><tt>-L path, --lib-path path</tt></tag>
 
@@ -190,18 +245,13 @@ Here is a description of all the command line options:
   version.
 
 
-  <tag><tt>-Lp</tt></tag>
-
-  Deprecated option.
-
-
   <label id="option-S">
   <tag><tt>-S addr, --start-addr addr</tt></tag>
 
   Using -S you may define the default starting address. If and how this
   address is used depends on the config file in use. For the builtin
-  configurations, only the "none" system honors an explicit start address,
-  all other builtin config provide their own.
+  configurations, only the "none", "apple2" and "apple2enh" systems honor an
+  explicit start address, all other builtin config provide their own.
 
 
   <tag><tt>-V, --version</tt></tag>
@@ -221,6 +271,16 @@ Here is a description of all the command line options:
   using <tt/--cfg-path/.
 
 
+  <label id="option--dbgfile">
+  <tag><tt>--dbgfile name</tt></tag>
+
+  Specify an output file for debug information. Available information will be
+  written to this file. Using the <tt/-g/ option for the compiler and assembler
+  will increase the amount of information available. Please note that debug
+  information generation is currently being developed, so the format of the
+  file and it's contents are subject to change without further notice.
+
+
   <tag><tt>--lib file</tt></tag>
 
   Links a library to the output. Use this command line option instead of just
@@ -264,9 +324,8 @@ The library search path contains in this order:
 <item>A compiled in library path which is often <tt>/usr/lib/cc65/lib</tt> on
       Linux systems.
 <item>The value of the environment variable <tt/LD65_LIB/ if it is defined.
-<item>The value of the environment variable <tt/CC65_LIB/ if it is defined.
-      Please note that use of this environment variable is obsolete and may
-      get removed in future versions.
+<item>A subdirectory named <tt/lib/ of the directory defined in the environment
+      variable <tt/CC65_HOME/, if it is defined.
 <item>Any directory added with the <tt><ref id="option--lib-path"
       name="--lib-path"></tt> option on the command line.
 </enum>
@@ -278,12 +337,11 @@ The object file search path contains in this order:
 
 <enum>
 <item>The current directory.
-<item>A compiled in directory which is often <tt>/usr/lib/cc65/lib</tt> on
+<item>A compiled in directory which is often <tt>/usr/lib/cc65/obj</tt> on
       Linux systems.
 <item>The value of the environment variable <tt/LD65_OBJ/ if it is defined.
-<item>The value of the environment variable <tt/CC65_LIB/ if it is defined.
-      Please note that use of this environment variable is obsolete and may
-      get removed in future versions.
+<item>A subdirectory named <tt/obj/ of the directory defined in the environment
+      variable <tt/CC65_HOME/, if it is defined.
 <item>Any directory added with the <tt><ref id="option--obj-path"
       name="--obj-path"></tt> option on the command line.
 </enum>
@@ -295,9 +353,11 @@ The config file search path contains in this order:
 
 <enum>
 <item>The current directory.
-<item>A compiled in directory which is often <tt>/usr/lib/cc65/lib</tt> on
+<item>A compiled in directory which is often <tt>/usr/lib/cc65/cfg</tt> on
       Linux systems.
 <item>The value of the environment variable <tt/LD65_CFG/ if it is defined.
+<item>A subdirectory named <tt/cfg/ of the directory defined in the environment
+      variable <tt/CC65_HOME/, if it is defined.
 <item>Any directory added with the <tt><ref id="option--cfg-path"
       name="--cfg-path"></tt> option on the command line.
 </enum>
@@ -446,15 +506,13 @@ What we are doing here is telling the linker, that all segments go into the
 the linker will first write the <tt/CODE/ segment, then the <tt/RODATA/
 segment, then the <tt/DATA/ segment - but it will not write the <tt/BSS/
 segment. Why? Enter the segment type: For each segment specified, you may also
-specify a segment attribute. There are five possible segment attributes:
+specify a segment attribute. There are four possible segment attributes:
 
 <tscreen><verb>
 	ro   	means readonly
-	wprot	same as ro but will be marked as write protected in
-		the VICE label file if -Lp is given
-	rw   	means read/write
-	bss  	means that this is an uninitialized segment
-	zp	a zeropage segment
+      	rw   	means read/write
+      	bss  	means that this is an uninitialized segment
+      	zp	a zeropage segment
 </verb></tscreen>
 
 So, because we specified that the segment with the name BSS is of type bss,
@@ -507,7 +565,7 @@ example above. Let's have a look at it now.
 
 The "file" attribute (the keyword may also be written as "FILE" if you like
 that better) takes a string enclosed in double quotes (`"') that specifies the
-file, where the data is written. You may specifiy the same file several times,
+file, where the data is written. You may specify the same file several times,
 in that case the data for all memory areas having this file name is written
 into this file, in the order of the memory areas defined in the <tt/MEMORY/
 section. Let's specify some file names in the <tt/MEMORY/ section used above:
@@ -534,6 +592,25 @@ names here. Segments that go into <tt/ROM1/ will be written to a file named
 "rom1.bin", and segments that go into <tt/ROM2/ will be written to a file
 named "rom2.bin". The name given on the command line is ignored in both cases.
 
+Assigning an empty file name for a memory area will discard the data written
+to it. This is useful, if the a memory area has segments assigned that are
+empty (for example because they are of type bss). In that case, the linker
+will create an empty output file. This may be suppressed by assigning an empty
+file name to that memory area.
+
+The <tt/%O/ sequence is also allowed inside a string. So using
+
+<tscreen><verb>
+      	MEMORY {
+       	    ROM1:  start = $A000, size = $2000, file = "%O-1.bin";
+      	    ROM2:  start = $E000, size = $2000, file = "%O-2.bin";
+      	}
+</verb></tscreen>
+
+would write two files that start with the name of the output file specified on
+the command line, with "-1.bin" and "-2.bin" appended respectively. Because
+'%' is used as an escape char, the sequence "%%" has to be used if a single
+percent sign is required.
 
 <sect1>LOAD and RUN addresses (ROMable code)<p>
 
@@ -556,7 +633,7 @@ about <tt/DATA/? <tt/DATA/ contains initialized data, that is, data that was
 explicitly assigned a value. And your program will rely on these values on
 startup. Since there's no other way to remember the contents of the data
 segment, than storing it into one of the ROMs, we have to put it there. But
-unfortunately, ROM is not writeable, so we have to copy it into RAM before
+unfortunately, ROM is not writable, so we have to copy it into RAM before
 running the actual code.
 
 The linker cannot help you copying the data from ROM into RAM (this must be
@@ -648,6 +725,11 @@ you don't like this, you may specify a byte value that is used to fill these
 areas with the "<tt/fillval/" attribute. This value is also used to fill unfilled
 areas generated by the assemblers <tt/.ALIGN/ and <tt/.RES/ directives.
 
+The symbol <tt/%S/ may be used to access the default start address (that is,
+the one defined in the <ref id="FEATURES" name="FEATURES"> section, or the
+value given on the command line with the <tt><ref id="option-S" name="-S"></tt>
+option).
+
 
 <sect1>Other SEGMENT attributes<p>
 
@@ -666,14 +748,14 @@ page boundary, use
 </verb></tscreen>
 
 If an alignment is requested, the linker will add enough space to the output
-file, so that the new segment starts at an address that is divideable by the
+file, so that the new segment starts at an address that is dividable by the
 given number without a remainder. All addresses are adjusted accordingly. To
 fill the unused space, bytes of zero are used, or, if the memory area has a
 "<tt/fillval/" attribute, that value. Alignment is always needed, if you have
-the used the <tt/.ALIGN/ command in the assembler. The alignment of a segment
+used the <tt/.ALIGN/ command in the assembler. The alignment of a segment
 must be equal or greater than the alignment used in the <tt/.ALIGN/ command.
 The linker will check that, and issue a warning, if the alignment of a segment
-is lower than the alignment requested in a <tt/.ALIGN/ command of one of the
+is lower than the alignment requested in an <tt/.ALIGN/ command of one of the
 modules making up this segment.
 
 For a given segment you may also specify a fixed offset into a memory area or
@@ -700,24 +782,21 @@ or (for the segment definitions from above)
      	}
 </verb></tscreen>
 
+The "<tt/align/", "<tt/start/" and "<tt/offset/" attributes change placement
+of the segment in the run memory area, because this is what is usually
+desired. If load and run memory areas are equal (which is the case if only the
+load memory area has been specified), the attributes will also work. There is
+also an "<tt/align_load/" attribute that may be used to align the start of the
+segment in the load memory area, in case different load and run areas have
+been specified. There are no special attributes to set start or offset for
+just the load memory area.
+
 To suppress the warning, the linker issues if it encounters a segment that is
 not found in any of the input files, use "<tt/optional=yes/" as additional
 segment attribute. Be careful when using this attribute, because a missing
 segment may be a sign of a problem, and if you're suppressing the warning,
 there is no one left to tell you about it.
 
-File names may be empty, data from segments assigned to a memory area with
-an empty file name is discarded. This is useful, if the a memory area has
-segments assigned that are empty (for example because they are of type
-bss). In that case, the linker will create an empty output file. This may
-be suppressed by assigning an empty file name to that memory area.
-
-The symbol <tt/%S/ may be used to access the default start address (that is,
-$200 or the value given on the command line with the <tt><ref id="option-S"
-name="-S"></tt> option).
-
-
-
 <sect1>The FILES section<p>
 
 The <tt/FILES/ section is used to support other formats than straight binary
@@ -735,7 +814,8 @@ look like this:
 </verb></tscreen>
 
 The only other available output format is the o65 format specified by Andre
-Fachat. It is defined like this:
+Fachat (see the <htmlurl url="http://www.6502.org/users/andre/o65/fileformat.html"
+name="6502 binary relocation format specification">). It is defined like this:
 
 <tscreen><verb>
      	FILES {
@@ -752,8 +832,9 @@ The necessary o65 attributes are defined in a special section labeled
 
 The <tt/FORMAT/ section is used to describe file formats. The default (binary)
 format has currently no attributes, so, while it may be listed in this
-section, the attribute list is empty. The second supported format, o65, has
-several attributes that may be defined here.
+section, the attribute list is empty. The second supported format, 
+<htmlurl url="http://www.6502.org/users/andre/o65/fileformat.html" name="o65">, 
+has several attributes that may be defined here.
 
 <tscreen><verb>
     FORMATS {
@@ -765,14 +846,17 @@ several attributes that may be defined here.
 
 
 
-
-
-<sect1>Features<p>
+<sect1>The FEATURES section<label id="FEATURES"><p>
 
 In addition to the <tt/MEMORY/ and <tt/SEGMENTS/ sections described above, the
 linker has features that may be enabled by an additional section labeled
-<tt/FEATURES/. Currently, one such feature is available: <tt/CONDES/ is used
-to tell the linker to emit module constructor/destructor tables.
+<tt/FEATURES/.
+
+
+<sect2>The CONDES feature<p>
+
+<tt/CONDES/ is used to tell the linker to emit module constructor/destructor
+tables.
 
 <tscreen><verb>
 	FEATURES {
@@ -795,24 +879,23 @@ The <tt/CONDES/ feature has several attributes:
 
   <tag><tt>type</tt></tag>
 
-  Describes the type of the routines to place in the table. Type may be
-  one of the predefined types <tt/constructor/ or <tt/destructor/, or a
-  numeric value between 0 and 6.
+  Describes the type of the routines to place in the table. Type may be one of
+  the predefined types <tt/constructor/, <tt/destructor/, <tt/interruptor/, or
+  a numeric value between 0 and 6.
 
 
   <tag><tt>label</tt></tag>
 
-  This specifies the label to use for the table. The label points to the
-  start of the table in memory and may be used from within user written
-  code.
+  This specifies the label to use for the table. The label points to the start
+  of the table in memory and may be used from within user written code.
 
 
   <tag><tt>count</tt></tag>
 
-  This is an optional attribute. If specified, an additional symbol is
-  defined by the linker using the given name. The value of this symbol
-  is the number of entries (<em/not/ bytes) in the table. While this
-  attribute is optional, it is often useful to define it.
+  This is an optional attribute. If specified, an additional symbol is defined
+  by the linker using the given name. The value of this symbol is the number
+  of entries (<em/not/ bytes) in the table. While this attribute is optional,
+  it is often useful to define it.
 
 
   <tag><tt>order</tt></tag>
@@ -837,15 +920,95 @@ For more information see the <tt/.CONDES/ command in the <htmlurl
 url="ca65.html" name="ca65 manual">.
 
 
+<sect2>The STARTADDRESS feature<p>
+
+<tt/STARTADDRESS/ is used to set the default value for the start address,
+which can be referenced by the <tt/%S/ symbol. The builtin default for the
+linker is &dollar;200.
+
+<tscreen><verb>
+       	FEATURES {
+            # Default start address is $1000
+       	    STARTADDRESS:       default = $1000;
+       	}
+</verb></tscreen>
+
+Please note that order is important: The default start address must be defined
+<em/before/ the <tt/%S/ symbol is used in the config file. This does usually
+mean, that the <tt/FEATURES/ section has to go to the top of the config file.
+
+
+
+<sect1>The SYMBOLS section<label id="SYMBOLS"><p>
+
+The configuration file may also be used to define symbols used in the link
+stage. The mandatory attribute for a symbol is its value. A second, boolean
+attribute named <tt/weak/ is available. If a symbol is marked as weak, it may
+be overridden by defining a symbol of the same name from the command line. The
+default for symbols is that they're strong, which means that an attempt to
+define a symbol with the same name from the command line will lead to an
+error.
+
+The following example defines the stack size for an application, but allows
+the programmer to override the value by specifying <tt/--define
+__STACKSIZE__=xxx/ on the command line.
+
+<tscreen><verb>
+       	SYMBOLS {
+            # Define the stack size for the application
+       	    __STACKSIZE__:      value = $800, weak = yes;
+       	}
+</verb></tscreen>
+
+
 
 <sect1>Builtin configurations<p>
 
-The builtin configurations are part of the linker source. They are also
-distributed together with the machine specific binary packages (usually in the
-doc directory) and don't have a special format. So if you need a special
-configuration, it's a good idea to start with the builtin configuration for
-your system. In a first step, just replace <tt/-t target/ by <tt/-C
-configfile/. The go on and modify the config file to suit your needs.
+The builtin configurations are part of the linker source. They can be retrieved
+with <tt/--dump-config/ and don't have a special format. So if you need a
+special configuration, it's a good idea to start with the builtin configuration
+for your system. In a first step, just replace <tt/-t target/ by <tt/-C
+configfile/. Then go on and modify the config file to suit your needs.
+
+
+
+<sect1>Secondary configurations<p>
+
+Several machine specific binary packages are distributed together with secondary
+configurations (in the cfg directory). These configurations can be used with
+<tt/-C configfile/ too.
+
+
+
+<sect>Special segments<p>
+
+The builtin config files do contain segments that have a special meaning for
+the compiler and the libraries that come with it. If you replace the builtin
+config files, you will need the following information.
+
+<sect1>INIT<p>
+
+The INIT segment is used for initialization code that may be reused once
+execution reaches main() - provided that the program runs in RAM. You
+may for example add the INIT segment to the heap in really memory
+constrained systems.
+
+<sect1>LOWCODE<p>
+
+For the LOWCODE segment, it is guaranteed that it won't be banked out, so it
+is reachable at any time by interrupt handlers or similar.
+
+<sect1>STARTUP<p>
+
+This segment contains the startup code which initializes the C software stack
+and the libraries. It is placed in its own segment because it needs to be
+loaded at the lowest possible program address on several platforms.
+
+<sect1>ZPSAVE<p>
+
+The ZPSAVE segment contains the original values of the zeropage locations used
+by the ZEROPAGE segment. It is placed in its own segment because it must not be
+initialized.
 
 
 
@@ -860,7 +1023,7 @@ name="uz@cc65.org">).
 
 <sect>Copyright<p>
 
-ld65 (and all cc65 binutils) are (C) Copyright 1998-2001 Ullrich von
+ld65 (and all cc65 binutils) are (C) Copyright 1998-2005 Ullrich von
 Bassewitz. For usage of the binaries and/or sources the following
 conditions do apply: