File: CedarBackup2-module.html

package info (click to toggle)
cedar-backup2 2.20.1-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 20,636 kB
  • ctags: 34,592
  • sloc: python: 63,703; xml: 9,041; makefile: 100; sh: 9
file content (208 lines) | stat: -rw-r--r-- 13,616 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>CedarBackup2</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;CedarBackup2
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="CedarBackup2-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package CedarBackup2</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2-pysrc.html">source&nbsp;code</a></span></p>
<p>Implements local and remote backups to CD or DVD media.</p>
  <p>Cedar Backup is a software package designed to manage system backups 
  for a pool of local and remote machines.  Cedar Backup understands how to
  back up filesystem data as well as MySQL and PostgreSQL databases and 
  Subversion repositories.  It can also be easily extended to support other
  kinds of data sources.</p>
  <p>Cedar Backup is focused around weekly backups to a single CD or DVD 
  disc, with the expectation that the disc will be changed or overwritten 
  at the beginning of each week.  If your hardware is new enough, Cedar 
  Backup can write multisession discs, allowing you to add incremental data
  to a disc on a daily basis.</p>
  <p>Besides offering command-line utilities to manage the backup process, 
  Cedar Backup provides a well-organized library of backup-related 
  functionality, written in the Python programming language.</p>

<hr />
<div class="fields">      <p><strong>Author:</strong>
        Kenneth J. Pronovici &lt;pronovic@ieee.org&gt;
      </p>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Submodules</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Submodules"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li> <strong class="uidlink"><a href="CedarBackup2.action-module.html">CedarBackup2.action</a></strong>: <em class="summary">Provides interface backwards compatibility.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions-module.html">CedarBackup2.actions</a></strong>: <em class="summary">Cedar Backup actions.</em>
    <ul>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.collect-module.html">CedarBackup2.actions.collect</a></strong>: <em class="summary">Implements the standard 'collect' action.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.constants-module.html">CedarBackup2.actions.constants</a></strong>: <em class="summary">Provides common constants used by standard actions.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.initialize-module.html">CedarBackup2.actions.initialize</a></strong>: <em class="summary">Implements the standard 'initialize' action.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.purge-module.html">CedarBackup2.actions.purge</a></strong>: <em class="summary">Implements the standard 'purge' action.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.rebuild-module.html">CedarBackup2.actions.rebuild</a></strong>: <em class="summary">Implements the standard 'rebuild' action.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.stage-module.html">CedarBackup2.actions.stage</a></strong>: <em class="summary">Implements the standard 'stage' action.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.store-module.html">CedarBackup2.actions.store</a></strong>: <em class="summary">Implements the standard 'store' action.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.util-module.html">CedarBackup2.actions.util</a></strong>: <em class="summary">Implements action-related utilities</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.actions.validate-module.html">CedarBackup2.actions.validate</a></strong>: <em class="summary">Implements the standard 'validate' action.</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.cli-module.html">CedarBackup2.cli</a></strong>: <em class="summary">Provides command-line interface implementation for the cback 
        script.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.config-module.html">CedarBackup2.config</a></strong>: <em class="summary">Provides configuration-related objects.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.customize-module.html">CedarBackup2.customize</a></strong>: <em class="summary">Implements customized behavior.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend-module.html">CedarBackup2.extend</a></strong>: <em class="summary">Official Cedar Backup Extensions</em>
    <ul>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.capacity-module.html">CedarBackup2.extend.capacity</a></strong>: <em class="summary">Provides an extension to check remaining media capacity.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.encrypt-module.html">CedarBackup2.extend.encrypt</a></strong>: <em class="summary">Provides an extension to encrypt staging directories.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.mbox-module.html">CedarBackup2.extend.mbox</a></strong>: <em class="summary">Provides an extension to back up mbox email files.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.mysql-module.html">CedarBackup2.extend.mysql</a></strong>: <em class="summary">Provides an extension to back up MySQL databases.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.postgresql-module.html">CedarBackup2.extend.postgresql</a></strong>: <em class="summary">Provides an extension to back up PostgreSQL databases.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.split-module.html">CedarBackup2.extend.split</a></strong>: <em class="summary">Provides an extension to split up large files in staging 
        directories.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.subversion-module.html">CedarBackup2.extend.subversion</a></strong>: <em class="summary">Provides an extension to back up Subversion repositories.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.extend.sysinfo-module.html">CedarBackup2.extend.sysinfo</a></strong>: <em class="summary">Provides an extension to save off important system recovery 
        information.</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.filesystem-module.html">CedarBackup2.filesystem</a></strong>: <em class="summary">Provides filesystem-related objects.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.image-module.html">CedarBackup2.image</a></strong>: <em class="summary">Provides interface backwards compatibility.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.knapsack-module.html">CedarBackup2.knapsack</a></strong>: <em class="summary">Provides the implementation for various knapsack algorithms.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.peer-module.html">CedarBackup2.peer</a></strong>: <em class="summary">Provides backup peer-related objects and utility functions.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.release-module.html">CedarBackup2.release</a></strong>: <em class="summary">Provides location to maintain version information.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.testutil-module.html">CedarBackup2.testutil</a></strong>: <em class="summary">Provides unit-testing utilities.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.tools-module.html">CedarBackup2.tools</a></strong>: <em class="summary">Official Cedar Backup Tools</em>
    <ul>
    <li> <strong class="uidlink"><a href="CedarBackup2.tools.span-module.html">CedarBackup2.tools.span</a></strong>: <em class="summary">Spans staged data among multiple discs</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.util-module.html">CedarBackup2.util</a></strong>: <em class="summary">Provides general-purpose utilities.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.writer-module.html">CedarBackup2.writer</a></strong>: <em class="summary">Provides interface backwards compatibility.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.writers-module.html">CedarBackup2.writers</a></strong>: <em class="summary">Cedar Backup writers.</em>
    <ul>
    <li> <strong class="uidlink"><a href="CedarBackup2.writers.cdwriter-module.html">CedarBackup2.writers.cdwriter</a></strong>: <em class="summary">Provides functionality related to CD writer devices.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.writers.dvdwriter-module.html">CedarBackup2.writers.dvdwriter</a></strong>: <em class="summary">Provides functionality related to DVD writer devices.</em>    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.writers.util-module.html">CedarBackup2.writers.util</a></strong>: <em class="summary">Provides utilities related to image writers.</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="CedarBackup2.xmlutil-module.html">CedarBackup2.xmlutil</a></strong>: <em class="summary">Provides general XML-related functionality.</em>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue Oct 19 20:56:40 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>