about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2026-08-18 14:44:46 +0100
committerArun Isaac2026-08-21 04:03:20 +0100
commitd2282f6b7453a023af92424309e8713f5c8f7ca7 (patch)
tree457d50052cb9dcab893fcec0a28700f73a259108 /doc
parent5d65c47b0388b3e3fa50b8ddfbda4f417af4735f (diff)
downloaddomagi-d2282f6b7453a023af92424309e8713f5c8f7ca7.tar.gz
domagi-d2282f6b7453a023af92424309e8713f5c8f7ca7.tar.lz
domagi-d2282f6b7453a023af92424309e8713f5c8f7ca7.zip
Add chop subcommand.
Diffstat (limited to 'doc')
-rw-r--r--doc/domagi-chop.dbk22
-rw-r--r--doc/domagi.dbk1
2 files changed, 23 insertions, 0 deletions
diff --git a/doc/domagi-chop.dbk b/doc/domagi-chop.dbk
new file mode 100644
index 0000000..dc308e1
--- /dev/null
+++ b/doc/domagi-chop.dbk
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:xlink="http://www.w3.org/1999/xlink">
+  <xi:include href="gen-refentry-chop.xml" />
+  <refsection>
+    <title>Description</title>
+    <para>Divide segments into smaller pieces while preserving the graph topology.</para>
+    <variablelist>
+      <title>Options</title>
+      <xi:include href="input-db-argument.dbk" />
+      <xi:include href="output-db-argument.dbk" />
+      <varlistentry>
+        <term><option>-c <replaceable>N</replaceable></option></term>
+        <term><option>--chop-to=<replaceable>N</replaceable></option></term>
+        <listitem><para>Divide nodes that are longer than <replaceable>N</replaceable> base pairs into nodes no longer than <replaceable>N</replaceable> while preserving the graph topology.</para></listitem>
+      </varlistentry>
+      <xi:include href="threads-argument.dbk" />
+      <xi:include href="help-option.dbk" />
+    </variablelist>
+  </refsection>
+</refentry>
diff --git a/doc/domagi.dbk b/doc/domagi.dbk
index 53f25e2..0888ac1 100644
--- a/doc/domagi.dbk
+++ b/doc/domagi.dbk
@@ -8,6 +8,7 @@
 <reference>
   <title>Reference</title>
   <xi:include href="domagi-build.dbk" />
+  <xi:include href="domagi-chop.dbk" />
   <xi:include href="domagi-crush.dbk" />
   <xi:include href="domagi-depth.dbk" />
   <xi:include href="domagi-extract.dbk" />