~ubuntu-branches/ubuntu/karmic/cedar-backup2/karmic

« back to all changes in this revision

Viewing changes to manual/src/config.xml

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2005-12-13 16:13:31 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051213161331-dw0cj6f534u8oxgf
Tags: 2.7.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
26
26
# Author   : Kenneth J. Pronovici <pronovic@ieee.org>
27
27
# Language : O'Reilly DocBook Lite XML DTD
28
28
# Project  : Cedar Backup, release 2
29
 
# Revision : $Id: config.xml 809 2005-09-12 19:10:59Z pronovic $
 
29
# Revision : $Id: config.xml 917 2005-11-23 20:37:27Z pronovic $
30
30
# Purpose  : Cedar Backup software manual, Configuration chapter.
31
31
#
32
32
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
83
83
 
84
84
      <sidebar>
85
85
 
86
 
         <title>Which Linux Distribution?</title>
 
86
         <title>Which Platform?</title>
87
87
 
88
88
         <para>
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
93
 
            install from source.  
 
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.  
94
94
         </para>
95
95
 
96
96
         <para>
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
 
101
            distribution.
101
102
         </para>
102
103
 
103
104
         <para>
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.
106
107
         </para>
107
108
 
108
109
      </sidebar>
559
560
 
560
561
         <para>
561
562
            The options configuration section contains configuration options
562
 
            that are not specific to any one action.  All of the fields (other
563
 
            than the overrides section) are required and must not be empty.
 
563
            that are not specific to any one action.  
564
564
         </para>
565
565
 
566
566
         <para>
582
582
      &lt;command&gt;mkisofs&lt;/command&gt;
583
583
      &lt;abs_path&gt;/opt/local/bin/mkisofs&lt;/abs_path&gt;
584
584
   &lt;/override&gt;
 
585
   &lt;pre_action_hook&gt;
 
586
      &lt;action&gt;collect&lt;/action&gt;
 
587
      &lt;command&gt;echo "I AM A PRE-ACTION HOOK RELATED TO COLLECT"&lt;/command&gt;
 
588
   &lt;/pre_action_hook&gt;
 
589
   &lt;post_action_hook&gt;
 
590
      &lt;action&gt;collect&lt;/action&gt;
 
591
      &lt;command&gt;echo "I AM A POST-ACTION HOOK RELATED TO COLLECT"&lt;/command&gt;
 
592
   &lt;/post_action_hook&gt;
585
593
&lt;/options&gt;
586
594
         </programlisting>
587
595
 
706
714
                     problem.
707
715
                  </para>
708
716
                  <para>
709
 
                     This section is optional, and can be repeatd as many times
 
717
                     This section is optional, and can be repeated as many times
710
718
                     as necessary.
711
719
                  </para>
712
720
                  <para>
713
 
                     The override subsection must contain the following two
714
 
                     fields:
 
721
                     This subsection must contain the following two fields:
715
722
                  </para>
716
723
 
717
724
                  <variablelist>
749
756
               </listitem>
750
757
            </varlistentry>
751
758
 
 
759
            <varlistentry>
 
760
               <term><literal>pre_action_hook</literal></term>
 
761
               <listitem>
 
762
                  <para>Hook configuring a command to be executed before an action.</para>
 
763
                  <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.
 
769
                  </para>
 
770
                  <para>
 
771
                     This section is optional, and can be repeated as many times
 
772
                     as necessary.
 
773
                  </para>
 
774
                  <para>
 
775
                     This subsection must contain the following two fields:
 
776
                  </para>
 
777
 
 
778
                  <variablelist>
 
779
 
 
780
                     <varlistentry>
 
781
                        <term><literal>action</literal></term>
 
782
                        <listitem>
 
783
                           <para>
 
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
 
789
                              exists.
 
790
                           </para>
 
791
                           <para>
 
792
                              <emphasis>Restrictions:</emphasis> Must be a
 
793
                              non-empty string.
 
794
                           </para>
 
795
                        </listitem>
 
796
                     </varlistentry>
 
797
 
 
798
                     <varlistentry>
 
799
                        <term><literal>command</literal></term>
 
800
                        <listitem>
 
801
                           <para>
 
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.  
 
806
                           </para>
 
807
                           <para>
 
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.
 
822
                           </para>
 
823
                           <para>
 
824
                              <emphasis>Restrictions:</emphasis> Must be a
 
825
                              non-empty string.
 
826
                           </para>
 
827
                        </listitem>
 
828
                     </varlistentry>
 
829
 
 
830
                  </variablelist>
 
831
 
 
832
               </listitem>
 
833
            </varlistentry>
 
834
 
 
835
            <varlistentry>
 
836
               <term><literal>post_action_hook</literal></term>
 
837
               <listitem>
 
838
                  <para>Hook configuring a command to be executed after an action.</para>
 
839
                  <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.
 
845
                  </para>
 
846
                  <para>
 
847
                     This section is optional, and can be repeatd as many times
 
848
                     as necessary.
 
849
                  </para>
 
850
                  <para>
 
851
                     This subsection must contain the following two fields:
 
852
                  </para>
 
853
 
 
854
                  <variablelist>
 
855
 
 
856
                     <varlistentry>
 
857
                        <term><literal>action</literal></term>
 
858
                        <listitem>
 
859
                           <para>
 
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
 
865
                              exists.
 
866
                           </para>
 
867
                           <para>
 
868
                              <emphasis>Restrictions:</emphasis> Must be a
 
869
                              non-empty string.
 
870
                           </para>
 
871
                        </listitem>
 
872
                     </varlistentry>
 
873
 
 
874
                     <varlistentry>
 
875
                        <term><literal>command</literal></term>
 
876
                        <listitem>
 
877
                           <para>
 
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.  
 
882
                           </para>
 
883
                           <para>
 
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.
 
898
                           </para>
 
899
                           <para>
 
900
                              <emphasis>Restrictions:</emphasis> Must be a
 
901
                              non-empty string.
 
902
                           </para>
 
903
                        </listitem>
 
904
                     </varlistentry>
 
905
 
 
906
                  </variablelist>
 
907
 
 
908
               </listitem>
 
909
            </varlistentry>
 
910
 
752
911
         </variablelist>
753
912
         
754
913
      </sect2>