~ubuntu-branches/ubuntu/lucid/ncbi-tools6/lucid

« back to all changes in this revision

Viewing changes to debian/old-blast-man/rpsblast.1

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2002-04-04 22:13:09 UTC
  • Revision ID: james.westby@ubuntu.com-20020404221309-ozxf0jg82nb8ud7h
Tags: 6.1.20011220a-2
Whoops, ncbi-data should replace pre-split versions of ncbi-tools6.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH RPSBLAST 1 2001-09-30 NCBI "NCBI Tools User's Manual"
 
2
.SH NAME
 
3
rpsblast - ...
 
4
.SH SYNOPSIS
 
5
.B rpsblast
 
6
[\|\fB-\fP\|]
 
7
[\|\fB-E\fP\ \fIN\fP\|]
 
8
[\|\fB-F\fP\ \fIstr\fP\|]
 
9
[\|\fB-G\fP\ \fIN\fP\|]
 
10
[\|\fB-H\fP\ \fIN\fP\|]
 
11
[\|\fB-I\fP\|]
 
12
[\|\fB-J\fP\|]
 
13
[\|\fB-N\fP\ \fIX\fP\|]
 
14
[\|\fB-O\fP\ \fIfilename\fP\|]
 
15
[\|\fB-P\fP\ \fIN\fP\|]
 
16
[\|\fB-S\fP\ \fIN\fP\|]
 
17
[\|\fB-T\fP\|]
 
18
[\|\fB-U\fP\|]
 
19
[\|\fB-X\fP\ \fIN\fP\|]
 
20
[\|\fB-Y\fP\ \fIX\fP\|]
 
21
[\|\fB-Z\fP\ \fIN\fP\|]
 
22
[\|\fB-a\fP\ \fIN\fP\|]
 
23
[\|\fB-b\fP\ \fIN\fP\|]
 
24
\fB-d\fP\ \fIfilename\fP
 
25
[\|\fB-e\fP\ \fIX\fP\|]
 
26
[\|\fB-g\ F\fP\|]
 
27
[\|\fB-i\fP\ \fIfilename\fP\|]
 
28
[\|\fB-l\fP\ \fIfilename\fP\|]
 
29
[\|\fB-m\fP\ \fIN\fP\|]
 
30
[\|\fB-o\fP\ \fIfilename\fP\|]
 
31
[\|\fB-p\ F\fP\|]
 
32
[\|\fB-v\fP\ \fIN\fP\|]
 
33
[\|\fB-y\fP\ \fIX\fP\|]
 
34
[\|\fB-z\fP\ \fIN\fP\|]
 
35
.SH DESCRIPTION
 
36
This manual page documents briefly the \fBrpsblast\fP command.
 
37
This manual page was written for the Debian GNU/Linux distribution
 
38
because the original program does not have a manual page.
 
39
.PP
 
40
\fBrpsblast\fP is ...
 
41
.SH OPTIONS
 
42
A summary of options is included below.
 
43
.TP
 
44
\fB-\fP
 
45
Print usage message
 
46
.TP
 
47
\fB-E\fP\ \fIN\fP
 
48
Cost to extend a gap [Integer]
 
49
.br
 
50
    default = 1
 
51
.TP
 
52
\fB-F\fP\ \fIstr\fP
 
53
Filter query sequence with SEG [String]
 
54
.br
 
55
    default = F
 
56
.TP
 
57
\fB-G\fP\ \fIN\fP
 
58
Cost to open a gap [Integer]
 
59
.br
 
60
    default = 11
 
61
.TP
 
62
\fB-H\fP\ \fIN\fP
 
63
End of required region in query (-1 indicates end of query) [Integer]
 
64
.br
 
65
    default = -1
 
66
.TP
 
67
\fB-I\fP
 
68
Show GI's in deflines
 
69
.TP
 
70
\fB-J\fP
 
71
Believe the query defline
 
72
.TP
 
73
\fB-N\fP\ \fIX\fP
 
74
Number of bits to trigger gapping [Real]
 
75
.br
 
76
    default = 22.0
 
77
.TP
 
78
\fB-O\fP\ \fIfilename\fP
 
