bpluginfo(8)

1bpluginfo(8)       Network backup, recovery and verification      bpluginfo(8)
2
3
4

NAME

6       bpluginfo - Bacula Plugin information utility
7

SYNOPSIS

9       bplufinfo [options] plugin_filename.so
10

DESCRIPTION

12       The main purpose of bpluginfo is to display different information about
13       Bacula plugin. You can use it to check a plugin name,  author,  license
14       and  short description. You can use additional '-a' option for validat‐
15       ing a Bacula Daemons API. In most cases it is not required.
16

OPTIONS

18       A summary of options is included below.
19
20       -h     Show usage of the program.
21
22       -v     Verbose information printing all available data from the plugin,
23              including plugin header and implemented API.
24
25       -i     Display  short  information  from  plugin header only. This is a
26              default option.  Option incompatible with -f option.
27
28       -f     Display information about implemented API functions.
29
30       -a <api>
31              You can supply the plugin initialization function with a partic‐
32              ular Bacula API number. Without this option a default API number
33              is '1'. Option require a numeric argument.
34

RETURN CODE

36       bpluginfo returns 0 on success, and non-zero on error.
37
38       You can check return code to find what was a cause of the error.
39               * 0 - success
40               * 1 - cannot load a plugin
41               * 2 - cannot find a loadPlugin function
42               * 3 - cannot find an unloadPlugin function
43               * 10 - not enough memory
44

EXAMPLE USAGE

46       This is an example of bplufinfo usage  with  verbose  option  (-v)  and
47       default plugin.
48
49              $ bpluginfo -v bpipe-fd.so
50
51              Plugin type:            File Daemon plugin
52              Plugin magic:           *FDPluginData*
53              Plugin version:         1
54              Plugin release date:    January 2008
55              Plugin author:          Kern Sibbald
56              Plugin license:         Bacula AGPLv3
57              Plugin description:     Bacula Pipe File Daemon Plugin
58              Plugin API version:     6
59
60              Plugin functions:
61               newPlugin()
62               freePlugin()
63               getPluginValue()
64               setPluginValue()
65               handlePluginEvent()
66               startBackupFile()
67               endBackupFile()
68               startRestoreFile()
69               endRestoreFile()
70               pluginIO()
71               createFile()
72               setFileAttributes()
73
74

AUTHOR

76       Written by Radoslaw Korzeniewski (c) Inteos Sp. z o.o.
77

BUGS

79       Does  not handle all required bacula functions callbacks which can lead
80       to utility crash.
81
82

REPORTING BUGS

84       Report bugs to <support@inteos.pl>.
85

COPYRIGHT

87       Copyright © 2012 Free Software Foundation Europe e.V.
88       This is free software; see the source for copying conditions.  There is
89       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
90       PURPOSE.
91