File: libmstoolkit.sgml

package info (click to toggle)
libmstoolkit 82-7
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 772 kB
  • sloc: cpp: 10,999; ansic: 109; makefile: 86; sh: 20
file content (181 lines) | stat: -rw-r--r-- 5,194 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@


	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!ENTITY dhfirstname "<firstname>Filippo</firstname>">
  <!ENTITY dhsurname   "<surname>Rusconi</surname>">
  <!ENTITY dhdate      "<date>October 2nd, 2014</date>">
  <!ENTITY dhsection   "<manvolnum>3</manvolnum>">
  <!ENTITY dhemail     "<email>lopippo@debian.org</email>">
  <!ENTITY dhusername  "Filippo Rusconi">
  <!ENTITY dhucpackage "<refentrytitle>LIBMSTOOLKIT</refentrytitle>">
  <!ENTITY dhpackage   "libmstoolkit">

  <!ENTITY softname   "libMSToolKit">
  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  <!ENTITY LIBVERSION "82">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2014</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname> <refpurpose> The &dhpackage package
      ships light-weight C++ libraries for reading, writing, and
      manipulating mass spectrometry data. The &softname libraries are
      easily linked to virtually any C++ algorithm for simple, fast
      file reading and analysis.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <application>&dhpackage;</application> source package.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

    <para>

      The <application>&dhpackage;</application> source package is used to create the following packages:

      <itemizedlist>
        <listitem>
         <para><application>&dhpackage;&LIBVERSION;</application> runtime binary package;</para>
        </listitem>
        <listitem>
         <para><application>&dhpackage;&LIBVERSION;-dbg;</application> runtime binary package (debugging symbols);</para>
        </listitem>
        <listitem>
         <para><application>&dhpackage;-dev</application> development binary package.</para>
        </listitem>
        <listitem>
         <para><application>&dhpackage;-tools</application> tools binary package.</para>
        </listitem>
  </itemizedlist>

    </para>

    <para>

      The <application>&dhpackage;&LIBVERSION;</application> runtime
      binary package ships the following libraries
      
      <itemizedlist>

        <listitem>
         <para> libmstoolkit.so </para>
        </listitem>

        <listitem>
          <para> libmstoolkitlite.so </para>
        </listitem>

      </itemizedlist>

    </para>

    <para>
      
      The <application>&dhpackage;-dev</application> development
      binary package ships the following files:
      
      <itemizedlist>
        <listitem>
          <para> Include files, shipped in /usr/include/&dhpackage; </para>
        </listitem>
        </itemizedlist>

    </para>

    <para>
      
      The <application>&dhpackage;-tools</application> 
      binary package ships the following file:
      
      <itemizedlist>
        <listitem>
          <para> msSingleScan shipped in /usr/bin; </para>
        </listitem>
        </itemizedlist>

				DESCRIPTION: Reads an MS/MS spectrum from any MSToolkit supported file type and outputs to screen in MS2 format.
				USAGE: MSSingleScan [scan number] [file]

    </para>


  </refsect1>
  
  <refsect1>
    <title>AUTHOR</title>

    <para>
      This manual page was written by &dhusername; <&dhemail;> for
      the &debian; system (and may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 3 or any
      later version published by the Free Software Foundation.
    </para>
    <para>
      On Debian systems, the complete text of the GNU General Public
      License can be found in /usr/share/common-licenses/GPL-3.
    </para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->