]> git.lizzy.rs Git - plan9front.git/blob - sys/man/1/2l
paint(1) fix bad cross reference
[plan9front.git] / sys / man / 1 / 2l
1 .TH 2L 1 
2 .SH NAME
3 0l, 1l, 2l, 5l, 6l, 7l, 8l, kl, ql, vl \- loaders
4 .SH SYNOPSIS
5 .B 2l
6 [
7 .I option ...
8 ]
9 [
10 .I file ...
11 ]
12 .br
13 etc.
14 .SH DESCRIPTION
15 These commands
16 load the named
17 .I files
18 into executable files for the corresponding architectures; see
19 .IR 2c (1)
20 for the correspondence between an architecture and the character
21 .RB ( 1 ,
22 .RB 2 ,
23 etc.) that specifies it.
24 The files should be object files or libraries (archives of object files)
25 for the appropriate architecture.
26 Also, a name like
27 .BI -l ext
28 represents the library
29 .BI lib ext .a
30 in
31 .BR /$objtype/lib ,
32 where
33 .I objtype
34 is one of
35 .BR 68000 ,
36 etc. as listed in
37 .IR 2c (1).
38 The libraries must have tables of contents
39 (see
40 .IR ar (1)).
41 .PP
42 In practice, 
43 .B -l
44 options are rarely necessary as the header files for
45 the libraries cause their archives to be included automatically in the load
46 (see
47 .IR 2c (1)).
48 For example, any program that includes header file
49 .B libc.h
50 causes the loader
51 to search the C library
52 .BR /$objtype/lib/libc.a .
53 Also, the loader creates an undefined symbol
54 .B _main
55 (or
56 .B _mainp
57 if profiling is enabled) to force loading of the
58 startup linkage from the C library.
59 .PP
60 The order of search to resolve undefined symbols is to load all files and libraries
61 mentioned explicitly on the command line, and then to resolve remaining symbols
62 by searching in topological order
63 libraries mentioned in header files included by files already loaded.
64 When scanning such libraries, the algorithm is to scan each library repeatedly until
65 no new undefined symbols are picked up, then to start on the next library.  Thus if library
66 .I A
67 needs
68 .I B
69 which needs
70 .I A
71 again, it may be necessary to mention
72 .I A
73 explicitly so it will be read a second time.
74 .PP
75 The loader options are:
76 .TP 0.75i
77 .B -l
78 (As a bare option.)
79 Suppress the default loading of the startup linkage and libraries
80 specified by header files.
81 .TP
82 .BI -o " out"
83 Place output in file
84 .IR out .
85 Default is
86 .IB O .out\f1,
87 where
88 .I O
89 is the first letter of the loader name.
90 .TP
91 .B -p
92 Insert profiling code into the executable output; no special action is needed
93 during compilation or assembly.
94 .TP
95 .B -e
96 Insert (\fLe\fPmbedded) tracing code into the executable output; no special action is needed
97 during compilation or assembly.
98 The added code calls
99 .L _tracein
100 at function entries
101 and
102 .L _traceout
103 at function exits.
104 .TP
105 .B -s
106 Strip the symbol tables from the output file.
107 .TP
108 .B -a
109 Print the object code in assembly language, with addresses.
110 .TP
111 .B -v
112 Print debugging output that annotates the activities of the load.
113 .TP
114 .BI -M
115 .RI ( Kl
116 only) Generate instructions rather than calls to emulation routines
117 for multiply and divide.
118 .TP
119 .BI -E symbol
120 The entry point for the binary is
121 .I symbol
122 (default
123 .BR _main ;
124 .B _mainp
125 under
126 .BR -p ).
127 .TP
128 .BI -x " [ file ]"
129 Produce an export table in the executable.
130 The optional
131 .I file
132 restricts the exported symbols to those listed in the file.
133 See
134 .IR dynld (2).
135 .TP
136 .BI -u " [ file ]"
137 Produce an export table, import table
138 and a dynamic load section in the executable.
139 The optional
140 .I file
141 restricts the imported symbols to those listed in the file.
142 See
143 .IR dynld (2).
144 .TP
145 .B -t
146 (\c
147 .I 5l
148 and
149 .I vl
150 only)
151 Move strings into the text segment.
152 .TP
153 .BI -H n
154 Executable header is type
155 .IR n .
156 The meaning of the types is architecture-dependent; typically
157 type 1 is Plan 9 boot format and type 2 is the
158 regular Plan 9 format, the default.  These are reversed on the MIPS.
159 The Next boot format is 3.  Type 4 in
160 .I vl
161 creates a MIPS executable for an SGI Unix system.
162 .TP
163 .BI -T t
164 The text segment starts at address
165 .IR t .
166 .TP
167 .BI -D d
168 The data segment starts at address
169 .IR d .
170 .TP
171 .BI -R r
172 The text segment is rounded to a multiple of
173 .I r
174 (if
175 .I r
176 is nonzero).
177 .PP
178 The numbers in the above options can begin with
179 .L 0x
180 or
181 .L 0
182 to change the default base from decimal to hexadecimal or octal.
183 The defaults for the values depend on the compiler and the
184 header type.
185 .PP
186 The loaded image has several symbols inserted by the loader:
187 .B etext
188 is the address of the end of the text segment;
189 .B bdata
190 is the address of the beginning of the data segment;
191 .B edata
192 is the address of the end of the data segment;
193 and
194 .B end
195 is the address of the end of the bss segment, and of the program.
196 .SH FILES
197 .TF /$objtype/lib
198 .TP
199 .B /$objtype/lib
200 for
201 .BI -l lib
202 arguments.
203 .SH SOURCE
204 .B /sys/src/cmd/2l
205 etc.
206 .SH "SEE ALSO"
207 .IR 2c (1),
208 .IR 2a (1),
209 .IR ar (1),
210 .IR nm (1),
211 .IR db (1),
212 .IR prof (1)
213 .PP
214 Rob Pike,
215 ``How to Use the Plan 9 C Compiler''
216 .SH BUGS
217 The list of loaders given above is only partial,
218 not all architectures are supported on all systems,
219 some have been retired and some
220 are provided by third parties.