aboutsummaryrefslogtreecommitdiff
path: root/debian/patches/0002-Debianize-doc-Manual.md.patch
diff options
context:
space:
mode:
Diffstat (limited to 'debian/patches/0002-Debianize-doc-Manual.md.patch')
-rw-r--r--debian/patches/0002-Debianize-doc-Manual.md.patch140
1 files changed, 140 insertions, 0 deletions
diff --git a/debian/patches/0002-Debianize-doc-Manual.md.patch b/debian/patches/0002-Debianize-doc-Manual.md.patch
new file mode 100644
index 0000000..25e6916
--- /dev/null
+++ b/debian/patches/0002-Debianize-doc-Manual.md.patch
@@ -0,0 +1,140 @@
+From: =?utf-8?q?F=C3=A9lix_Sipma?= <felix+debian@gueux.org>
+Date: Wed, 14 Dec 2016 16:27:55 +0100
+Subject: Debianize doc/Manual.md
+
+---
+ doc/Manual.md | 121 ----------------------------------------------------------
+ 1 file changed, 121 deletions(-)
+
+diff --git a/doc/Manual.md b/doc/Manual.md
+index 2a16a90..89a844b 100644
+--- a/doc/Manual.md
++++ b/doc/Manual.md
+@@ -1,127 +1,6 @@
+ Thanks for using restic. This document will give you an overview of the basic
+ functionality provided by restic.
+
+-# Building/installing restic
+-
+-If you are using Mac OS X, you can install restic using the
+-[homebrew](http://brew.sh/) packet manager:
+-
+-```console
+-$ brew tap restic/restic
+-$ brew install restic
+-```
+-
+-On archlinux, there is a package called `restic-git` which can be installed from AUR, e.g. with `pacaur`:
+-
+-```console
+-$ pacaur -S restic-git
+-```
+-
+-At debian stable you can install 'go' directly from the repositories (as root):
+-
+-```console
+-$ apt-get install golang-go
+-```
+-
+-after installation of 'go' go straight forward to 'git clone [...]'
+-
+-If you are using Linux, BSD or Windows, the only way to install restic on your
+-system right now is to compile it from source. restic is written in the Go
+-programming language and you need at least Go version 1.6. Building restic may
+-also work with older versions of Go, but that's not supported. See the [Getting
+-started](https://golang.org/doc/install) guide of the Go project for
+-instructions how to install Go.
+-
+-In order to build restic from source, execute the following steps:
+-
+-```console
+-$ git clone https://github.com/restic/restic
+-[...]
+-
+-$ cd restic
+-
+-$ go run build.go
+-```
+-
+-At the moment, the only tested compiler for restic is the official Go compiler.
+-Building restic with gccgo may work, but is not supported.
+-
+-Usage help is available:
+-
+-```console
+-$ ./restic --help
+-restic is a backup program which allows saving multiple revisions of files and
+-directories in an encrypted repository stored on different backends.
+-
+-Usage:
+- restic [command]
+-
+-Available Commands:
+- backup create a new backup of files and/or directories
+- cat print internal objects to stdout
+- check check the repository for errors
+- find find a file or directory
+- forget forget removes snapshots from the repository
+- init initialize a new repository
+- key manage keys (passwords)
+- list list items in the repository
+- ls list files in a snapshot
+- mount mount the repository
+- prune remove unneeded data from the repository
+- rebuild-index build a new index file
+- restore extract the data from a snapshot
+- snapshots list all snapshots
+- unlock remove locks other processes created
+- version Print version information
+-
+-Flags:
+- --no-lock do not lock the repo, this allows some operations on read-only repos
+- -p, --password-file string read the repository password from a file
+- -q, --quiet do not outputcomprehensive progress report
+- -r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY)
+-
+-Use "restic [command] --help" for more information about a command.
+-```
+-
+-Similar to programs such as `git`, restic has a number of sub-commands. You can
+-see these commands in the listing above. Each sub-command may have own
+-command-line options, and there is a help option for each command which lists
+-them, e.g. for the `backup` command:
+-
+-```console
+-$ ./restic backup --help
+-The "backup" command creates a new snapshot and saves the files and directories
+-given as the arguments.
+-
+-Usage:
+- restic backup [flags] FILE/DIR [FILE/DIR] ...
+-
+-Flags:
+- -e, --exclude pattern exclude a pattern (can be specified multiple times)
+- --exclude-file string read exclude patterns from a file
+- --files-from string read the files to backup from file (can be combined with file args)
+- -f, --force force re-reading the target files/directories. Overrides the "parent" flag
+- -x, --one-file-system Exclude other file systems
+- --parent string use this parent snapshot (default: last snapshot in the repo that has the same target files/directories)
+- --stdin read backup from stdin
+- --stdin-filename string file name to use when reading from stdin
+- --tag tag add a tag for the new snapshot (can be specified multiple times)
+-
+-Global Flags:
+- --no-lock do not lock the repo, this allows some operations on read-only repos
+- -p, --password-file string read the repository password from a file
+- -q, --quiet do not outputcomprehensive progress report
+- -r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY)
+-```
+-
+-Subcommand that support showing progress information such as `backup`, `check` and `prune` will do so unless
+-the quiet flag `-q` or `--quiet` is set. When running from a non-interactive console progress reporting will
+-be limited to once every 10 seconds to not fill your logs.
+-
+-Additionally on Unix systems if `restic` receives a SIGUSR signal the current progress will written to the
+-standard output so you can check up on the status at will.
+-
+-
+ # Initialize a repository
+
+ First, we need to create a "repository". This is the place where your backups