Imported Debian patch 2.9.0-5
[debian/cc1111] / debian / manpages / aslink.1
1 .TH ASLINK 1 
2 .SH NAME
3 ASLINK \- companion linker for the ASxxxx assemblers.
4 .SH SYNOPSIS
5 .B aslink
6 .I "[options] filenames"
7 .br
8 .B link-gbz80
9 .I "[options] filenames"
10 .br
11 .B link-z80
12 .I "[options] filenames"
13 .br
14 .SH WARNING
15 The information in this man page is an extract from the full
16 documentation of 
17 .B SDCC\c
18 \&, and is limited to the meaning of the options.
19 .PP
20 For complete and current documentation, refer to the
21 .B
22 ASxxxx Cross Assembler Documentation\c
23 \&, available in /usr/share/doc/sdcc-doc/aslink.
24 .SH "DESCRIPTION"
25 The
26 .B ASLINK\c
27 \& is general relocating companion linker for the 
28 .B ASxxx\c
29 \& assemblers.
30 .PP
31 .B MCS51\c
32 \& family is supported by 
33 .B aslink\c
34 \&.
35 .br
36 .B Z80\c 
37 \&family is supported by
38 .B link-z80\c
39 \&.
40 .br
41 .B GBZ80\c
42 \& (GameBoy Z80-like CPU) is supported by
43 .B link-gbz80\c
44 \&.
45 .SH OPTIONS
46 The linker may run in the command line mode or command file modes.  The 
47 allowed startup linker commands are:  
48 .TP 
49 .BI "\-c/\-f"
50 command line / command file modes 
51 .TP
52 .BI "\-p/\-n"
53 enable/disable echo file.lnk input to stdout 
54 .PP
55 If command line mode is selected, all linker commands come from stdin, if the 
56 command file mode is selected the commands are input from the specified 
57 file (extension must be .lnk). 
58 .PP
59 After invoking the linker the valid options are:
60 .TP
61 .BI
62 .TP
63 .BI "\-i/\-s"
64 Intel Hex (file.ihx) or Motorola S19 (file.s19) image output file.
65 .TP
66 .BI "\-z"
67 Specifies that symbol names are case sensitive. 
68 .TP
69 .BI "\-m"
70 Generate a map file (file.map). This file contains a list of the symbols 
71 (by area) with absolute addresses, sizes of linked areas, and other linking
72 information.  
73 .TP
74 .BI "\-w"
75 Specifies that a wide listing format be used for the map file.  
76 .TP
77 .BI "\-xdq"
78 Specifies the number radix for the map file (Hexidecimal, Decimal, or 
79 Octal).  
80 .TP
81 .BI "\-u"
82 Generate an updated listing file (file.rst) derived from the relocated 
83 addresses and data from the linker.
84 .TP
85 .BI "fileN"
86 Files to be linked. Files may be on the same line as the above options or on a 
87 separate line(s) one file  per line or multiple files separated by spaces or
88 tabs.
89 .TP
90 .BI "-b " "area = expression" " (one definition per line)"
91 This specifies an area base address where the expression may contain constants 
92 and/or defined symbols from the linked files.  
93 .TP
94 .BI "-g "  "symbol = expression" " (one definition per line)" 
95 This specifies the value for the symbol where the expression may contain 
96 constants and/or defined symbols from the linked files.  
97 .TP
98 .BI "-k " "library directory path" " (one  definition  per line)"
99 This specifies one possible path to an object library.  More than one path is
100 allowed.  
101 .TP
102 .BI "-l " "library file specification" " (one  definition  per  line)"
103 This specifies a possible library file.  More than one file is allowed.  
104 .TP
105 .BI "-e "
106 or null line, terminates input to the linker.  
107 .SH SEE ALSO
108 sdcc(1), asxxxx(1), link-z80(1), link-gbz80(1).
109 .SH AUTHOR
110 This manual page was written by Aurelien Jarno <aurel32@debian.org>,
111 for the Debian GNU/Linux system (but may be used by others).