about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2026-08-26 02:50:29 +0100
committerArun Isaac2026-08-26 02:50:29 +0100
commitb0277ae1da434d81a744a87f4152e6d7852ee4ed (patch)
treedb6b9b67b94bc161bcff46e36bda5f079cf5eacf /doc
parent13d4cace4b54dccb85643d63ada194f0ec2493b2 (diff)
downloaddomagi-b0277ae1da434d81a744a87f4152e6d7852ee4ed.tar.gz
domagi-b0277ae1da434d81a744a87f4152e6d7852ee4ed.tar.lz
domagi-b0277ae1da434d81a744a87f4152e6d7852ee4ed.zip
Do not traverse graph when extracting segments in path range.
Diffstat (limited to 'doc')
-rw-r--r--doc/domagi-extract.dbk20
1 files changed, 13 insertions, 7 deletions
diff --git a/doc/domagi-extract.dbk b/doc/domagi-extract.dbk
index a2b7c6b..d20afd9 100644
--- a/doc/domagi-extract.dbk
+++ b/doc/domagi-extract.dbk
@@ -9,23 +9,29 @@
       <title>Options</title>
       <xi:include href="input-db-argument.dbk" />
       <xi:include href="output-db-argument.dbk" />
+      <xi:include href="threads-argument.dbk" />
+      <xi:include href="help-option.dbk" />
+    </variablelist>
+    <variablelist>
+      <title>Traverse the graph from a segment</title>
       <varlistentry>
         <term><option>-n <replaceable>SEGMENT</replaceable></option></term>
         <term><option>--node=<replaceable>SEGMENT</replaceable></option></term>
         <listitem><para>Segment name from which to begin the traversal</para></listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>-r <replaceable>PATH_RANGE</replaceable></option></term>
-        <term><option>--path-range=<replaceable>PATH_RANGE</replaceable></option></term>
-        <listitem><para>Path range, in <replaceable>path[:pos1[-pos2]]</replaceable> format, from which to begin the traversal</para></listitem>
-      </varlistentry>
-      <varlistentry>
         <term><option>-c <replaceable>STEPS</replaceable></option></term>
         <term><option>--context-steps=<replaceable>STEPS</replaceable></option></term>
         <listitem><para>The number of segments away from the initial segments to traverse</para></listitem>
       </varlistentry>
-      <xi:include href="threads-argument.dbk" />
-      <xi:include href="help-option.dbk" />
+    </variablelist>
+    <variablelist>
+      <title>Extract segments in path range</title>
+      <varlistentry>
+        <term><option>-r <replaceable>PATH_RANGE</replaceable></option></term>
+        <term><option>--path-range=<replaceable>PATH_RANGE</replaceable></option></term>
+        <listitem><para>Extract segments in <replaceable>PATH_RANGE</replaceable>, specified in the <replaceable>path[:pos1[-pos2]]</replaceable> format. <replaceable>pos1</replaceable> and <replaceable>pos2</replaceable> are 0-based coordinates. The extracted segments include <replaceable>pos1</replaceable> (inclusive) but not <replaceable>pos2</replaceable> (exclusive).</para></listitem>
+      </varlistentry>
     </variablelist>
   </refsection>
 </refentry>