Mercurial > hg > index.cgi

comparison docs/manual.docbook.sgml @ 565:fc072f6cde09

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 8c6c3363e18e
children
comparison
equal deleted inserted replaced
564:87f904e2b304 565:fc072f6cde09
840 </para> 840 </para>
841 </listitem> 841 </listitem>
842 </varlistentry> 842 </varlistentry>
843 843
844 <varlistentry> 844 <varlistentry>
845 <term>INCLUDEBIN <parameter>filename</parameter></term> 845 <term>INCLUDEBIN <parameter>filename</parameter>[,<parameter>start</parameter>[,<parameter>length</parameter>]]</term>
846 <listitem> 846 <listitem>
847 <para> 847 <para>
848 Treat the contents of <parameter>filename</parameter> as a string of bytes to 848 Treat the contents of <parameter>filename</parameter> as a string of bytes to
849 be included literally at the current assembly point. This has the same effect 849 be included literally at the current assembly point. This has the same effect
850 as converting the file contents to a series of FCB statements and including 850 as converting the file contents to a series of FCB statements and including
856 searched followed by the search path in the order specified.</para> 856 searched followed by the search path in the order specified.</para>
857 857
858 <para> Please note that absolute path detection including drive letters will 858 <para> Please note that absolute path detection including drive letters will
859 not function correctly on Windows platforms. Non-absolute inclusion will 859 not function correctly on Windows platforms. Non-absolute inclusion will
860 work, however.</para> 860 work, however.</para>
861
862 <para> The optional <parameter>start</parameter> parameter allows you to set
863 the byte offset to start reading from the binary file. Positive values are
864 from the beginning of the file, negative values are from the end of the file.</para>
865
866 <para> The optional <parameter>length</parameter> parameter allows you to set
867 the number of bytes read from the binary file. If missing, then the file is
868 read to the end.</para>
861 869
862 </listitem> 870 </listitem>
863 </varlistentry> 871 </varlistentry>
864 872
865 <varlistentry> 873 <varlistentry>