octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-11-26 14:56:29 +00:00
Code Issues Releases Wiki Activity

Add link to release page in doc

Browse Source
This commit is contained in:
Brikou Carré 2017-02-03 09:09:49 +01:00
parent f366a636e6
commit dfb94290ae
2 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -19,24 +19,23 @@ The latest documentation can be viewed online at
a menu that allows switching to the documentation and user manual for the a menu that allows switching to the documentation and user manual for the
latest released version. latest released version.
Build restic Install restic
============ ==============
Install Go/Golang (at least version 1.6), then run `go run build.go`, You can download the latest pre-compiled binary from the [restic release page](https://github.com/restic/restic/releases/latest).
afterwards you'll find the binary in the current directory:
$ go run build.go ```sh
$ ./restic --help
restic is a backup program which allows saving multiple revisions of files and
directories in an encrypted repository stored on different backends.
$ ./restic --help Usage:
Usage: restic [command]
restic [OPTIONS] <command> [...]
[...] ```
More documentation can be found in the [user manual](doc/Manual.md). More documentation can be found in the [user manual](doc/Manual.md).
At the moment, the only tested compiler for restic is the official Go compiler.
Building restic with gccgo may work, but is not supported.
Contribute and Documentation Contribute and Documentation
============================ ============================

29
doc/Manual.md
View File

@ -1,7 +1,13 @@
Thanks for using restic. This document will give you an overview of the basic Thanks for using restic. This document will give you an overview of the basic
functionality provided by restic. functionality provided by restic.
# Building/installing restic # Installing restic
## from pre-compiled binary
You can download the latest pre-compiled binary from the [restic release page](https://github.com/restic/restic/releases/latest).
## Mac OS X
If you are using Mac OS X, you can install restic using the If you are using Mac OS X, you can install restic using the
[homebrew](http://brew.sh/) packet manager: [homebrew](http://brew.sh/) packet manager:
@ -11,25 +17,19 @@ $ brew tap restic/restic
$ brew install restic $ brew install restic
``` ```
## archlinux
On archlinux, there is a package called `restic-git` which can be installed from AUR, e.g. with `pacaur`: On archlinux, there is a package called `restic-git` which can be installed from AUR, e.g. with `pacaur`:
```console ```console
$ pacaur -S restic-git $ pacaur -S restic-git
``` ```
At debian stable you can install 'go' directly from the repositories (as root): # Building restic
```console restic is written in the Go programming language and you need at least Go version 1.6.
$ apt-get install golang-go Building restic may also work with older versions of Go, but that's not spported.
``` See the [Getting started](https://golang.org/doc/install) guide of the Go project for
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. instructions how to install Go.
In order to build restic from source, execute the following steps: In order to build restic from source, execute the following steps:
@ -46,6 +46,8 @@ $ go run build.go
At the moment, the only tested compiler for restic is the official Go compiler. At the moment, the only tested compiler for restic is the official Go compiler.
Building restic with gccgo may work, but is not supported. Building restic with gccgo may work, but is not supported.
# Usage help
Usage help is available: Usage help is available:
```console ```console
@ -352,7 +354,6 @@ enter password for repository:
restoring <Snapshot of [/home/art] at 2015-05-08 21:45:17.884408621 +0200 CEST> to /tmp/restore-work restoring <Snapshot of [/home/art] at 2015-05-08 21:45:17.884408621 +0200 CEST> to /tmp/restore-work
``` ```
# Manage repository keys # Manage repository keys
The `key` command allows you to set multiple access keys or passwords per The `key` command allows you to set multiple access keys or passwords per