comparison docs/manual/x261.html @ 565:fc072f6cde09

Update documentation to reflect includebin offset/length feature
author William Astle <lost@l-w.ca>
date Thu, 21 Dec 2023 22:16:12 -0700
parents 52af0aa54fe5
children
comparison
equal deleted inserted replaced
564:87f904e2b304 565:fc072f6cde09
15 REL="PREVIOUS" 15 REL="PREVIOUS"
16 TITLE="Numbers and Expressions" 16 TITLE="Numbers and Expressions"
17 HREF="x253.html"><LINK 17 HREF="x253.html"><LINK
18 REL="NEXT" 18 REL="NEXT"
19 TITLE="Macros" 19 TITLE="Macros"
20 HREF="x562.html"></HEAD 20 HREF="x568.html"></HEAD
21 ><BODY 21 ><BODY
22 CLASS="SECTION" 22 CLASS="SECTION"
23 BGCOLOR="#FFFFFF" 23 BGCOLOR="#FFFFFF"
24 TEXT="#000000" 24 TEXT="#000000"
25 LINK="#0000FF" 25 LINK="#0000FF"
57 ><TD 57 ><TD
58 WIDTH="10%" 58 WIDTH="10%"
59 ALIGN="right" 59 ALIGN="right"
60 VALIGN="bottom" 60 VALIGN="bottom"
61 ><A 61 ><A
62 HREF="x562.html" 62 HREF="x568.html"
63 ACCESSKEY="N" 63 ACCESSKEY="N"
64 >Next</A 64 >Next</A
65 ></TD 65 ></TD
66 ></TR 66 ></TR
67 ></TABLE 67 ></TABLE
270 ></DD 270 ></DD
271 ><DT 271 ><DT
272 >INCLUDEBIN <CODE 272 >INCLUDEBIN <CODE
273 CLASS="PARAMETER" 273 CLASS="PARAMETER"
274 >filename</CODE 274 >filename</CODE
275 ></DT 275 >[,<CODE
276 CLASS="PARAMETER"
277 >start</CODE
278 >[,<CODE
279 CLASS="PARAMETER"
280 >length</CODE
281 >]]</DT
276 ><DD 282 ><DD
277 ><P 283 ><P
278 >Treat the contents of <CODE 284 >Treat the contents of <CODE
279 CLASS="PARAMETER" 285 CLASS="PARAMETER"
280 >filename</CODE 286 >filename</CODE
291 searched followed by the search path in the order specified.</P 297 searched followed by the search path in the order specified.</P
292 ><P 298 ><P
293 > Please note that absolute path detection including drive letters will 299 > Please note that absolute path detection including drive letters will
294 not function correctly on Windows platforms. Non-absolute inclusion will 300 not function correctly on Windows platforms. Non-absolute inclusion will
295 work, however.</P 301 work, however.</P
302 ><P
303 > The optional <CODE
304 CLASS="PARAMETER"
305 >start</CODE
306 > parameter allows you to set
307 the byte offset to start reading from the binary file. Positive values are
308 from the beginning of the file, negative values are from the end of the file.</P
309 ><P
310 > The optional <CODE
311 CLASS="PARAMETER"
312 >length</CODE
313 > parameter allows you to set
314 the number of bytes read from the binary file. If missing, then the file is
315 read to the end.</P
296 ></DD 316 ></DD
297 ><DT 317 ><DT
298 >FILL <CODE 318 >FILL <CODE
299 CLASS="PARAMETER" 319 CLASS="PARAMETER"
300 >byte</CODE 320 >byte</CODE
318 ><DIV 338 ><DIV
319 CLASS="SECTION" 339 CLASS="SECTION"
320 ><H2 340 ><H2
321 CLASS="SECTION" 341 CLASS="SECTION"
322 ><A 342 ><A
323 NAME="AEN375" 343 NAME="AEN381"
324 >3.6.2. Address Definition</A 344 >3.6.2. Address Definition</A
325 ></H2 345 ></H2
326 ><P 346 ><P
327 >The directives in this section all control the addresses of symbols 347 >The directives in this section all control the addresses of symbols
328 or the assembly process itself.</P 348 or the assembly process itself.</P
464 ><DIV 484 ><DIV
465 CLASS="SECTION" 485 CLASS="SECTION"
466 ><H2 486 ><H2
467 CLASS="SECTION" 487 CLASS="SECTION"
468 ><A 488 ><A
469 NAME="AEN426" 489 NAME="AEN432"
470 >3.6.3. Conditional Assembly</A 490 >3.6.3. Conditional Assembly</A
471 ></H2 491 ></H2
472 ><P 492 ><P
473 >Portions of the source code can be excluded or included based on conditions 493 >Portions of the source code can be excluded or included based on conditions
474 known at assembly time. Conditionals can be nested arbitrarily deeply. The 494 known at assembly time. Conditionals can be nested arbitrarily deeply. The
639 ><DIV 659 ><DIV
640 CLASS="SECTION" 660 CLASS="SECTION"
641 ><H2 661 ><H2
642 CLASS="SECTION" 662 CLASS="SECTION"
643 ><A 663 ><A
644 NAME="AEN497" 664 NAME="AEN503"
645 >3.6.4. OS9 Target Directives</A 665 >3.6.4. OS9 Target Directives</A
646 ></H2 666 ></H2
647 ><P 667 ><P
648 >This section includes directives that apply solely to the OS9 668 >This section includes directives that apply solely to the OS9
649 target.</P 669 target.</P
706 ><DIV 726 ><DIV
707 CLASS="SECTION" 727 CLASS="SECTION"
708 ><H2 728 ><H2
709 CLASS="SECTION" 729 CLASS="SECTION"
710 ><A 730 ><A
711 NAME="AEN522" 731 NAME="AEN528"
712 >3.6.5. Miscelaneous Directives</A 732 >3.6.5. Miscelaneous Directives</A
713 ></H2 733 ></H2
714 ><P 734 ><P
715 >This section includes directives that do not fit into the other 735 >This section includes directives that do not fit into the other
716 categories.</P 736 categories.</P
849 ><TD 869 ><TD
850 WIDTH="33%" 870 WIDTH="33%"
851 ALIGN="right" 871 ALIGN="right"
852 VALIGN="top" 872 VALIGN="top"
853 ><A 873 ><A
854 HREF="x562.html" 874 HREF="x568.html"
855 ACCESSKEY="N" 875 ACCESSKEY="N"
856 >Next</A 876 >Next</A
857 ></TD 877 ></TD
858 ></TR 878 ></TR
859 ><TR 879 ><TR