~ubuntu-branches/ubuntu/quantal/genometools/quantal-backports

« back to all changes in this revision

Viewing changes to debian/man/gt-packedindex-chksearch.1

  • Committer: Package Import Robot
  • Author(s): Sascha Steinbiss
  • Date: 2012-07-09 14:10:23 UTC
  • Revision ID: package-import@ubuntu.com-20120709141023-7nomj0v4le7izeju
Tags: 1.4.1-1
* Initial release (Closes: #657923)
* the GFF3 parser now handles children which are defined before their parents
* many small improvements to the GFF3 parser

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" t
 
2
.\"     Title: gt-packedindex-chksearch
 
3
.\"    Author: [see the "AUTHOR" section]
 
4
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
 
5
.\"      Date: 07/11/2012
 
6
.\"    Manual: \ \&
 
7
.\"    Source: \ \&
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "GT\-PACKEDINDEX\-CHK" "1" "07/11/2012" "\ \&" "\ \&"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * Define some portability stuff
 
13
.\" -----------------------------------------------------------------
 
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
15
.\" http://bugs.debian.org/507673
 
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
18
.ie \n(.g .ds Aq \(aq
 
19
.el       .ds Aq '
 
20
.\" -----------------------------------------------------------------
 
21
.\" * set default formatting
 
22
.\" -----------------------------------------------------------------
 
23
.\" disable hyphenation
 
24
.nh
 
25
.\" disable justification (adjust text to left margin only)
 
26
.ad l
 
27
.\" -----------------------------------------------------------------
 
28
.\" * MAIN CONTENT STARTS HERE *
 
29
.\" -----------------------------------------------------------------
 
30
.SH "NAME"
 
31
gt-packedindex-chksearch \- Load (or build if necessary) BWT index for project [indexname] and perform verification of search results\&.
 
32
.SH "SYNOPSIS"
 
33
.sp
 
34
gt packedindex chksearch indexname
 
35
.SH "OPTIONS"
 
36
.PP
 
37
\fB\-bsize\fR
 
38
.RS 4
 
39
specify size of blocks (default: 8)
 
40
.RE
 
41
.PP
 
42
\fB\-blbuck\fR
 
43
.RS 4
 
44
specify number of blocks per bucket (default: 8)
 
45
.RE
 
46
.PP
 
47
\fB\-locfreq\fR
 
48
.RS 4
 
49
specify the locate frequency parameter i means that each i\-th position of input string is stored 0 ⇒ no locate information (default: 16)
 
50
.RE
 
51
.PP
 
52
\fB\-locbitmap\fR
 
53
.RS 4
 
54
marked/unmarked positions for locate are stored as bitmaps this gives faster location of hits but increases the index by 1 bit per symbol (default: yes)
 
55
.RE
 
56
.PP
 
57
\fB\-sprank\fR
 
58
.RS 4
 
59
build rank table for special symbols this produces an index which can be used to regenerate the original sequence but increases the memory used during index creation (default: no)
 
60
.RE
 
61
.PP
 
62
\fB\-sprankilog\fR
 
63
.RS 4
 
64
specify the interval of rank sampling as log value parameter i means that each 2^i\-th position of source is sampled for rank undefined ⇒ chooses default of log(log(sequence length)) (default: undefined)
 
65
.RE
 
66
.PP
 
67
\fB\-ctxilog\fR
 
68
.RS 4
 
69
specify the interval of context sampling as log value parameter i means that each 2^i\-th position of source is sampled for rank \-1 ⇒ chooses default of log(log(sequence length)) \-2 ⇒ generates no map (default: \-2)
 
70
.RE
 
71
.PP
 
72
\fB\-minpatlen\fR
 
73
.RS 4
 
74
minimum length of patterns searched for, \-1 implies automatic choice based on index properties (default: \-1)
 
75
.RE
 
76
.PP
 
77
\fB\-maxpatlen\fR
 
78
.RS 4
 
79
maximum length of patterns searched for, \-1 implies automatic choice based on index properties (default: \-1)
 
80
.RE
 
81
.PP
 
82
\fB\-nsamples\fR
 
83
.RS 4
 
84
number of sequences to search for (default: 1000)
 
85
.RE
 
86
.PP
 
87
\fB\-chksfxarray\fR
 
88
.RS 4
 
89
verify integrity of stored suffix array positions (default: no)
 
90
.RE
 
91
.PP
 
92
\fB\-full\-lfmap\fR
 
93
.RS 4
 
94
verify complete backwards regeneration of original sequence (default: no)
 
95
.RE
 
96
.PP
 
97
\fB\-chkcontext\fR
 
98
.RS 4
 
99
verify integrity of regenerated sequence context (default: no)
 
100
.RE
 
101
.PP
 
102
\fB\-ticks\fR
 
103
.RS 4
 
104
print dot after this many symbols tested okay (default: 100000)
 
105
.RE
 
106
.PP
 
107
\fB\-v\fR
 
108
.RS 4
 
109
print verbose progress information (default: no)
 
110
.RE
 
111
.PP
 
112
\fB\-help\fR
 
113
.RS 4
 
114
display help and exit
 
115
.RE
 
116
.PP
 
117
\fB\-version\fR
 
118
.RS 4
 
119
display version information and exit
 
120
.RE
 
121
.SH "AUTHOR"
 
122
.sp
 
123
Report bugs to <gt\-users@genometools\&.org>\&.