aboutsummaryrefslogtreecommitdiff
path: root/docs/_source/legacy_converter.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_source/legacy_converter.txt')
-rw-r--r--docs/_source/legacy_converter.txt28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/_source/legacy_converter.txt b/docs/_source/legacy_converter.txt
new file mode 100644
index 0000000..ff7048b
--- /dev/null
+++ b/docs/_source/legacy_converter.txt
@@ -0,0 +1,28 @@
+/*! \page pageconverter LegacyConverter
+
+\verbatim
+
+USAGE:
+
+ LegacyConverter <infile> [-t <type>] [-o <outfile>] [-e <encoding>]
+
+Where:
+
+ <infile> (required) Input legacy format file.
+
+ -t <type>
+ (optional) The file format of <infile>. Must be one of: {llasset, tkasset, bpxa, pllasset, ptkasset, pbpxa} (case insensitive).
+ If not given, the file extension of <infile> is used.
+
+ -outfile <outfile>
+ (optional) Filename (including path) of the output converted file.
+ If not given, the filename <infile> is used, with extension (if it has one) changed to .blast.
+
+ -e <encoding>
+ (optional) Encoding to use for output file. Must be one of: {cpnb, raw} (case insensitive).
+ If not given, cpnb (Cap'n Proto binary) is used.
+
+\endverbatim
+
+<br>
+*/