[med-svn] r5872 - trunk/packages/tm-align/trunk/debian

Timothy Booth tbooth-guest at alioth.debian.org
Thu Feb 3 14:53:34 UTC 2011


Author: tbooth-guest
Date: 2011-02-03 14:53:30 +0000 (Thu, 03 Feb 2011)
New Revision: 5872

Added:
   trunk/packages/tm-align/trunk/debian/TMscore.1
   trunk/packages/tm-align/trunk/debian/TMscore.pod
Log:
Quick and basic manpage for TMscore



Added: trunk/packages/tm-align/trunk/debian/TMscore.1
===================================================================
--- trunk/packages/tm-align/trunk/debian/TMscore.1	                        (rev 0)
+++ trunk/packages/tm-align/trunk/debian/TMscore.1	2011-02-03 14:53:30 UTC (rev 5872)
@@ -0,0 +1,182 @@
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "TMSCORE 1"
+.TH TMSCORE 1 "2011-02-03" .\" "perl v5.10.1" "User Contributed Perl Documentation"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+TM\-score \- an algorithm to calculate the similarity of topologies of two protein structures
+.SH "VERSION"
+.IX Header "VERSION"
+This documentation refers to TM-score version released on 2011/01/30
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+1. Run TM-score to compare 'model' and 'native':
+.PP
+.Vb 1
+\&    TMscore model native
+.Ve
+.PP
+2. Run TM-score with an assigned d0, e.g. 5 Angstroms:
+.PP
+.Vb 1
+\&    TMscore model native \-d 5
+.Ve
+.PP
+3. Run TM-score with superposition output, e.g. '\s-1TM\s0.sup', and view in Rasmol:
+.PP
+.Vb 2
+\&    TMscore model native \-o TM.sup
+\&    rasmol \-script TM.sup
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This program is to compare two protein structures and identify the 
+best superposition that has the highest TM-score. Input structures 
+must be in the \s-1PDB\s0 format. By default, TM-score is normalized by 
+the second protein. Users can obtain a brief instruction by simply
+running the program without arguments.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.RS 4
+\&\fB\-o\fR filename.sup Outputs the superposition to the specified file, 
+   suitable for use in rasmol.
+.Sp
+\&\fB\-d\fR value Sets d0 to the specified number of angstroms.
+.RE
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+TMalign, rasmol
+.PP
+When  using  this proram and for more detailed information, please refer to the publication in NucleicAcidsRes.  
+(2005) Volume 33 page 2303ff. by Zhang and Skolnick.
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+For comments/suggestions,please contact email: zhng at umich.edu.
+.PP
+This manpage was compiled by Tim Booth (tbooth at ceh.ac.uk)

Added: trunk/packages/tm-align/trunk/debian/TMscore.pod
===================================================================
--- trunk/packages/tm-align/trunk/debian/TMscore.pod	                        (rev 0)
+++ trunk/packages/tm-align/trunk/debian/TMscore.pod	2011-02-03 14:53:30 UTC (rev 5872)
@@ -0,0 +1,74 @@
+#
+#===============================================================================
+#
+#         FILE:  TMscore.pod
+#
+#  DESCRIPTION:  A POD-manpage for TMscore
+#
+#       AUTHOR:  Y. Zhang and J. Skolnick
+#      COMPANY:  Zhang Lab University of Michigan
+#      CREATED:  03/02/11 14:18:17 GMT
+#     REVISION:  ---
+#===============================================================================
+
+
+=head1 NAME
+
+TM-score - an algorithm to calculate the similarity of topologies of two protein structures
+
+=head1 VERSION
+
+This documentation refers to TM-score version released on 2011/01/30
+
+
+=head1 SYNOPSIS
+
+1. Run TM-score to compare 'model' and 'native':
+
+    TMscore model native
+
+2. Run TM-score with an assigned d0, e.g. 5 Angstroms:
+
+    TMscore model native -d 5
+
+3. Run TM-score with superposition output, e.g. 'TM.sup', and view in Rasmol:
+
+    TMscore model native -o TM.sup
+    rasmol -script TM.sup
+
+=head1 DESCRIPTION
+
+This program is to compare two protein structures and identify the 
+best superposition that has the highest TM-score. Input structures 
+must be in the PDB format. By default, TM-score is normalized by 
+the second protein. Users can obtain a brief instruction by simply
+running the program without arguments. 
+
+=head1 OPTIONS
+
+=over 4
+
+B<-o> L<filename.sup> Outputs the superposition to the specified file, 
+   suitable for use in rasmol.
+
+B<-d> L<value> Sets d0 to the specified number of angstroms.
+
+=back
+
+=head1 SEE ALSO
+
+L<TMalign>, L<rasmol>
+
+When  using  this proram and for more detailed information, please refer to the publication in NucleicAcidsRes.  
+(2005) Volume 33 page 2303ff. by Zhang and Skolnick.
+
+=head1 AUTHOR
+
+For comments/suggestions,please contact email: zhng at umich.edu.
+
+This manpage was compiled by Tim Booth (tbooth at ceh.ac.uk)
+
+=cut
+
+
+




More information about the debian-med-commit mailing list