usr/src/man/man1m/fssnap.1m

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FSSNAP 1M "Aug 11, 2004"
   7 .SH NAME
   8 fssnap \- create temporary snapshots of a file system
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBfssnap\fR [\fB-F\fR \fIFSType\fR] [\fB-V\fR] \fB-o\fR \fIspecial_options\fR \fI/mount/point\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBfssnap \fR \fB-d\fR [\fB-F\fR \fI FSType\fR] [\fB-V\fR] \fI/mount/point\fR | \fIdev\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBfssnap\fR \fB-i\fR [\fB-F\fR \fIFSType\fR] [\fB-V\fR] [\fB-o\fR \fIspecial_options\fR]
  23      [\fI/mount/point\fR | \fIdev\fR]
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBfssnap\fR command creates a stable, read-only snapshot of a file system
  30 when given either an active mount point or a special device containing a
  31 mounted file system, as in the first form of the synopsis. A snapshot is a
  32 temporary image of a file system intended for backup operations.
  33 .sp
  34 .LP
  35 While the snapshot file system is stable and consistent, an application
  36 updating files when the snapshot is created might leave these files in an
  37 internally inconsistent, truncated, or otherwise unusable state. In such a
  38 case, the snapshot will contain these partially written or corrupted files. It
  39 is a good idea to ensure active applications are suspended or checkpointed and
  40 their associated files are also consistent during snapshot creation.
  41 .sp
  42 .LP
  43 File access times are not updated while the snapshot is being created.
  44 .sp
  45 .LP
  46 A path to the virtual device that contains this snapshot is printed to standard
  47 output when a snapshot is created.
  48 .SH OPTIONS
  49 .sp
  50 .LP
  51 The following options are supported:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-d\fR\fR
  56 .ad
  57 .RS 22n
  58 Deletes the snapshot associated with the given file system.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-F\fR \fIFSType\fR\fR
  65 .ad
  66 .RS 22n
  67 Specifies the file system type to be used. The \fBFSType\fR should either be
  68 specified here or be determined by matching the block special device with an
  69 entry in the \fB/etc/vfstab\fR table, or by consulting \fB/etc/default/fs\fR.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB-i\fR\fR
  76 .ad
  77 .RS 22n
  78 Displays the state of any given \fBFSType\fR snapshot. If a mount-point or
  79 device is not given, a list of all snapshots on the system is displayed. When a
  80 mount-point or device is specified, detailed information is provided for the
  81 specified file system snapshot by default. The format and meaning of this
  82 information is file-system dependent. See the \fBFSType\fR-specific
  83 \fBfssnap\fR man page for details.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-o\fR \fIspecial_options\fR\fR
  90 .ad
  91 .RS 22n
  92 See the \fBFSType\fR-specific man page for \fBfssnap\fR.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB-V\fR\fR
  99 .ad
 100 .RS 22n
 101 Echoes the complete command line, but does not execute the command.
 102 .RE
 103
 104 .SH OPERANDS
 105 .sp
 106 .LP
 107 The following operands are supported:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fI/mount/point\fR\fR
 112 .ad
 113 .RS 16n
 114 The directory where the file system resides.
 115 .RE
 116
 117 .SH EXAMPLES
 118 .sp
 119 .LP
 120 See \fBFSType\fR-specific man pages for examples.
 121 .SH EXIT STATUS
 122 .sp
 123 .LP
 124 The following exit values are returned:
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB0\fR\fR
 129 .ad
 130 .RS 6n
 131 Successful completion.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB>\fB0\fR\fR
 138 .ad
 139 .RS 6n
 140 An error occurred.
 141 .RE
 142
 143 .SH FILES
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fB/etc/vfstab\fR\fR
 148 .ad
 149 .RS 19n
 150 Specifies file system type.
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fB/etc/default/fs\fR\fR
 157 .ad
 158 .RS 19n
 159 Specifies the default local file system type.
 160 .RE
 161
 162 .SH SEE ALSO
 163 .sp
 164 .LP
 165 \fBfssnap_ufs\fR(1M), \fBattributes\fR(5)
 166 .SH NOTES
 167 .sp
 168 .LP
 169 This command might not be supported for all \fBFSTypes\fR.