d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
41788ddb71
freebsd-skq/sbin/mksnap_ffs/mksnap_ffs.8

91 lines
2.9 KiB
Groff
Raw Normal View History

Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.\"
.\" Copyright (c) 2003 Networks Associates Technology, Inc.
.\" All rights reserved.
.\"
.\" This software was developed for the FreeBSD Project by Marshall
.\" Kirk McKusick and Network Associates Laboratories, the Security
.\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
.\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
.\" research program.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The names of the authors may not be used to endorse or promote
.\" products derived from this software without specific prior written
.\" permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Note that a UFS filesystem can have up to 20 active snapshots. PR: docs/151104 Submitted by: Aldis Berjoza <aldis@bsdroot.lv> MFC after: 3 days
2011-02-15 07:25:54 +00:00
.Dd February 14, 2011
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.Dt MKSNAP_FFS 8
.Os
.Sh NAME
.Nm mksnap_ffs
mdoc(7) fixes. Approved by: re (blanket)
2003-05-24 19:53:08 +00:00
.Nd take a file system snapshot
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.Sh SYNOPSIS
.Nm
.Ar snapshot_name
.Sh DESCRIPTION
The
.Nm
mdoc(7) fixes. Approved by: re (blanket)
2003-05-24 19:53:08 +00:00
utility creates a snapshot named
- Move from mount(2) to nmount(2). This should allow to convert MNT_SNAPSHOT flag from a mount flag to FS-specific flag. - Simplify usage. Instead of 'mksnap_ffs /mnt/foo /mnt/foo/snap' allow to give only one argument: 'mksnap_ffs /mnt/foo/snap'. Old usage is also accepted for now. - Add an example of how to mount a snapshot.
2009-05-29 19:18:41 +00:00
.Ar snapshot_name .
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.Pp
The group ownership of the file is set to
mdoc(7) fixes. Approved by: re (blanket)
2003-05-24 19:53:08 +00:00
.Dq Li operator ;
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
the owner of the file remains
mdoc(7) fixes. Approved by: re (blanket)
2003-05-24 19:53:08 +00:00
.Dq Li root .
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
The mode of the snapshot is set to be readable by the owner
or members of the
mdoc(7) fixes. Approved by: re (blanket)
2003-05-24 19:53:08 +00:00
.Dq Li operator
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
group.
- Move from mount(2) to nmount(2). This should allow to convert MNT_SNAPSHOT flag from a mount flag to FS-specific flag. - Simplify usage. Instead of 'mksnap_ffs /mnt/foo /mnt/foo/snap' allow to give only one argument: 'mksnap_ffs /mnt/foo/snap'. Old usage is also accepted for now. - Add an example of how to mount a snapshot.
2009-05-29 19:18:41 +00:00
.Sh EXAMPLES
Create a snapshot of
.Pa /usr/home
file system and mount the snapshot elsewhere:
.Bd -literal -offset indent
mksnap_ffs /usr/home/snapshot
mdconfig -a -t vnode -o readonly -f /usr/home/snapshot
mount -o ro /dev/md0 /mnt/
.Ed
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.Sh SEE ALSO
.Xr chmod 2 ,
.Xr chown 8 ,
Fix an xref. PR: 138833 Submitted by: Alex Keda <admin@lissyara.su> MFC after: 3 days
2009-09-17 13:09:08 +00:00
.Xr mdconfig 8 ,
Replace a reference to non existant mount_ffs(8) by a reference to mount(8).
2003-09-07 14:11:02 +00:00
.Xr mount 8
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.Sh HISTORY
mdoc(7) fixes. Approved by: re (blanket)
2003-05-24 19:53:08 +00:00
The
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.Nm
mdoc(7) fixes. Approved by: re (blanket)
2003-05-24 19:53:08 +00:00
utility first appeared in
Add the mksnap_ffs command to the sbin directory. This setuid root program allows users in the operator group to take filesystem snapshots. Its first use will be in support of `dump -L'. Approved by: Technical Review Board <trb@FreeBSD.org> Sponsored by: DARPA & NAI Labs.
2003-03-02 01:50:33 +00:00
.Fx 5.0 .
mdoc: move CAVEATS, BUGS and SECURITY CONSIDERATIONS sections to the bottom of the manpages and order them consistently. GNU groff doesn't care about the ordering, and doesn't even mention CAVEATS and SECURITY CONSIDERATIONS as common sections and where to put them. Found by: mdocml lint run Reviewed by: ru
2010-05-13 12:07:55 +00:00
.Sh CAVEATS
The disk full situation is not handled gracefully and may
lead to a system panic when no free blocks are found.
Note that a UFS filesystem can have up to 20 active snapshots. PR: docs/151104 Submitted by: Aldis Berjoza <aldis@bsdroot.lv> MFC after: 3 days
2011-02-15 07:25:54 +00:00
.Pp
Every filesystem can have only up to 20 active snapshots.
When this limit is reached, attempting to create more snapshots
fails with
.Er ENOSPC ,
and
.Nm
reports that it is
.Dq out of space .
Reference in New Issue Copy Permalink