← Back to branch summary

~ubuntu-branches/ubuntu/hardy/kalign/hardy

« back to all changes in this revision

Viewing changes to debian/kalign.1.xml

  • Committer: Bazaar Package Importer
  • Author(s): Charles Plessy
  • Date: 2006-04-29 23:02:57 UTC
  • Revision ID: james.westby@ubuntu.com-20060429230257-ylotjdj8fdi5irq8
Tags: 1.04-1
http://bugs.debian.org/365344
Initial release Closes: #365344

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/kalign.1.xml
 
1
<?xml version='1.0' encoding='ISO-8859-1'?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 
3
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
 
4
 
 
5
 
 
6
  <!ENTITY dhfirstname "<firstname>Charles</firstname>">
 
7
  <!ENTITY dhsurname   "<surname>Plessy</surname>">
 
8
  <!ENTITY dhdate      "<date>avril 29, 2006</date>">
 
9
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
 
10
  <!ENTITY dhemail     "<email>charles-debian-nospam@plessy.org</email>">
 
11
  <!ENTITY dhusername  "Charles Plessy">
 
12
  <!ENTITY dhucpackage "<refentrytitle>KALIGN</refentrytitle>">
 
13
  <!ENTITY dhpackage   "kalign">
 
14
  <!ENTITY debian      "<productname>Debian</productname>">
 
15
  <!ENTITY gnu         "<acronym>GNU</acronym>">
 
16
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
 
17
]>
 
18
 
 
19
<!-- Copyright 2006 Charles Plessy. You can use, copy, and redistribute this manpage under the GNU GPL. -->
 
20
 
 
21
<refentry>
 
22
  <refentryinfo>
 
23
    <address>
 
24
      &dhemail;
 
25
    </address>
 
26
<!--    <author>
 
27
      &dhfirstname;
 
28
      &dhsurname;
 
29
    </author> -->
 
30
    <copyright>
 
31
      <year>2006</year>
 
32
      <holder>&dhusername;</holder>
 
33
    </copyright>
 
34
    &dhdate;
 
35
  </refentryinfo>
 
36
  <refmeta>
 
37
    &dhucpackage;
 
38
 
 
39
    &dhsection;
 
40
  </refmeta>
 
41
  <refnamediv>
 
42
    <refname>&dhpackage;</refname>
 
43
 
 
44
    <refpurpose>performs multiple alignment of biological sequences.</refpurpose>
 
45
  </refnamediv>
 
46
  <refsynopsisdiv>
 
47
    <cmdsynopsis>
 
48
      <command>&dhpackage;</command>
 
49
      <arg choice="opt">Options</arg>
 
50
      <arg choice="opt">
 
51
        <replaceable>infile.fasta</replaceable>
 
52
      </arg>
 
53
      <arg choice="opt">
 
54
        <replaceable>outfile.fasta</replaceable>
 
55
      </arg>
 
56
    </cmdsynopsis>
 
57
    
 
58
     <cmdsynopsis>
 
59
      <command>&dhpackage;</command>
 
60
      <arg choice="opt">Options</arg>
 
61
      <arg choice="opt"> -i
 
62
        <replaceable>infile.fasta</replaceable>
 
63
      </arg>
 
64
      <arg choice="opt"> -o
 
65
        <replaceable>outfile.fasta</replaceable>
 
66
      </arg>
 
67
    </cmdsynopsis>
 
68
    
 
69
 
 
70
     <cmdsynopsis>
 
71
      <command>&dhpackage;</command>
 
72
      <arg choice="opt">Options</arg>
 
73
      <arg choice="opt"> &lt;
 
74
        <replaceable>infile.fasta</replaceable>
 
75
      </arg>
 
76
      <arg choice="opt"> &gt;
 
77
        <replaceable>outfile.fasta</replaceable>
 
78
      </arg>
 
79
    </cmdsynopsis>
 
80
   
 
81
  </refsynopsisdiv>
 
82
  <refsect1>
 
83
    <title>DESCRIPTION</title>
 
84
 
 
85
    <para><command>Kalign</command> is a command line tool to perform multiple alignment of biological sequences. It employs the Wu-Manber string-matching   algorithm, to improve both the accuracy and speed of the alignment. It uses global, progressive alignment approach, enriched by employing an approximate string-matching algorithm to calculate sequence distances and by incorporating local matches into the otherwise global alignment. In comparisons made by its authors, Kalign was about 10 times faster than ClustalW and, depending on the alignment size, up to 50 times faster than popular iterative methods.</para>
 
