Skip to content

Commit 0a8f76f

Browse files
committed
update help message
1 parent 359aa97 commit 0a8f76f

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/content/usage/index/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Important parameters:
114114
($input_files / --batch-size), please increase this value and set a bigger "ulimit -n" in shell.
115115
116116
Usage:
117-
lexicmap index [flags] [-k <k>] [-m <masks>] { -I <seqs dir> | -X <file list>} -O <out dir>
117+
lexicmap index [flags] [-k <k>] [-m <masks>] {-I <seqs dir> | [-S] -X <file list>} -O <index.lmi>
118118
119119
Flags:
120120
-b, --batch-size int ► Maximum number of genomes in each batch (maximum value: 131072)

docs/content/usage/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Result ordering:
7070
3. Results of multiple subject genomes are sorted by the highest SimilarityScore of HSP clusters.
7171
7272
Usage:
73-
lexicmap search [flags] -d <index path> [query.fasta.gz ...] [-o query.tsv.gz]
73+
lexicmap search [flags] -d <index path> [query.fasta[.gz] ...] [-o result.tsv[.gz]]
7474
7575
Flags:
7676
--align-band int ► Band size in backtracking the score matrix (pseudo alignment

lexicmap/cmd/index.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@ func init() {
615615
indexCmd.Flags().BoolP("debug", "", false,
616616
formatFlagUsage(`Print debug information.`))
617617

618-
indexCmd.SetUsageTemplate(usageTemplate("[-k <k>] [-m <masks>] { -I <seqs dir> | -X <file list>} -O <out dir>"))
618+
indexCmd.SetUsageTemplate(usageTemplate("[-k <k>] [-m <masks>] {-I <seqs dir> | [-S] -X <file list>} -O <index.lmi>"))
619619
}
620620

621621
var defaultChunks int

lexicmap/cmd/search.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,7 @@ func init() {
757757
mapCmd.Flags().BoolP("debug", "", false,
758758
formatFlagUsage(`Print debug information, including a progress bar. (recommended when searching with one query).`))
759759

760-
mapCmd.SetUsageTemplate(usageTemplate("-d <index path> [query.fasta.gz ...] [-o query.tsv.gz]"))
760+
mapCmd.SetUsageTemplate(usageTemplate("-d <index path> [query.fasta[.gz] ...] [-o result.tsv[.gz]]"))
761761

762762
// filter by taxids
763763

0 commit comments

Comments
 (0)