bpluginfo(8)

📦 version 25.0.3, in alpine 3.24

💖 NAME 💖

okay so bestie, welcome to bpluginfo — the Bareos Plugin information utility. that's the whole vibe: it tells you stuff about a Bareos plugin. slay.

✨ SYNOPSIS ✨

bplufinfo [options] plugin_filename.so

(yes it says bplufinfo up there, not bpluginfo — that's literally what the page says, so i'm keeping it fr fr, don't come for me 🙈)

🦋 DESCRIPTION 🦋

the main character purpose of bpluginfo is to display different information about a Bareos plugin. like, that's its whole job and it ate. you can use it to check a plugin's name, author, license and a short description — the little plugin ID card if you will 💅

you can use the -f option to display the API implemented by the plugin. some plugins may highkey require an additional -a option for validating a Bareos Daemons API. in most cases it is not required — so don't stress, bestie 🫶

🎀 OPTIONS 🎀

a summary of options is included below. let's get into it 👑

  • -h — show usage of the program. the little "help me help you" button.
  • -v — verbose information, printing all available data from the plugin, including plugin header AND implemented API. the full lore drop, no cap.
  • -i — display short information from plugin header only. this one is the default option. ⚠️ it's incompatible with the -f option, so pick a lane bestie.
  • -f — display information about implemented API functions. the receipts of what this plugin can actually do.
  • -a <api> — you can supply the plugin initialization function with a particular Bareos API number. without this option, a default API number of '1' is used. this option requires a numeric argument — numbers only, periodt 🔢

🔥 RETURN CODE 🔥

bpluginfo returns 0 on success, and non-zero on error. ✅

you can check the return code to find what was the cause of the error. it's giving diagnostic queen 👑:

  • 0 — success
  • 1 — cannot load a plugin
  • 2 — cannot find a loadPlugin function
  • 3 — cannot find an unloadPlugin function
  • 10 — not enough memory

🌈 EXAMPLE USAGE 🌈

this is an example of bplufinfo usage with the verbose option (-v) and the default plugin. look at her go 😭💖

$ bpluginfo -v /usr/lib/bareos/plugins/python-fd.so

Plugin type:            Bareos File Daemon plugin
Plugin magic:           *FDPluginData*
Plugin version:         2
Plugin release date:    October 2013
Plugin author:          Marco van Wieringen
Plugin licence:         Bareos AGPLv3
Plugin description:     Python File Daemon Plugin
Plugin API version:     8
Plugin usage:
python:module_path=<path-to-python-modules>:module_name=<python-module-to-load>:...

Plugin functions:
 newPlugin()
 freePlugin()
 getPluginValue()
 setPluginValue()
 handlePluginEvent()
 startBackupFile()
 endBackupFile()
 startRestoreFile()
 endRestoreFile()
 pluginIO()
 createFile()
 setFileAttributes()
 checkFile()

like, the whole plugin's resume just printed itself. iconic.

⭐ AUTHOR ⭐

written by Radoslaw Korzeniewski (c) Inteos Sp. z o.o. — shoutout to the dev, we stan 🫶

💀 BUGS 💀

does not handle all required Bareos functions callbacks, which can lead to utility crash. yeah. that's the whole warning. it might just crash on you 😭 so like, know that going in.

🙈 REPORTING BUGS 🙈

report bugs to <support@inteos.pl>. they're literally waiting for your email bestie, don't be shy 📧

copyright © 2012 Free Software Foundation Europe e.V.

this is free software; see the source for copying conditions. there is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. so fr fr, if it breaks, that's on you 💅

🧚 SEE ALSO 🧚

bareos-dir, bareos-sd, bareos-fd, Bareos Plugins API

go read those too, iykyk 📚✨

and that's the whole page bestie — brought to you by bpluginfo, from July 2012, filed under bpluginfo(8) in the manual. mwah, go check your plugins 💜

📦 where this page comes from