chiark - git - mdw - distorted-backup/blob - snap.rfreezefs.8

   1 .TH snap.rfreezefs 8 "28 November 2011" "distorted.org.uk backup"
   2 .SH NAME
   3 snap.rfreezefs \- snapshot handler for remotely mounted filesystems
   4 .SH SYNOPSIS
   5 .B snap.rfreezefs
   6 .I device
   7 .IB key = value
   8 \&...
   9 .SH DESCRIPTION
  10 This is snapshot handler for remotely mounted filesystems; i.e.,
  11 filesystems mounted by some other machine which are granted direct
  12 block-level access to the volume.
  13 See
  14 .BR snap (8)
  15 for more information about how snapshot handlers fit into the overall
  16 system.
  17 It uses
  18 .BR rfreezefs (8)
  19 to negotiate with the remote host and ensure a consistent snapshot; it
  20 uses another snapshot handler, identified by the
  21 .B snapshot
  22 option, to actually acquire the snapshot.
  23 .PP
  24 The following options are recognized, either with a
  25 .RB ` .rfreezefs '
  26 suffix or without.  Other keys are passed on to the subtype handler.
  27 .TP
  28 .BI host=\fR[ user @\fR] hostname
  29 The hostname or IP address of the remote host, optionally with user
  30 name.  This name is passed to
  31 .BR ssh (1)
  32 in order to run
  33 .BR rfreezefs (8)
  34 on the remote host, but it must actually resolve to an address since
  35 it's also used to connect to the remote host as part of the
  36 .B rfreezefs
  37 synchronization protocol.  This option must be specified.
  38 .BI dir= mountpt
  39 The mount point of the filesystem on the remote host.  This option must
  40 be specified.
  41 .TP
  42 .BI op= op
  43 The
  44 .I op must be either
  45 .B snap
  46 (the default) to create a snapshot, or
  47 .B unsnap
  48 to remove it.
  49 .TP
  50 .BI rfreezefs= path
  51 The path to the
  52 .BR rfreezefs (8)
  53 binary on the remote host.  By default, the unqualified name
  54 .B rfreezefs
  55 will be used, and the remote shell will search the directories named in
  56 the
  57 .B PATH
  58 environment variable.  In fact, the
  59 .I path
  60 can be any shell syntax.
  61 .TP
  62 .B ssh= path
  63 Te path to the
  64 .BR ssh (1)
  65 program, or equivalent.  By default, the unqualified name
  66 .B ssh
  67 is used, and the directories named in the
  68 .B PATH
  69 environment variable will be searched.
  70 .TP
  71 .B subtype= type
  72 The snapshot type to use to actually take the snapshot.  This option
  73 must be specified.
  74 .SH SEE ALSO
  75 .BR snap (8),
  76 .BR rfreezefs (8).