git.gag.com Git - debian/amanda/blob - man/amanda-scripts.7

   1 '\" t
   2 .\"     Title: amanda-scripts
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/21/2012
   6 .\"    Manual: Miscellanea
   7 .\"    Source: Amanda 3.3.1
   8 .\"  Language: English
   9 .\"
  10 .TH "AMANDA\-SCRIPTS" "7" "02/21/2012" "Amanda 3\&.3\&.1" "Miscellanea"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 amanda-scripts \- Configuring and using the Script API
  32 .SH "DESCRIPTION"
  33 .PP
  34 The Script API is a flexible system for invoking user\-supplied scripts at various points in the execution of Amanda\&. This manual page describes the operation and configuration of the API\&. For help writing Script API scripts, see http://wiki\&.zmanda\&.com/index\&.php/Script_API\&.
  35 .SH "SCRIPTS"
  36 .PP
  37 This section lists the scripts included with Amanda, see the individual man page for instructions on using them\&. For complete How\-To information, consult the Amanda wiki at http://wiki\&.zmanda\&.com\&.
  38 .sp
  39 .RS 4
  40 .ie n \{\
  41 \h'-04'\(bu\h'+03'\c
  42 .\}
  43 .el \{\
  44 .sp -1
  45 .IP \(bu 2.3
  46 .\}
  47 \fBamzfs-snapshot\fR(8),
  48 \- create/destroy zfs snapshot\&.
  49 .RE
  50 .sp
  51 .RS 4
  52 .ie n \{\
  53 \h'-04'\(bu\h'+03'\c
  54 .\}
  55 .el \{\
  56 .sp -1
  57 .IP \(bu 2.3
  58 .\}
  59 \fBscript-email\fR(8),
  60 \- send email\&.
  61 .RE
  62 .PP
  63 Script properties work just like application properties: they are insensitive to case, and
  64 \-
  65 (dash) and
  66 _
  67 (underscore) may be used interchangeably\&.
  68 .SH "SCRIPTS OUTPUT PROPERTY"
  69 .PP
  70 A pre\-dle\-amcheck, pre\-dle\-estimate or pre\-dle\-backup executed on the client can output property on stdout that are sent to the application\&. If the output line matches "PROPERTY str1 str2", Amanda sets a property called "str1" by the value of "str2", that property is sent to the application\&.
  71 .SH "SEE ALSO"
  72 .PP
  73 \fBamanda\fR(8),
  74 \fBamanda.conf\fR(5)
  75 .PP
  76 The Amanda Wiki:
  77 : http://wiki.zmanda.com/
  78 .SH "AUTHORS"
  79 .PP
  80 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
  81 .RS 4
  82 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  83 .RE
  84 .PP
  85 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
  86 .RS 4
  87 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  88 .RE