86
    
 
87
 
 
88
  </refsect1>
 
89
  <refsect1>
 
90
    <title>OPTIONS</title>
 
91
 
 
92
    <variablelist>
 
93
      <varlistentry>
 
94
        <term><option>-i</option>
 
95
          <option>-input</option>
 
96
        </term>
 
97
        <listitem>
 
98
          <para>Name of the input file in FASTA format.</para>
 
99
        </listitem>
 
100
      </varlistentry>
 
101
      
 
102
      <varlistentry>
 
103
        <term><option>-o</option>
 
104
          <option>-output</option>
 
105
        </term>
 
106
        <listitem>
 
107
          <para>Name of the output file (in FASTA format).</para>
 
108
        </listitem>
 
109
      </varlistentry>
 
110
      
 
111
      <varlistentry>
 
112
        <term>
 
113
          <option>-gpo</option>
 
114
          <option>-gap_open</option>
 
115
          <parameter>x</parameter>
 
116
        </term>
 
117
        <listitem>
 
118
          <para>Gap open penalty (default 6.0).</para>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
      
 
122
      <varlistentry>
 
123
        <term><option>-gpe</option>
 
124
          <option>-gap_ext</option>
 
125
          <parameter>x</parameter>
 
126
        </term>
 
127
        <listitem>
 
128
          <para>Gap extension penalty (default 0.9).</para>
 
129
        </listitem>
 
130
      </varlistentry>
 
131
      
 
132
      <varlistentry>
 
133
        <term><option>-p</option>
 
134
          <option>-points</option>
 
135
        </term>
 
136
        <listitem>
 
137
          <para>Wu-Manber algorithm used in both distance calculation and dynamic programming.</para>
 
138
        </listitem>
 
139
      </varlistentry>
 
140
      
 
141
     <varlistentry>
 
142
        <term><option>-w</option>
 
143
        </term>
 
144
        <listitem>
 
145
          <para>Wu-Manber algorithm will not be used at all.</para>
 
146
        </listitem>
 
147
      </varlistentry>
 
148
 
 
149
      <varlistentry>
 
150
        <term><option>-f</option>
 
151
          <option>-fast</option>
 
152
        </term>
 
153
        <listitem>
 
154
          <para>Fast heuristic alignment ( recommended for &gt;500 sequences)</para>
 
155
        </listitem>
 
156
      </varlistentry>
 
157
      
 
158
      <varlistentry>
 
159
        <term><option>-q</option>
 
160
        </term>
 
161
        <listitem>
 
162
          <para><quote>quiet</quote> - no messages are sent to standard error.</para>
 
163
        </listitem>
 
164
      </varlistentry>
 
165
    </variablelist>
 
166
    
 
167
    <para>  In default mode Kalign will use the Wu-Manber algorithm for distance calculation only. (recommended for &lt; 500 sequences)</para>
 
168
  </refsect1>
 
169
 
 
170
  <refsect1>
 
171
    <title>REFERENCE</title>
 
172
    <para>
 
173
      Please cite Timo Lassmann and Erik L.L. Sonnhammer (2005) Kalign - an accurate and fast multiple sequence alignment algorithm. BMC Bioinformatics 6:298
 
174
    </para>
 
175
  </refsect1>
 
176
    
 
177
  <refsect1>
 
178
    <title>COPYRIGHTS</title>
 
179
 
 
180
    <para>Copyright (C) 2004, 2005, 2006 Timo Lassmann <email>timo.lassmann@cgb.ki.se</email>. Kalign is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation.</para>
 
181
 
 
182
    <para>This manual page was written by &dhusername; &dhemail; for
 
183
      the &debian; system (but may be used by others).  Permission is
 
184
      granted to copy, distribute and/or modify this document under
 
185
      the terms of the &gnu; General Public License, Version 2 any 
 
186
          later version published by the Free Software Foundation.
 
187
    </para>
 
188
    
 
189
        <para>
 
190
          On Debian systems, the complete text of the GNU General Public
 
191
          License can be found in /usr/share/common-licenses/GPL.
 
192
        </para>
 
193
 
 
194
  </refsect1>
 
195
</refentry>
 
196