man/ninjahelper.1

   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 NINJAHELPER 1 "December 24, 2005" "riseup" "backupninja package"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 NINJAHELPER \- A menu driven curses-based interface to walk you through
  20 backupninja configuration.
  21 .br
  22 .SH SYNOPSIS
  23 .B "ninjahelper"
  24 .br
  25 .SH DESCRIPTION
  26 .B Ninjahelper
  27 is an helper script to walk you through configuration of the backup
  28 tasks for backupninja. It is a curses based "wizard" with an intuitive
  29 menu-driven interface.
  30 .PP
  31 .SH ADDING NEW HELPERS
  32 .br
  33 To add an additional 'wizard' to ninjahelper, follow these steps:
  34 .IP (1)
  35 create a file in the handlers directory (eg. /usr/share/backupninja) using
  36 the .helper extention. For example, if you wish to create a helper for the
  37 handler "blue", create the file /usr/share/backupninja/blue.helper.
  38 .IP (2)
  39 next, add your helper to the global HELPERS variable and define the main
  40 function for your helper (the function name is always <helper>_wizard). To
  41 use the blue.helper as an example:
  42 HELPERS="$HELPERS blue:description_of_this_helper"
  43        blue_wizard() {
  44          ... do work here ...
  45        }
  46 .IP (3)
  47 look at the existing helpers to see how they are written. Try to re-use
  48 functions, such as the dialog functions that are defined in easydialog.sh,
  49 or the vserver functions defined in lib/vserver
  50 .IP (4)
  51 test, re-test, and test again. Try to break the helper by going backwards,
  52 try to think like someone who has no idea how to configure your handler
  53 would think, try to make your helper as simple as possible. Walk like a cat,
  54 become your shadow, don't let your senses betray you.
  55
  56 .SH SEE ALSO
  57 .BR backupninja (1),
  58 .BR backupninja.conf (5),
  59 .BR backup.d (5),
  60 .br
  61 .SH AUTHOR
  62 BACKUPNINJA was written by the riseup.net collective.