Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
tree: 2525c04034
Fetching contributors…

Cannot retrieve contributors at this time

504 lines (423 sloc) 13.568 kB
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title>tklbam-backup</title>
<meta name="author" content="Liraz Siri &lt;liraz&#64;turnkeylinux.org&gt;" />
<meta name="date" content="2012-08-10" />
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 6253 2010-03-02 00:24:53Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: left }
/* div.align-center * { */
/* text-align: left } */
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block {
margin-left: 2em ;
margin-right: 2em }
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="tklbam-backup">
<h1 class="title">tklbam-backup</h1>
<h2 class="subtitle" id="backup-the-current-system">Backup the current system</h2>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Author:</th>
<td>Liraz Siri &lt;<a class="reference external" href="mailto:liraz&#64;turnkeylinux.org">liraz&#64;turnkeylinux.org</a>&gt;</td></tr>
<tr><th class="docinfo-name">Date:</th>
<td>2012-08-10</td></tr>
<tr class="field"><th class="docinfo-name">Manual section:</th><td class="field-body">8</td>
</tr>
<tr class="field"><th class="docinfo-name">Manual group:</th><td class="field-body">backup</td>
</tr>
</tbody>
</table>
<div class="section" id="synopsis">
<h1>SYNOPSIS</h1>
<p>tklbam-backup [ -options ] [ override ... ]</p>
</div>
<div class="section" id="arguments">
<h1>ARGUMENTS</h1>
<p><cite>&lt;override&gt;</cite> := <tt class="docutils literal"><span class="pre">&lt;filesystem-override&gt;</span></tt> | <tt class="docutils literal"><span class="pre">&lt;database-override&gt;</span></tt></p>
<p>Overrides are usually configured in /etc/tklbam/overrides.</p>
<div class="section" id="filesystem-overrides">
<h2>Filesystem overrides</h2>
<p><tt class="docutils literal"><span class="pre">&lt;filesystem-override&gt;</span></tt> := -?/path/to/include/or/exclude</p>
<p>This includes or excludes additional files and directories from being
backed up if they've changed since installation.</p>
<p>Overrides defaults in /var/lib/tklbam/profile/dirindex.conf</p>
<p>Gotchas:</p>
<ul class="simple">
<li>If you add a directory handled by package management this may break
package management on the system you restore to.</li>
<li>Only changes (e.g., new files, edited files, deleted files) from the
base installation are included in a backup.</li>
</ul>
<p>Examples:</p>
<pre class="literal-block">
# exclude log files in /var/www
-/var/www/*/logs
# ignores changes to webmin configuration
-/etc/webmin
# include the contents of an external hard disk...
/mnt/images
</pre>
</div>
<div class="section" id="database-overrides">
<h2>Database overrides</h2>
<p><tt class="docutils literal"><span class="pre">&lt;database-override&gt;</span></tt> := -?mysql:database[/table]</p>
<p>By default ALL databases are backed up. Adding a positive override
changes the default behavior so that only the database or table
specified in the override is included in the backup.</p>
<p>You can mix positive overrides with negative overrides.</p>
<p>Examples:</p>
<pre class="literal-block">
# exclude Drupal6 sessions table
-mysql:drupal6/sessions
# only include drupal6 database
mysql:drupal6
</pre>
</div>
</div>
<div class="section" id="options">
<h1>OPTIONS</h1>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">--resume</span></kbd></td>
<td>Resume aborted backup session</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--disable-resume</span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Disable implicit --resume when rerunning an aborted backup</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--address=<var>TARGET_URL</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>manual backup target URL.
Default: automatically configured via Hub</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--simulate</span>, <span class="option">-s</span></kbd></td>
<td>Simulate operation. Don't actually backup.
Useful for inspecting /TKLBAM by hand.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--quiet</span>, <span class="option">-q</span></kbd></td>
<td>Be less verbose</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--logfile=<var>PATH</var></span></kbd></td>
<td>Path of file to log output to.
Default: /var/log/tklbam-backup</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--debug</span></kbd></td>
<td>Run $SHELL before Duplicity</td></tr>
</tbody>
</table>
<div class="section" id="configurable-options">
<h2>Configurable options</h2>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">--volsize <var>MB</var></span></kbd></td>
<td>Size of backup volume in MBs.
Default: 50</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--s3-parallel-uploads=<var>N</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Number of parallel volume chunk uploads
Default: 1</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--full-backup <var>FREQUENCY</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td><p class="first">Time frequency of full backup.
Default: 1M</p>
<p>&lt;frequency&gt; := now | &lt;int&gt;[DWM]</p>
<blockquote class="last">
<p>e.g.,:</p>
<pre class="literal-block">
now - always do a full backup
60m - 60 minutes
12h - 12 hours
3D - three days
2W - two weeks
1M - one month
</pre>
</blockquote>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--skip-files</span></kbd></td>
<td>Don't backup filesystem</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--skip-database</span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Don't backup databases</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--skip-packages</span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Don't backup new packages</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--force-profile=<var>PROFILE_ID</var></span></kbd></td>
</tr>
<tr><td>&nbsp;</td><td>Force a specific backup profile</td></tr>
</tbody>
</table>
<p>Resolution order for configurable options:</p>
<ol class="arabic">
<li><p class="first">comand line (highest precedence)</p>
</li>
<li><p class="first">configuration file (/etc/tklbam/conf):</p>
<pre class="literal-block">
# comment
&lt;option-name&gt; &lt;value&gt;
</pre>
</li>
<li><p class="first">built-in default (lowest precedence)</p>
</li>
</ol>
</div>
</div>
<div class="section" id="files">
<h1>FILES</h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name" colspan="2">Configuration files:</th></tr>
<tr><td>&nbsp;</td><td class="field-body">/etc/tklbam/overrides, /etc/tklbam/conf, /etc/tklbam/hooks.d</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Local cache of profile:</th></tr>
<tr><td>&nbsp;</td><td class="field-body">/var/lib/tklbam/profile</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="see-also">
<h1>SEE ALSO</h1>
<p><tt class="docutils literal">tklbam</tt> (8), <tt class="docutils literal"><span class="pre">tklbam-faq</span></tt> (7)</p>
</div>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.