.TH snap.rfreezefs 8 "28 November 2011" "distorted.org.uk backup"
.SH NAME
snap.rfreezefs \- snapshot handler for remotely mounted filesystems
.SH SYNOPSIS
.B snap.rfreezefs
.I device
.IB key = value
\&...
.SH DESCRIPTION
This is snapshot handler for remotely mounted filesystems; i.e.,
filesystems mounted by some other machine which are granted direct
block-level access to the volume.
See
.BR snap (8)
for more information about how snapshot handlers fit into the overall
system.
It uses
.BR rfreezefs (8)
to negotiate with the remote host and ensure a consistent snapshot; it
uses another snapshot handler, identified by the
.B snapshot
option, to actually acquire the snapshot.
.PP
The following options are recognized, either with a
.RB ` .rfreezefs '
suffix or without.  Other keys are passed on to the subtype handler.
.TP
.BI host=\fR[ user @\fR] hostname
The hostname or IP address of the remote host, optionally with user
name.  This name is passed to
.BR ssh (1)
in order to run
.BR rfreezefs (8)
on the remote host, but it must actually resolve to an address since
it's also used to connect to the remote host as part of the
.B rfreezefs
synchronization protocol.  This option must be specified.
.BI dir= mountpt
The mount point of the filesystem on the remote host.  This option must
be specified.
.TP
.BI op= op
The
.I op must be either
.B snap
(the default) to create a snapshot, or
.B unsnap
to remove it.
.TP
.BI rfreezefs= path
The path to the
.BR rfreezefs (8)
binary on the remote host.  By default, the unqualified name
.B rfreezefs
will be used, and the remote shell will search the directories named in
the
.B PATH
environment variable.  In fact, the
.I path
can be any shell syntax.
.TP
.B ssh= path
Te path to the
.BR ssh (1)
program, or equivalent.  By default, the unqualified name
.B ssh
is used, and the directories named in the
.B PATH
environment variable will be searched.
.TP
.B subtype= type
The snapshot type to use to actually take the snapshot.  This option
must be specified.
.SH SEE ALSO
.BR snap (8),
.BR rfreezefs (8).