initial commit
[jalview.git] / forester / archive / RIO / others / hmmer / squid / Man / afetch.man
1 .TH "afetch" 1 "@RELEASEDATE@" "@PACKAGE@ @RELEASE@" "@PACKAGE@ Manual"
2
3 .SH NAME
4 .TP 
5 afetch - retrieve an alignment from an alignment database 
6
7 .SH SYNOPSIS
8 .B afetch
9 .I [options]
10 .I alignmentdb
11 .I key
12
13 .PP
14 .B afetch --index
15 .I alignmentdb
16
17 .SH DESCRIPTION
18
19 .B afetch
20 retrieves the alignment named
21 .I key
22 from an alignment database in file
23 .I alignmentdb.
24
25 .PP 
26 .I alignmentdb 
27 is a "multiple multiple alignment" file in Stockholm (e.g. native
28 Pfam) format.
29
30 .PP
31 .I key 
32 is either the name (ID) of the alignment, or its accession
33 number (AC).
34
35 .PP
36 The 
37 .I alignmentdb
38 file should first be SSI indexed with
39 .B afetch --index
40 for efficient retrieval. An SSI index is
41 not required, but alignment retrieval without one may
42 be painfully slow.
43
44 .SH OPTIONS
45
46 .TP
47 .B -h
48 Print brief help; includes version number and summary of
49 all options, including expert options.
50
51 .SH EXPERT OPTIONS
52
53 .TP
54 .B --index
55 Instead of retrieving a
56 .I key,
57 the special command
58 .B afetch --index
59 .I alignmentdb
60 produces an SSI index of the names and accessions
61 of the alignments in 
62 the file 
63 .I alignmentdb. 
64 This should be run once on the 
65 .I alignmentdb
66 file to prepare it for all future afetch's.
67
68 .SH SEE ALSO
69
70 .PP
71 Master man page, with full list of and guide to the
72 individual man pages for SQUID's auxiliary programs: see
73 .B squid(1).
74
75 .SH AUTHOR
76
77 @PACKAGE@ and its documentation is @COPYRIGHT@
78 HMMER - Biological sequence analysis with profile HMMs
79 Copyright (C) 1992-1999 Washington University School of Medicine
80 All Rights Reserved
81
82     This source code is distributed under the terms of the
83     GNU General Public License. See the files COPYING and LICENSE
84     for details.
85 See COPYING in the source code distribution for more details, or contact me.
86
87 .nf
88 Sean Eddy
89 Dept. of Genetics
90 Washington Univ. School of Medicine
91 4566 Scott Ave.
92 St Louis, MO 63110 USA
93 Phone: 1-314-362-7666
94 FAX  : 1-314-362-7855
95 Email: eddy@genetics.wustl.edu
96 .fi
97
98