git.sur5r.net Git - bacula/bacula/blob - bacula/manpages/bpluginfo.8

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH bpluginfo "8" "July 2012" "bpluginfo" "Network backup, recovery and verification"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .SH NAME
   9 bpluginfo \- Bacula Plugin information utility
  10 .SH SYNOPSIS
  11 .B bplufinfo
  12 .RI [ options ]
  13 .I plugin_filename.so
  14 .br
  15 .SH DESCRIPTION
  16 .LP
  17 The main purpose of
  18 .B bpluginfo
  19 is to display different information about Bacula plugin. You can use it to
  20 check a plugin name, author, license and short description. You can use
  21 '-f' option to display API implemented by the plugin. Some plugins may require
  22 additional '-a' option for validating a Bacula Daemons API. In most cases it
  23 is not required.
  24 .PP
  25 ./ Bacula is a set of programs for performing a
  26 ./ .PP
  27 ./ -
  28 ./ .BR bpluginfo
  29
  30 .PP
  31 .SH OPTIONS
  32 A summary of options is included below.
  33 .TP
  34 .B \-h
  35 Show usage of the program.
  36 .TP
  37 .BI \-v
  38 Verbose information printing all available data from the plugin, including
  39 plugin header and implemented API.
  40 .TP
  41 .BI \-i
  42 Display short information from plugin header only. This is a default option.
  43 Option incompatible with
  44 .B -f
  45 option.
  46 .TP
  47 .BI \-f
  48 Display information about implemented API functions.
  49 .TP
  50 .BI \-a\ <api>
  51 You can supply the plugin initialization function with a particular Bacula
  52 API number. Without this option a default API number is '1'. Option require
  53 a numeric argument.
  54 .SH RETURN CODE
  55 .BR bpluginfo
  56 returns 0 on success, and non-zero on error.
  57 .TP
  58 You can check return code to find what was a cause of the error.
  59  * 0 - success
  60  * 1 - cannot load a plugin
  61  * 2 - cannot find a loadPlugin function
  62  * 3 - cannot find an unloadPlugin function
  63  * 10 - not enough memory
  64 .SH EXAMPLE USAGE
  65 This is an example of bplufinfo usage with verbose option (-v) and default plugin.
  66 .LP
  67 .sp
  68 .RS
  69 .nf
  70
  71 \fB$ bpluginfo -v bpipe-fd.so
  72
  73 Plugin type:            File Daemon plugin
  74 Plugin magic:           *FDPluginData*
  75 Plugin version:         1
  76 Plugin release date:    January 2008
  77 Plugin author:          Kern Sibbald
  78 Plugin license:         Bacula or Bacula Enterprise
  79 Plugin description:     Bacula Pipe File Daemon Plugin
  80 Plugin API version:     6
  81
  82 Plugin functions:
  83  newPlugin()
  84  freePlugin()
  85  getPluginValue()
  86  setPluginValue()
  87  handlePluginEvent()
  88  startBackupFile()
  89  endBackupFile()
  90  startRestoreFile()
  91  endRestoreFile()
  92  pluginIO()
  93  createFile()
  94  setFileAttributes()
  95 .fi
  96 .RE
  97
  98 .SH AUTHOR
  99 Written by Radoslaw Korzeniewski (c) Inteos Sp. z o.o.
 100 .SH BUGS
 101 Does not handle all required bacula functions callbacks which can lead to
 102 utility crash.
 103 .\".SH TODO"
 104
 105 .PP
 106
 107 .PP
 108
 109 .SH "REPORTING BUGS"
 110 Report bugs to <support@inteos.pl>.
 111 .SH COPYRIGHT
 112 Copyright \(co 2012 Free Software Foundation Europe e.V.
 113 .br
 114 This is free software; see the source for copying conditions.  There is NO
 115 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 116 .SH "SEE ALSO"
 117 .BR bacula-dir,
 118 .BR bacula-sd,
 119 .BR bacula-fd,
 120 .BR "Bacula Plugins API"
 121 This man page document is released under the BSD 2-Clause license.