1NINJAHELPER(1)                backupninja package               NINJAHELPER(1)
2
3
4

NAME

6       NINJAHELPER  - A menu driven curses-based interface to walk you through
7       backupninja configuration.
8

SYNOPSIS

10       ninjahelper
11

DESCRIPTION

13       Ninjahelper is an helper script to walk you  through  configuration  of
14       the backup tasks for backupninja. It is a curses based "wizard" with an
15       intuitive menu-driven interface.
16

ADDING NEW HELPERS

18       To add an additional 'wizard' to ninjahelper, follow these steps:
19
20       (1)    create a file in the handlers directory (eg. /usr/share/backupn‐
21              inja)  using  the .helper extension. For example, if you wish to
22              create  a  helper  for  the  handler  "blue",  create  the  file
23              /usr/share/backupninja/blue.helper.
24
25       (2)    next,  add your helper to the global HELPERS variable and define
26              the main function for your helper (the function name  is  always
27              <helper>_wizard).   To   use  the  blue.helper  as  an  example:
28              HELPERS="$HELPERS blue:description_of_this_helper"
29                     blue_wizard() {
30                       ... do work here ...
31                     }
32
33       (3)    look at the existing helpers to see how they are written. Try to
34              re-use  functions, such as the dialog functions that are defined
35              in  easydialog.sh,  or  the   vserver   functions   defined   in
36              lib/vserver.
37
38       (4)    test,  re-test, and test again. Try to break the helper by going
39              backwards, try to think like someone who has no idea how to con‐
40              figure your handler would think, try to make your helper as sim‐
41              ple as possible. Walk like a cat, become your shadow, don't  let
42              your senses betray you.
43
44

SEE ALSO

46       backupninja(1), backupninja.conf(5), backup.d(5),
47

AUTHOR

49       BACKUPNINJA was written by the riseup.net collective.
50
51
52
53riseup                         january 19, 2006                 NINJAHELPER(1)