.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.2.
.TH KMC "1" "March 2021" "K-Mer Counter (KMC) ver. 3.1.1 (2019-05-19)" "kmc"
.SH NAME
kmc - count kmers in genomic sequences
.SH DESCRIPTION
KMC—K-mer Counter is a utility designed for counting k-mers (sequences of consecutive k symbols) in a set of reads from genome sequencing projects.

.SH SYNOPSIS
kmc [options] <input_file_name> <output_file_name> <working_directory>
.PP
kmc [options] <@input_file_names> <output_file_name> <working_directory>
.SH OPTIONS
.HP
\fB\-v\fR \- verbose mode (shows all parameter settings); default: false
.HP
\fB\-k\fR<len> \- k\-mer length (k from 1 to 256; default: 25)
.HP
\fB\-m\fR<size> \- max amount of RAM in GB (from 1 to 1024); default: 12
.HP
\fB\-sm\fR \- use strict memory mode (memory limit from \fB\-m\fR<n> switch will not be exceeded)
.HP
\fB\-p\fR<par> \- signature length (5, 6, 7, 8, 9, 10, 11); default: 9
.HP
\fB\-f\fR<a/q/m/bam> \- input in FASTA format (\fB\-fa\fR), FASTQ format (\fB\-fq\fR), multi FASTA (\fB\-fm\fR) or BAM (\fB\-fbam\fR); default: FASTQ
.HP
\fB\-ci\fR<value> \- exclude k\-mers occurring less than <value> times (default: 2)
.HP
\fB\-cs\fR<value> \- maximal value of a counter (default: 255)
.HP
\fB\-cx\fR<value> \- exclude k\-mers occurring more of than <value> times (default: 1e9)
.HP
\fB\-b\fR \- turn off transformation of k\-mers into canonical form
.HP
\fB\-r\fR \- turn on RAM\-only mode
.HP
\fB\-n\fR<value> \- number of bins
.HP
\fB\-t\fR<value> \- total number of threads (default: no. of CPU cores)
.HP
\fB\-sf\fR<value> \- number of FASTQ reading threads
.HP
\fB\-sp\fR<value> \- number of splitting threads
.HP
\fB\-sr\fR<value> \- number of threads for 2nd stage
.HP
\fB\-j\fR<file_name> \- file name with execution summary in JSON format
.HP
\fB\-w\fR \- without output
.PP
.SH EXAMPLES
kmc \fB\-k27\fR \fB\-m24\fR NA19238.fastq NA.res /data/kmc_tmp_dir/
.PP
kmc \fB\-k27\fR \fB\-m24\fR @files.lst NA.res /data/kmc_tmp_dir/
.SH "AUTHOR"
.sp
kmc was originally written by:
.PP
Sebastian Deorowicz (sebastian.deorowicz@polsl.pl)
.PP
Marek Kokot
.PP
Szymon Grabowski
.PP
Agnieszka Debudaj-Grabysz

.SH "COPYING"
.sp
KMC is a free software distributed under GNU GPL3 licence for academic, research, and commercial use.