forester/archive/RIO/others/hmmer/documentation/man/hmmer.man

   1 .TH "hmmer" 1 @RELEASEDATE@ "HMMER @RELEASE@" "HMMER Manual"
   2
   3 .SH NAME
   4 .TP
   5 HMMER - profile hidden Markov model software
   6
   7 .SH SYNOPSIS
   8 .TP
   9 .B hmmalign
  10 Align multiple sequences to a profile HMM.
  11
  12 .TP
  13 .B hmmbuild
  14 Build a profile HMM from a given multiple sequence alignment.
  15
  16 .TP
  17 .B hmmcalibrate
  18 Determine appropriate statistical significance parameters
  19 for a profile HMM prior to doing database searches.
  20
  21 .TP
  22 .B hmmconvert
  23 Convert HMMER profile HMMs to other formats, such as GCG profiles.
  24
  25 .TP
  26 .B hmmemit
  27 Generate sequences probabilistically from a profile HMM.
  28
  29 .TP
  30 .B hmmfetch
  31 Retrieve an HMM from an HMM database
  32
  33 .TP
  34 .B hmmindex
  35 Create a binary SSI index for an HMM database
  36
  37 .TP
  38 .B hmmpfam
  39 Search a profile HMM database with a sequence (i.e., annotate various
  40 kinds of domains in the query sequence).
  41
  42 .TP
  43 .B hmmsearch
  44 Search a sequence database with a profile HMM (i.e., find additional
  45 homologues of a modeled family).
  46
  47 .SH DESCRIPTION
  48
  49 These programs use profile hidden Markov models (profile HMMs) to
  50 model the primary structure consensus of a family of protein or
  51 nucleic acid sequences.
  52
  53 .SH OPTIONS
  54
  55 .PP
  56 All
  57 .B HMMER
  58 programs give a brief summary of their command-line syntax and options
  59 if invoked without any arguments.
  60 When invoked with the single argument,
  61 .B -h
  62 (i.e., help), a program will report more verbose command-line usage
  63 information, including rarely used, experimental, and expert options.
  64 .B -h
  65 will report version numbers which are useful if
  66 you need to report a bug or problem to me.
  67
  68 .PP
  69 Each
  70 .B HMMER
  71 program has its own man page briefly summarizing command line usage.
  72 There is also a user's guide that came
  73 with the software distribution, which includes a tutorial introduction
  74 and more detailed descriptions of the programs.
  75
  76 See http://hmmer.wustl.edu/ for on-line documentation and
  77 the current HMMER release.
  78
  79 .PP
  80 In general, no command line options should be needed by beginning users.
  81 The defaults are set up for optimum performance in most situations.
  82 Options that are single lowercase letters (e.g.
  83 .B -a
  84 ) are "common" options that are expected to be frequently used
  85 and will be important in many applications.
  86 Options that are single uppercase letters (e.g.
  87 .B -B
  88 ) are usually less common options, but also may be important
  89 in some applications.
  90 Options that are full words (e.g.
  91 .B --verbose
  92 ) are either rarely used, experimental, or expert options.
  93 Some experimental options are only there for my own ongoing experiments
  94 with HMMER, and may not be supported or documented adequately.
  95
  96
  97 .SH SEQUENCE FILE FORMATS
  98
  99 In general,
 100 .B HMMER
 101 attempts to read most common biological sequence file formats.
 102 It autodetects the format of the file. It also autodetects
 103 whether the sequences are protein or nucleic acid.
 104 Standard IUPAC degeneracy codes are allowed in addition
 105 to the usual 4-letter or 20-letter codes.
 106
 107 .TP
 108 .B Unaligned sequences
 109 Unaligned sequence files may be in FASTA, Swissprot, EMBL, GenBank,
 110 PIR, Intelligenetics, Strider, or GCG format.
 111 These formats
 112 are documented in the User's Guide.
 113
 114 .TP
 115 .B Sequence alignments
 116 Multiple sequence alignments may be in CLUSTALW, SELEX, or GCG MSF
 117 format. These formats
 118 are documented in the User's Guide.
 119
 120 .SH ENVIRONMENT VARIABLES
 121
 122 For ease of using large stable sequence and HMM databases,
 123 .B HMMER
 124 looks for sequence files and HMM files in the current
 125 working directory as well as in system directories specified
 126 by environment variables.
 127
 128 .TP
 129 .B BLASTDB
 130 Specifies the directory location of sequence databases. Example:
 131 .B /seqlibs/blast-db/.
 132 In installations that use BLAST software, this environment variable
 133 is likely to already be set.
 134
 135 .TP
 136 .B HMMERDB
 137 Specifies the directory location of HMM databases. Example:
 138 .B /seqlibs/pfam/.
 139
 140 .SH SEE ALSO
 141
 142 .PP
 143 @SEEALSO@
 144 .PP
 145 User guide and tutorial: Userguide.ps
 146 .PP
 147 WWW:
 148 .B http://hmmer.wustl.edu/
 149
 150 .SH AUTHOR
 151
 152 This software and documentation is Copyright (C) 1992-1998 Washington
 153 University School of Medicine.  It is freely distributable under terms
 154 of the GNU General Public License. See COPYING in the source code
 155 distribution for more details, or contact me.
 156
 157 .nf
 158 Sean Eddy
 159 Dept. of Genetics
 160 Washington Univ. School of Medicine
 161 4566 Scott Ave.
 162 St Louis, MO 63110 USA
 163 Phone: 1-314-362-7666
 164 FAX  : 1-314-362-7855
 165 Email: eddy@genetics.wustl.edu
 166 .fi
 167
 168