Mercurial > hg > index.cgi

diff 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
line wrap: on
line diff
--- a/docs/manual.docbook.sgml	Thu Dec 21 22:14:25 2023 -0700
+++ b/docs/manual.docbook.sgml	Thu Dec 21 22:16:12 2023 -0700
@@ -842,7 +842,7 @@
 </varlistentry>
 
 <varlistentry>
-<term>INCLUDEBIN <parameter>filename</parameter></term>
+<term>INCLUDEBIN <parameter>filename</parameter>[,<parameter>start</parameter>[,<parameter>length</parameter>]]</term>
 <listitem>
 <para>
 Treat the contents of <parameter>filename</parameter> as a string of bytes to
@@ -859,6 +859,14 @@
 not function correctly on Windows platforms.  Non-absolute inclusion will
 work, however.</para>
 
+<para> The optional <parameter>start</parameter> parameter allows you to set
+the byte offset to start reading from the binary file. Positive values are
+from the beginning of the file, negative values are from the end of the file.</para>
+
+<para> The optional <parameter>length</parameter> parameter allows you to set
+the number of bytes read from the binary file. If missing, then the file is
+read to the end.</para>
+
 </listitem>
 </varlistentry>