From d118cafd2590a64adec2f0a35c4e9cdb69a76a5e Mon Sep 17 00:00:00 2001 From: Heng Li Date: Fri, 30 Jun 2017 23:30:17 -0400 Subject: [PATCH] added man page --- minimap2.1 | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 minimap2.1 diff --git a/minimap2.1 b/minimap2.1 new file mode 100644 index 0000000..4061a72 --- /dev/null +++ b/minimap2.1 @@ -0,0 +1,52 @@ +.TH minimap 1 "30 June 2017" "minimap2-2.0-r126-pre" "Bioinformatics tools" + +.SH NAME +.PP +minimap2 - mapping and alignment between collections of DNA sequences + +.SH SYNOPSIS +* Index the target sequences (optional): +.RS 4 +minimap2 +.RB [ -H ] +.RB [ -k +.IR kmer ] +.RB [ -w +.IR miniWinSize ] +.B -d +.I target.mmi +.I target.fa +.RE + +* Align with CIGAR: +.RS 4 +minimap2 +.B -b +.RB [ -x +.IR preset ] +.I target.mmi +.I query.fa +> +.I output.sam +.br +minimap2 +.B -c +.RB [ -H ] +.RB [ -k +.IR kmer ] +.RB [ -w +.IR miniWinSize ] +.RB [ ... ] +.I target.fa +.I query.fa +> +.I output.paf +.RE + +.SH DESCRIPTION +.PP +Minimap2 is a fast sequence mapping and alignment program that can find +overlaps between long noisy reads, or map long reads or their assemblies to a +reference genome optionally with detailed alignment (i.e. CIGAR). For +reference-based alignment, it works efficiently with query sequences from a few +kilobases to ~100 megabases in length at a error rate ~15%.