pwizlite(3)

πŸ“¦
version 3.0.14 Β· 4 versions
, in ubuntu resolute, ubuntu stonking

πŸ’– pwizlite (section 3) πŸ’–

okay bestie, welcome to the manual page for pwizlite, sitting pretty in section 3 of the manual. she's a library. she's little. she's got main character energy. let's go 🫢


✨ Name ✨

pwizlite β€” a Custom reduced Proteowizard library πŸ‘‘


🌸 SYNOPSIS 🌸

Here's the whole vibe check, fr fr:

pwizlite is a shared object library (*.so file)

that's it. that's the synopsis. a *.so file and a dream πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so like, the pwizlite shared object library is a reduced copy of the Proteowizard libpwiz library. no cap. she only contains the code that lets you load XML-based standard mass spectrometry formats, and those are: mzXML, mzML and MGF files. that's her whole thing. that's her lane. she stays in it ✨

the rationale, aka why she even exists 😭

The Proteowizard project uses the Boost BJam build system to build their library and binary images. and the source tree? it contains all the libraries that libpwiz depends upon. the configuration of BJam is, and I cannot stress this enough, so complicated that making the build system use the system-based libraries is terribly difficult. it's giving nightmare fuel honestly πŸ’€

and listen β€” the Proteowizard project used to maintain an autotools build system port for GNU/Linux users. but that has been discontinued. rip to that era πŸ•―οΈ

Many projects (and mine also) have resorted to using a reduced set of libpwiz source files, only directed at building the XML-based and MGF format file-loading capabilities. in my packaging experience, at least one package makes use of such a subset copy of libpwiz. and having a package like pwizlite in Debian will ease packaging of all the other packages. iconic behavior, honestly. she's here to help the whole group chat 🫢


πŸŽ€ EXAMPLES πŸŽ€

bestie, here's how you actually use her:

  • To include files from the pwizlite library, write an inclusion statement of this sort:
#include <pwizlite/pwiz/<path>/<to>/<file.h>
  • To link to the pwizlite library add a linker flag: -lpwizlite.
  • To CMake-find the package: find_package(PwizLite)
  • To CMake-configure the package: find_package(PwizLiteConfig.cmake)
  • To use the pkgconfig system: pkg-config --help pkg-config --libs pwizlite

πŸ’œ MAN PAGE PRODUCTION πŸ’œ

This man page was written by Filippo Rusconi <<lopippo@debian.org>>. a real one. periodt ✍️


🌈 Author 🌈

Filippo Rusconi <<lopippo@debian.org>>


Filippo Rusconi


okay that's the whole page bestie, go forth and -lpwizlite responsibly πŸ’–

this lil cutie is page 1 of pwizlite(3), dated 20200601, from the pwizlite source. mwah πŸ’‹

πŸ“¦ where this page comes from