initial commit
[jalview.git] / forester / archive / RIO / others / hmmer / documentation / man / hmmconvert.man
1 .TH "hmmconvert" 1 "@RELEASEDATE@" "HMMER @RELEASE@" "HMMER Manual"
2
3 .SH NAME
4 .TP 
5 hmmconvert - convert between profile HMM file formats
6
7 .SH SYNOPSIS
8 .B hmmconvert
9 .I [options]
10 .I oldhmmfile
11 .I newhmmfile
12
13 .SH DESCRIPTION
14
15 .B hmmconvert
16 reads an HMM file from
17 .I oldhmmfile
18 in any HMMER format, and writes it to a new file
19 .I newhmmfile 
20 in a new format.
21 .I oldhmmfile 
22 and 
23 .I newhmmfile
24 must be different files; you can't reliably overwrite 
25 the old file.
26 By default, the new HMM file is written in HMMER 2
27 ASCII format. 
28
29 Available formats are HMMER 2 ASCII (default), HMMER 2 binary
30 .I (-b)
31 GCG profile 
32 .I (-p)
33 , and Compugen XSW extended profile 
34 .I (-P).
35
36 .SH OPTIONS
37
38 .TP
39 .B -a 
40 Convert to HMMER 2 ASCII file. This is the default, so this option
41 is unnecessary.
42
43 .TP 
44 .B -b 
45 Convert to HMMER 2 binary file. 
46
47 .TP
48 .B -h
49 Print brief help; includes version number and summary of
50 all options, including expert options.
51
52 .TP
53 .B -p
54 Convert to GCG profile .prf format.
55
56 .TP 
57 .B -A
58 Append mode; append to
59 .I newhmmfile
60 rather than creating a new file. 
61
62 .TP
63 .B -F
64 Force; if 
65 .I newhmmfile
66 already exists, and
67 .I -A 
68 is not being used to append to the file,
69 hmmconvert will refuse to clobber the existing
70 file unless 
71 .I -F 
72 is used.
73
74 .TP
75 .B -P
76 Convert the HMM to Compugen XSW extended profile format,
77 which is similar to GCG profile format but has two
78 extra columns for delete-open and delete-extend costs.
79 (I do not believe that Compugen publicly supports this
80 format; it may be undocumented.)
81
82 .SH SEE ALSO
83
84 .PP
85 Master man page, with full list of and guide to the individual man
86 pages: see 
87 .B hmmer(1).
88 .PP
89 A User guide and tutorial came with the distribution:
90 .B Userguide.ps
91 [Postscript] and/or
92 .B Userguide.pdf
93 [PDF].
94 .PP
95 Finally, all documentation is also available online via WWW: 
96 .B http://hmmer.wustl.edu/
97
98 .SH AUTHOR
99
100 This software and documentation is: 
101 .nf
102 @COPYRIGHT@
103 HMMER - Biological sequence analysis with profile HMMs
104 Copyright (C) 1992-1999 Washington University School of Medicine
105 All Rights Reserved
106
107     This source code is distributed under the terms of the
108     GNU General Public License. See the files COPYING and LICENSE
109     for details.
110 .fi
111 See the file COPYING in your distribution for complete details.
112
113 .nf
114 Sean Eddy
115 HHMI/Dept. of Genetics
116 Washington Univ. School of Medicine
117 4566 Scott Ave.
118 St Louis, MO 63110 USA
119 Phone: 1-314-362-7666
120 FAX  : 1-314-362-7855
121 Email: eddy@genetics.wustl.edu
122 .fi
123
124