-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsnaps.8.html
117 lines (117 loc) · 5.42 KB
/
snaps.8.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<style>
table.head, table.foot { width: 100%; }
td.head-rtitle, td.foot-os { text-align: right; }
td.head-vol { text-align: center; }
div.Pp { margin: 1ex 0ex; }
</style>
<link rel="stylesheet" href="man.css" type="text/css" media="all"/>
<title>SNAPS(8)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">SNAPS(8)</td>
<td class="head-vol">System Manager's Manual</td>
<td class="head-rtitle">SNAPS(8)</td>
</tr>
</table>
<div class="manual-text">
<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1>
<b class="Nm" title="Nm">snaps</b> — <span class="Nd" title="Nd">easy and
secure remote snapshots</span>
<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<table class="Nm">
<tr>
<td><b class="Nm" title="Nm">snaps</b></td>
<td>[<span class="Op"><b class="Fl" title="Fl">-fhnqvV</b></span>]
[<span class="Op"><b class="Fl" title="Fl">-c</b>
<i class="Pa" title="Pa">configfile</i></span>]
[<span class="Op"><b class="Fl" title="Fl">-s</b>
<var class="Ar" title="Ar">filter</var></span>]</td>
</tr>
</table>
<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The <b class="Nm" title="Nm">snaps</b> utility takes snapshots of remote
locations using <a class="Xr" title="Xr">ssh(1)</a> and
<a class="Xr" title="Xr">hrsync(1)</a>, which is a hardened version of rsync.
Each location is being isolated from other locations that are being backed up
in order to mitigate against a compromised remote host.
<div class="Pp"></div>
The following arguments are supported:
<dl class="Bl-tag">
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#f"><b class="Fl" title="Fl" id="f">-f</b></a></dt>
<dd class="It-tag">Force taking a new snapshot, even if the last snapshot has
not yet expired.</dd>
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#h"><b class="Fl" title="Fl" id="h">-h</b></a></dt>
<dd class="It-tag">Print the synopsis of
<b class="Nm" title="Nm">snaps</b>.</dd>
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#n"><b class="Fl" title="Fl" id="n">-n</b></a></dt>
<dd class="It-tag">Only check the syntax of the config file and exit.</dd>
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#q"><b class="Fl" title="Fl" id="q">-q</b></a></dt>
<dd class="It-tag">Be quiet, except for errors.</dd>
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a></dt>
<dd class="It-tag">Be more verbose. Multiple occurrences increase the
verbosity level.</dd>
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#V"><b class="Fl" title="Fl" id="V">-V</b></a></dt>
<dd class="It-tag">Print the current version of
<b class="Nm" title="Nm">snaps</b> and exit.</dd>
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#c"><b class="Fl" title="Fl" id="c">-c</b></a>
<var class="Ar" title="Ar">configfile</var></dt>
<dd class="It-tag">Use an alternate configuration file. The default config
file used is /etc/snaps.conf.</dd>
<dt class="It-tag"> </dt>
<dd class="It-tag"> </dd>
<dt class="It-tag"><a class="selflink" href="#s"><b class="Fl" title="Fl" id="s">-s</b></a>
<var class="Ar" title="Ar">filter</var></dt>
<dd class="It-tag">Only backup locations in the config file that match
<var class="Ar" title="Ar">filter</var>. Each configured location is
canonicalized to user@host:path and can be filtered on any substring. This
option can be passed multiple times so that more locations are
matched.</dd>
</dl>
<div class="Pp"></div>
<b class="Nm" title="Nm">snaps</b> runs as an unprivileged user. This user must
have access to a public/private key pair that is used by
<a class="Xr" title="Xr">ssh(1)</a> to login to each remote location.
<h1 class="Sh" title="Sh" id="FILES"><a class="selflink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag Bl-compact" style="margin-left: 21.00ex;">
<dt class="It-tag" style="margin-left: -21.00ex;"><i class="Pa" title="Pa">/etc/snaps.conf</i></dt>
<dd class="It-tag">Default configuration file.</dd>
</dl>
<h1 class="Sh" title="Sh" id="EXIT_STATUS"><a class="selflink" href="#EXIT_STATUS">EXIT
STATUS</a></h1>
The <b class="Nm" title="Nm">snaps</b> utility exits 0 on success,
and >0 if an error occurs.
<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<a class="Xr" title="Xr">hrsync(1)</a>, <a class="Xr" title="Xr">ssh(1)</a>,
<a class="Xr" title="Xr">snaps.conf(5)</a>
<h1 class="Sh" title="Sh" id="AUTHORS"><a class="selflink" href="#AUTHORS">AUTHORS</a></h1>
<span class="An" title="An">Tim Kuijsten</span>
<<a class="Mt" title="Mt" href="mailto:[email protected]">[email protected]</a>></div>
<table class="foot">
<tr>
<td class="foot-date">May 22, 2018</td>
<td class="foot-os">OpenBSD 6.3</td>
</tr>
</table>
</body>
</html>