aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFélix Sipma <felix+debian@gueux.org>2016-12-19 12:03:41 +0100
committerFélix Sipma <felix+debian@gueux.org>2016-12-19 12:03:41 +0100
commit7bb1498e5cb80243df2e85b32d9d95c15e10638f (patch)
tree264cb27bcae7ced4c845016c24d2fedee9b3e7b0
parent203f3e8177855e7ca0b68b1012dab36acce57858 (diff)
update doc/Manual.md patch
-rw-r--r--debian/patches/0002-Debianize-doc-Manual.md.patch90
1 files changed, 7 insertions, 83 deletions
diff --git a/debian/patches/0002-Debianize-doc-Manual.md.patch b/debian/patches/0002-Debianize-doc-Manual.md.patch
index 25e6916..1bd45f2 100644
--- a/debian/patches/0002-Debianize-doc-Manual.md.patch
+++ b/debian/patches/0002-Debianize-doc-Manual.md.patch
@@ -3,14 +3,14 @@ Date: Wed, 14 Dec 2016 16:27:55 +0100
Subject: Debianize doc/Manual.md
---
- doc/Manual.md | 121 ----------------------------------------------------------
- 1 file changed, 121 deletions(-)
+ doc/Manual.md | 45 +--------------------------------------------
+ 1 file changed, 1 insertion(+), 44 deletions(-)
diff --git a/doc/Manual.md b/doc/Manual.md
-index 2a16a90..89a844b 100644
+index 2a16a90..c121a35 100644
--- a/doc/Manual.md
+++ b/doc/Manual.md
-@@ -1,127 +1,6 @@
+@@ -1,50 +1,7 @@
Thanks for using restic. This document will give you an overview of the basic
functionality provided by restic.
@@ -58,83 +58,7 @@ index 2a16a90..89a844b 100644
-
-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
++# Basic usage
+
+ Usage help is available:
- First, we need to create a "repository". This is the place where your backups