86
<title>Which Linux Distribution?</title>
86
<title>Which Platform?</title>
89
Cedar Backup has been designed for use on all Linux systems.
90
However, since it was developed on a Debian system, and because I
91
am a Debian developer, the packaging is prettier and the setup is
92
somewhat simpler on a Debian system than on a system where you
89
Cedar Backup has been designed for use on all UNIX-like systems.
90
However, since it was developed on a Debian GNU/Linux system, and
91
because I am a Debian developer, the packaging is prettier and the
92
setup is somewhat simpler on a Debian system than on a system where
93
you install from source.
97
97
The configuration instructions below have been generalized so they
98
should work well regardless of what distribution you are running
99
(i.e. RedHat, Gentoo, etc.). If instructions vary for a particular
100
distribution, you will find a note related to that distribution.
98
should work well regardless of what platfomr you are running (i.e.
99
RedHat, Gentoo, FreeBSD, etc.). If instructions vary for a
100
particular platform, you will find a note related to that
104
I am always open to adding more distribution-specific hints and
105
notes, so write me if you find problems with these instructions.
105
I am always open to adding more platform-specific hints and notes,
106
so write me if you find problems with these instructions.
760
<term><literal>pre_action_hook</literal></term>
762
<para>Hook configuring a command to be executed before an action.</para>
764
This is a subsection which configures a command to be
765
executed immediately before a named action. It provides a
766
way for administrators to associate their own custom
767
functionality with standard Cedar Backup actions or with
768
arbitrary extensions.
771
This section is optional, and can be repeated as many times
775
This subsection must contain the following two fields:
781
<term><literal>action</literal></term>
784
Name of the Cedar Backup action that the hook is
785
associated with. The action can be a standard
786
backup action (collect, stage, etc.) or can be an
787
extension action. No validation is done to
788
ensure that the configured action actually
792
<emphasis>Restrictions:</emphasis> Must be a
799
<term><literal>command</literal></term>
802
Name of the command to be executed. This item
803
can either specify the path to a shell script of
804
some sort (the recommended approach) or can include
805
a complete shell command.
808
Note: if you choose to provide a complete shell
809
command rather than the path to a script, you
810
need to be aware of some limitations of Cedar
811
Backup's command-line parser. You cannot use a
812
subshell (via the <literal>`command`</literal> or
813
<literal>$(command)</literal> syntaxes) or any
814
shell variable in your command line.
815
Additionally, the command-line parser only
816
recognizes the double-quote character
817
(<literal>"</literal>) to delimit groupings or
818
strings on the command-line. The bottom line is,
819
you are probably best off writing a shell script
820
of some sort for anything more sophisticated than
821
very simple shell commands.
824
<emphasis>Restrictions:</emphasis> Must be a
836
<term><literal>post_action_hook</literal></term>
838
<para>Hook configuring a command to be executed after an action.</para>
840
This is a subsection which configures a command to be
841
executed immediately after a named action. It provides a
842
way for administrators to associate their own custom
843
functionality with standard Cedar Backup actions or with
844
arbitrary extensions.
847
This section is optional, and can be repeatd as many times
851
This subsection must contain the following two fields:
857
<term><literal>action</literal></term>
860
Name of the Cedar Backup action that the hook is
861
associated with. The action can be a standard
862
backup action (collect, stage, etc.) or can be an
863
extension action. No validation is done to
864
ensure that the configured action actually
868
<emphasis>Restrictions:</emphasis> Must be a
875
<term><literal>command</literal></term>
878
Name of the command to be executed. This item
879
can either specify the path to a shell script of
880
some sort (the recommended approach) or can include
881
a complete shell command.
884
Note: if you choose to provide a complete shell
885
command rather than the path to a script, you
886
need to be aware of some limitations of Cedar
887
Backup's command-line parser. You cannot use a
888
subshell (via the <literal>`command`</literal> or
889
<literal>$(command)</literal> syntaxes) or any
890
shell variable in your command line.
891
Additionally, the command-line parser only
892
recognizes the double-quote character
893
(<literal>"</literal>) to delimit groupings or
894
strings on the command-line. The bottom line is,
895
you are probably best off writing a shell script
896
of some sort for anything more sophisticated than
897
very simple shell commands.
900
<emphasis>Restrictions:</emphasis> Must be a