LIBMSTOOLKIT(3)

💖 libmstoolkit — the group chat version 💖

okay bestie, listen. this is LIBMSTOOLKIT(3), a Library Functions Manual page, and we're gonna get through it together because honestly? it's giving ✨scientific software✨ and it's not even that deep.


🌸 NAME 🌸

libmstoolkit — the libmstoolkit package ships light-weight C++ libraries for reading, writing, and manipulating mass spectrometry data. and the way that the libMSToolKit libraries are easily linked to virtually any C++ algorithm for simple, fast file reading and analysis?? iconic. no cap. 💅


🦋 SYNOPSIS 🦋

libmstoolkit

that's it. that's the whole synopsis. she's lowkey mysterious like that. 🎀


✨ DESCRIPTION ✨

so this manual page documents briefly the libmstoolkit source package. fr fr, briefly — we're not doing a whole dissertation here.

okay so tea: this manual page was written for the Debian distribution because the original program does not have a manual page. so we made one. you're welcome. 🫶

the libmstoolkit source package is used to create the following packages:

  • libmstoolkit82 runtime binary package;
  • libmstoolkit82-dbg; runtime binary package (debugging symbols);
  • libmstoolkit-dev development binary package.
  • libmstoolkit-tools tools binary package.

look at her, building a whole little family of packages. main character energy honestly. 👑

the libmstoolkit82 runtime binary package ships the following libraries:

  • libmstoolkit.so
  • libmstoolkitlite.so

two icons. libmstoolkitlite.so is literally the lite version, she said "I'm the same but lighter" and we respect it. 💖

the libmstoolkit-dev development binary package ships the following files:

  • Include files, shipped in /usr/include/libmstoolkit

if you're compiling against this, that's where your headers are living. go say hi. 🏠

the libmstoolkit-tools binary package ships the following file:

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

so msSingleScan reads an MS/MS spectrum from any MSToolkit supported file type and outputs to screen in MS2 format. any supported type. she's versatile. and the usage is:

MSSingleScan [scan number] [file]

scan number first, then the file. in that order. don't flip it, bestie, I'm begging. 😭


💜 AUTHOR 💜

this manual page was written by Filippo Rusconi <lopippo@debian.org> for the Debian system (and may be used by others). shoutout Filippo, absolute legend for writing this so the rest of us aren't just out here guessing. 🌈

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. slay, legally. ⭐

on Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-3.

ngl if you actually need to read the full license text, it's right there in that path. go read it. it's giving required reading. 📚

🎀 SEE ALSO 🎀

ok bestie real talk — the original page doesn't have a SEE ALSO section, so there's nothing to point you at. not me adding a section just to tell you there's no section 😭. anyway.

and that's the whole page!! we did it 🫶 this was LIBMSTOOLKIT(3), from the Library Functions Manual, and that footer with LIBMSTOOLKIT(3) on it? that's just her name signing off at the bottom, section 3 and all. periodt. 💅✨🌸