sbin/mksnap_ffs/mksnap_ffs.8

   1 .\"
   2 .\" Copyright (c) 2003 Networks Associates Technology, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed for the FreeBSD Project by Marshall
   6 .\" Kirk McKusick and Network Associates Laboratories, the Security
   7 .\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
   8 .\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
   9 .\" research program.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. The names of the authors may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd January 19, 2003
  38 .Dt MKSNAP_FFS 8
  39 .Os
  40 .Sh NAME
  41 .Nm mksnap_ffs
  42 .Nd take a file system snapshot
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Ar mountpoint
  46 .Ar snapshot_name
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility creates a snapshot named
  51 .Ar snapshot_name
  52 on the file system mounted at
  53 .Ar mountpoint .
  54 The
  55 .Ar snapshot_name
  56 argument must be contained within the file system mounted at
  57 .Ar mountpoint .
  58 .Pp
  59 The group ownership of the file is set to
  60 .Dq Li operator ;
  61 the owner of the file remains
  62 .Dq Li root .
  63 The mode of the snapshot is set to be readable by the owner
  64 or members of the
  65 .Dq Li operator
  66 group.
  67 .Sh SEE ALSO
  68 .Xr chmod 2 ,
  69 .Xr chown 8 ,
  70 .Xr mount 8
  71 .Sh CAVEATS
  72 The disk full situation is not handled gracefully and may
  73 lead to a system panic when no free blocks are found.
  74 .Sh HISTORY
  75 The
  76 .Nm
  77 utility first appeared in
  78 .Fx 5.0 .