Imported Upstream version 2.5.0
[debian/amanda] / man / xml-source / amaespipe.8.xml
diff --git a/man/xml-source/amaespipe.8.xml b/man/xml-source/amaespipe.8.xml
new file mode 100755 (executable)
index 0000000..d08370e
--- /dev/null
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+[
+  <!-- entities files to use -->
+  <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+  %global_entities;
+]>
+
+<refentry id='amaespipe.8'>
+<refmeta>
+<refentrytitle>amaespipe</refentrytitle>
+<manvolnum>8</manvolnum>
+</refmeta>
+<refnamediv>
+<refname>amaespipe</refname>
+<refpurpose>wrapper program for aespipe</refpurpose>
+</refnamediv>
+<!-- body begins here -->
+<refsynopsisdiv>
+<cmdsynopsis>
+  <command>amaespipe</command>    
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>DESCRIPTION</title>
+<para>&amaespipe;
+requires <emphasis remap='B'>aespipe</emphasis> and <emphasis remap='B'>gpg</emphasis> to work.
+Aespipe is available from <ulink url="http://loop-aes.sourceforge.net"/></para>
+<para>&amaespipe; will search for the aespipe program in the following directories:
+/usr/bin:/usr/local/bin:/sbin:/usr/sbin. </para>
+&amaespipe; is called by &amcrypt; for &A; data encryption.
+<para>&amaespipe; is based on aespipe's bzaespipe program.
+It calls aespipe to encrypt data using AES256 as the encryption and SHA256 as the
+hash function. GPG key should be stored in $AMANDA_HOME/.gnupg/am_key.gpg.
+&amaespipe; reads passphrase from file descriptor 3.
+During decryption, &amaespipe; autodects encryption type and hash function from
+the encrypted image.</para>
+</refsect1>
+
+
+
+<refsect1><title>SEE ALSO</title>
+<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>gpg</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+</para>
+</refsect1>
+</refentry>
+