mirror of
https://github.com/borgbackup/borg.git
synced 2026-03-27 12:54:05 -04:00
docs: New layout and some initial documentation improvements
This commit is contained in:
parent
ccb7ea909f
commit
f685eb162c
4 changed files with 40 additions and 37 deletions
2
docs/_themes/attic/sidebarlogo.html
vendored
2
docs/_themes/attic/sidebarlogo.html
vendored
|
|
@ -1,3 +1,5 @@
|
|||
<link href='http://fonts.googleapis.com/css?family=Oswald:700|Inconsolata:400,700'
|
||||
rel='stylesheet' type='text/css'>
|
||||
<div class="sidebarlogo">
|
||||
<a href="{{ pathto('index') }}">
|
||||
<div class="title">Attic</div>
|
||||
|
|
|
|||
49
docs/_themes/attic/static/attic.css_t
vendored
49
docs/_themes/attic/static/attic.css_t
vendored
|
|
@ -1,10 +1,11 @@
|
|||
@import url("basic.css");
|
||||
|
||||
body {
|
||||
font-family: Arial, Sans-Serif;
|
||||
font-family: Helvetica;
|
||||
background-color: white;
|
||||
margin: 0 0 4em;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
position: relative;
|
||||
}
|
||||
div.related {
|
||||
display: none;
|
||||
|
|
@ -18,26 +19,30 @@ div.related a {
|
|||
text-decoration: none;
|
||||
}
|
||||
div.document {
|
||||
background-color: white;
|
||||
width: 850px;
|
||||
width: 1030px;
|
||||
margin: 0 auto;
|
||||
padding-top: 1em;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: right;
|
||||
width: 600px;
|
||||
width: 760px;
|
||||
padding: 0 20px 20px 20px;
|
||||
background-color: #f3f3f3;
|
||||
margin-bottom: 2em;
|
||||
}
|
||||
div.sphinxsidebar {
|
||||
margin-left: 0;
|
||||
parring-right: 20px;
|
||||
width: 230px;
|
||||
background: #e9e9e9;
|
||||
position: absolute;
|
||||
top: 0;
|
||||
min-height: 100%;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
font-family: "DejaVu Serif";
|
||||
font-family: "Oswald";
|
||||
font-weight: normal;
|
||||
font-style: italic;
|
||||
color: #333;
|
||||
}
|
||||
h1 {
|
||||
|
|
@ -46,9 +51,9 @@ h1 {
|
|||
h2, h3 {
|
||||
margin: 1.2em 0 .6em;
|
||||
}
|
||||
h1 { font-size: 260%;}
|
||||
h2 { font-size: 180%;}
|
||||
h3 { font-size: 130%;}
|
||||
h1 { font-size: 200%;}
|
||||
h2 { font-size: 140%;}
|
||||
h3 { font-size: 110%;}
|
||||
ul {
|
||||
padding-left: 1.2em;
|
||||
margin-bottom: .3em;
|
||||
|
|
@ -78,13 +83,12 @@ div.sphinxsidebar input {
|
|||
}
|
||||
|
||||
pre {
|
||||
border: 1px solid #ccc;
|
||||
padding: .6em;
|
||||
background: black;
|
||||
color: #ddd;
|
||||
border-radius: .4em;
|
||||
box-shadow: 2px 2px #ddd;
|
||||
line-height: 1.2em;
|
||||
padding: 10px 20px;
|
||||
background: white;
|
||||
color: #222;
|
||||
line-height: 1.5em;
|
||||
border-bottom: 2px solid black;
|
||||
font-family: "Inconsolata";
|
||||
}
|
||||
pre a:link,
|
||||
pre a:visited {
|
||||
|
|
@ -92,8 +96,7 @@ pre a:visited {
|
|||
}
|
||||
|
||||
div.sidebarlogo .title {
|
||||
font-family: "DejaVu Serif";
|
||||
font-style: italic;
|
||||
font-family: "Oswald";
|
||||
font-size: 500%;
|
||||
}
|
||||
div.sidebarlogo .subtitle {
|
||||
|
|
@ -125,10 +128,8 @@ p.admonition-title:after {
|
|||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
border-radius: .4em;
|
||||
box-shadow: 2px 2px #ddd;
|
||||
background-color: #ff5;
|
||||
border-bottom: 2px solid #d22;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ Easy to use
|
|||
Initialize a new backup :ref:`repository <repository_def>` and create your
|
||||
first backup :ref:`archive <archive_def>` in two lines::
|
||||
|
||||
$ attic init /usbdrive/my-backup.attic
|
||||
$ attic create -v /usbdrive/my-backup.attic::documents ~/Documents
|
||||
$ attic init /somewhere/my-repository.attic
|
||||
$ attic create -v /somewhere/my-repository.attic::Monday ~/Documents
|
||||
|
||||
See the :ref:`quickstart` chapter for a more detailed example.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,16 +13,16 @@ A step by step example
|
|||
|
||||
1. Before a backup can be made a repository has to be initialized::
|
||||
|
||||
$ attic init /somewhere/my-backup.attic
|
||||
$ attic init /somewhere/my-repository.attic
|
||||
|
||||
2. Backup the ``~/src`` and ``~/Documents`` directories into an archive called
|
||||
*first-backup*::
|
||||
|
||||
$ attic create -v /somwhere/my-backup.attic::first-backup ~/src ~/Documents
|
||||
$ attic create -v /somwhere/my-repository.attic::Monday ~/src ~/Documents
|
||||
|
||||
3. The next day create a new archive called *second-backup*::
|
||||
|
||||
$ attic create -v --stats /somwhere/my-backup.attic::second-backup ~/src ~/Documents
|
||||
$ attic create -v --stats /somwhere/my-repository.attic::Tuesday ~/src ~/Documents
|
||||
|
||||
This backup will be a lot quicker and a lot smaller since only new never
|
||||
before seen data is stored. The ``--stats`` option causes |project_name| to
|
||||
|
|
@ -31,19 +31,19 @@ A step by step example
|
|||
|
||||
4. List all archives in the repository::
|
||||
|
||||
$ attic list /somewhere/my-backup.attic
|
||||
$ attic list /somewhere/my-repository.attic
|
||||
|
||||
5. List the contents of the *first-backup* archive::
|
||||
5. List the contents of the *Monday* archive::
|
||||
|
||||
$ attic list /somewhere/my-backup.attic::first-backup
|
||||
$ attic list /somewhere/my-repository.attic::Monday
|
||||
|
||||
6. Restore the *first-backup* archive::
|
||||
6. Restore the *Monday* archive::
|
||||
|
||||
$ attic extract -v /somwhere/my-backup.attic::first-backup
|
||||
$ attic extract -v /somwhere/my-repository.attic::Monday
|
||||
|
||||
7. Recover disk space by manually deleting the *first-backup* archive::
|
||||
7. Recover disk space by manually deleting the *Monday* archive::
|
||||
|
||||
$ attic delete /somwhere/my-backup.attic::first-backup
|
||||
$ attic delete /somwhere/my-backup.attic::Monday
|
||||
|
||||
|
||||
Automating backups
|
||||
|
|
@ -55,7 +55,7 @@ The following example script backs up ``/home`` and
|
|||
of old archives::
|
||||
|
||||
#!/bin/sh
|
||||
REPOSITORY=username@remoteserver.com:backup.attic
|
||||
REPOSITORY=username@remoteserver.com:repository.attic
|
||||
|
||||
# Backup all of /home and /var/www except a few
|
||||
# excluded directories
|
||||
|
|
|
|||
Loading…
Reference in a new issue