external/bsd/nvi/usr.bin/recover/virecover.8

   1 .\" $NetBSD: virecover.8,v 1.1 2013/11/22 16:00:45 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Jeremy C. Reed.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd October 9, 2006
  31 .Dt VIRECOVER 8
  32 .Os
  33 .Sh NAME
  34 .Nm virecover
  35 .Nd report recovered vi edit sessions
  36 .Sh SYNOPSIS
  37 .Pa /usr/libexec/virecover
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility sends emails to users who have
  42 .Xr vi 1
  43 recovery files.
  44 .Pp
  45 This email gives the name of the file that was
  46 saved for recovery and instructions for recovering
  47 most, if not all, of the changes to the file.
  48 This is done by using the
  49 .Fl r
  50 option with
  51 .Xr vi 1 .
  52 See the
  53 .Fl r
  54 option in
  55 .Xr vi 1
  56 for details.
  57 .Pp
  58 If the backup files have the execute bit set or are zero length,
  59 then they have not been modified, so
  60 .Nm
  61 deletes them to clean up.
  62 .Nm
  63 also removes recovery files that are corrupted, zero length,
  64 or do not have a corresponding backup file.
  65 .Pp
  66 .Nm
  67 is normally run automatically at boot time using
  68 .Pa /etc/rc.d/virecover .
  69 .Sh FILES
  70 .Bl -tag -width "/var/tmp/vi.recover/recover.*" -compact
  71 .It Pa /var/tmp/vi.recover/recover.*
  72 .Xr vi 1
  73 recovery files
  74 .It Pa /var/tmp/vi.recover/vi.*
  75 .Xr vi 1
  76 editor backup files
  77 .El
  78 .Sh SEE ALSO
  79 .Xr vi 1 ,
  80 .Xr rc.conf 5
  81 .Sh HISTORY
  82 This script, previously known as
  83 .Nm recover.script ,
  84 is from nvi and was added to
  85 .Nx
  86 in 1996.
  87 It was renamed in 2001.
  88 .Sh AUTHORS
  89 This man page was written by
  90 .An Jeremy C. Reed Aq Mt reed@reedmedia.net .