79
SeqAlign file ('Believe the query defline' must be TRUE) [File Out]
 
80
.TP
 
81
\fB-P\fP\ \fIN\fP
 
82
0 for multiple hits 1-pass, 1 for single hit 1-pass, 2 for 2-pass [Integer]
 
83
.br
 
84
    default = 0
 
85
.TP
 
86
\fB-S\fP\ \fIN\fP
 
87
Start of required region in query [Integer]
 
88
.br
 
89
    default = 1
 
90
.TP
 
91
\fB-T\fP
 
92
Produce HTML output
 
93
.TP
 
94
\fB-U\fP
 
95
Use lower case filtering of FASTA sequence
 
96
 
 
97
.TP
 
98
\fB-X\fP\ \fIN\fP
 
99
X dropoff value for gapped alignment (in bits) [Integer]
 
100
.br
 
101
    default = 15
 
102
.TP
 
103
\fB-Y\fP\ \fIX\fP
 
104
Effective length of the search space (use zero for the real size) [Real]
 
105
.br
 
106
    default = 0
 
107
.TP
 
108
\fB-Z\fP\ \fIN\fP
 
109
X dropoff value for final gapped alignment (in bits) [Integer]
 
110
.br
 
111
    default = 25
 
112
.TP
 
113
\fB-a\fP\ \fIN\fP
 
114
Number of processors to use [Integer]
 
115
.br
 
116
    default = 1
 
117
.TP
 
118
\fB-b\fP\ \fIN\fP
 
119
Number of database sequence to show alignments for (B) [Integer]
 
120
.br
 
121
    default = 250
 
122
.TP
 
123
\fB-d\fP\ \fIfilename\fP
 
124
RPS BLAST Database [File In]
 
125
.TP
 
126
\fB-e\fP\ \fIX\fP
 
127
Expectation value (E) [Real]
 
128
.br
 
129
    default = 10.0
 
130
.TP
 
131
\fB-g\ F\fP
 
132
NOT Gapped
 
133
.TP
 
134
\fB-i\fP\ \fIfilename\fP
 
135
Input query sequence (this parameter must be set) [File In]
 
136
.br
 
137
    default = stdin
 
138
.TP
 
139
\fB-l\fP\ \fIfilename\fP
 
140
Logfile name  [File Out]
 
141
.br
 
142
    default = rpsblast.log
 
143
.TP
 
144
\fB-m\fP\ \fIN\fP
 
145
alignment view options:
 
146
.br
 
147
0 = pairwise,
 
148
.br
 
149
1 = query-anchored showing identities,
 
150
.br
 
151
2 = query-anchored no identities,
 
152
.br
 
153
3 = flat query-anchored, show identities,
 
154
.br
 
155
4 = flat query-anchored, no identities,
 
156
.br
 
157
5 = query-anchored no identities and blunt ends,
 
158
.br
 
159
6 = flat query-anchored, no identities and blunt ends,
 
160
.br
 
161
7 = XML Blast output,
 
162
.br
 
163
8 = tabular output [Integer]
 
164
.br
 
165
    default = 0
 
166
.TP
 
167
\fB-o\fP\ \fIfilename\fP
 
168
Output File for Alignment [File Out]
 
169
.br
 
170
    default = stdout
 
171
.TP
 
172
\fB-p\ F\fP
 
173
NOT Query sequence is protein
 
174
.TP
 
175
\fB-v\fP\ \fIN\fP
 
176
Number of database sequences to show one-line descriptions for (V) [Integer]
 
177
.br
 
178
    default = 500
 
179
.TP
 
180
\fB-y\fP\ \fIX\fP
 
181
Dropoff (X) for blast extensions in bits (default if zero) [Real]
 
182
.br
 
183
    default = 7.0
 
184
.TP
 
185
\fB-z\fP\ \fIN\fP
 
186
Effective length of the database (use zero for the real size) [Integer]
 
187
.br
 
188
    default = 0
 
189
.SH AUTHOR
 
190
This manual page was written by Aaron M. Ucko <ucko@debian.org>,
 
191
for the Debian GNU/Linux system (but may be used by others).