← Back to branch summary

~ubuntu-branches/ubuntu/maverick/ncbi-tools6/maverick

« back to all changes in this revision

Viewing changes to doc/man/fastacmd.1

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2005-03-27 12:00:15 UTC
  • mfrom: (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050327120015-embhesp32nj73p9r
Tags: 6.1.20041020-3
http://bugs.debian.org/295110
* Fix FTBFS under GCC 4.0 caused by inconsistent use of "static" on
  functions.  (Closes: #295110.)
* Add a watch file, now that we can.  (Upstream's layout needs version=3.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/fastacmd.1
 
1
.TH FASTACMD 1 2004-06-25 NCBI "NCBI Tools User's Manual"
 
2
.SH NAME
 
3
fastacmd \- retrieve FASTA sequences from a BLAST database
 
4
.SH SYNOPSIS
 
5
.B fastacmd
 
6
[\|\fB\-\fP\|]
 
7
[\|\fB\-D\fP\|]
 
8
[\|\fB\-I\fP\|]
 
9
[\|\fB\-L\fP\ \fIstart\fP,\fIstop\fP\|]
 
10
[\|\fB\-P\fP\ \fIN\fP\|]
 
11
[\|\fB\-S\fP\ \fIN\fP\|]
 
12
[\|\fB\-T\fP\|]
 
13
[\|\fB\-a\fP\|]
 
14
[\|\fB\-c\fP\|]
 
15
[\|\fB\-d\fP\ \fIstr\fP\|]
 
16
[\|\fB\-i\fP\ \fIstr\fP\|]
 
17
[\|\fB\-l\fP\ \fIN\fP\|]
 
18
[\|\fB\-o\fP\ \fIfilename\fP\|]
 
19
[\|\fB\-p\fP\ \fItype\fP\|]
 
20
[\|\fB\-s\fP\ \fIstr\fP\|]
 
21
[\|\fB\-t\fP\|]
 
22
.SH DESCRIPTION
 
23
\fBfastacmd\fP retrieves FASTA formatted sequences from a
 
24
\fBblast\fP(1) database formatted using the '\fB\-o\fP' option.  An
 
25
example \fBfastacmd\fP call would be
 
26
.PP
 
27
.ce
 
28
fastacmd -d nr -s p38398
 
29
.SH OPTIONS
 
30
A summary of options is included below.
 
31
.TP
 
32
\fB\-\fP
 
33
Print usage message
 
34
.TP
 
35
\fB\-D\fP
 
36
Dump the entire database in FASTA format
 
37
.TP
 
38
\fB\-I\fP
 
39
Print database information only (overrides all other options)
 
40
.TP
 
41
\fB\-L\fP\ \fIstart\fP,\fIstop\fP
 
42
Range of sequence to extract (0 in start is beginning of sequence, 0
 
43
in stop is end of sequence, default is whole sequence)
 
44
.TP
 
45
\fB\-P\fP\ \fIN\fP
 
46
Retrieve sequences with Protein Identification Group (PIG) \fIN\fP.
 
47
.TP
 
48
\fB\-S\fP\ \fIN\fP
 
49
Strand on subsequence (nucleotide only):
 
50
.RS
 
51
.PD 0
 
52
.IP 1
 
53
top (default)
 
54
.IP 2
 
55
bottom
 
56
.PD
 
57
.RE
 
58
.TP
 
59
\fB\-T\fP
 
60
Print taxonomic information for requested sequence(s)
 
61
.TP
 
62
\fB\-a\fP
 
63
Retrieve duplicate accessions
 
64
.TP
 
65
\fB\-c\fP
 
66
Use ^A (\e001) as non-redundant defline separator
 
67
.TP
 
68
\fB\-d\fP\ \fIstr\fP
 
69
Database (default is nr)
 
70
.TP
 
71
\fB\-i\fP\ \fIstr\fP
 
72
Input file wilth GIs/accessions/loci for batch retrieval
 
73
.TP
 
74
\fB\-l\fP\ \fIN\fP
 
75
Line length for sequence (default = 80)
 
76
.TP
 
77
\fB\-o\fP\ \fIfilename\fP
 
78
Output file (default = stdout)
 
79
.TP
 
80
\fB\-p\fP\ \fItype\fP
 
81
Type of file:
 
82
.RS
 
83
.PD 0
 
84
.IP G
 
85
guess (default) - look for protein, then nucleotide
 
86
.IP T
 
87
protein
 
88
.IP F
 
89
nucleotide
 
90
.PD
 
91
.RE
 
92
.TP
 
93
\fB\-s\fP\ \fIstr\fP
 
94
Search string: GIs, accessions and loci may be used delimited by commas
 
95
.TP
 
96
\fB\-t\fP
 
97
Definition line should contain target GI only
 
98
.SH EXIT STATUS
 
99
.RS
 
100
.PD 0
 
101
.IP 0
 
102
Completed successfully.
 
103
.IP 1
 
104
An error (other than those below) occurred.
 
105
.IP 2
 
106
The BLAST database was not found.
 
107
.IP 3
 
108
A search (accession, GI, or taxonomy info) failed.
 
109
.IP 4
 
110
No taxonomy database was found.
 
111
.PD
 
112
.RE
 
113
.SH AUTHOR
 
114
The National Center for Biotechnology Information.
 
115
.SH SEE ALSO
 
116
.BR blast (1),
 
117
fastacmd.html