sys/contrib/openzfs/man/man8/zfs-rename.8

   1 .\"
   2 .\" CDDL HEADER START
   3 .\"
   4 .\" The contents of this file are subject to the terms of the
   5 .\" Common Development and Distribution License (the "License").
   6 .\" You may not use this file except in compliance with the License.
   7 .\"
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\"
  22 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
  23 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  24 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
  25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  26 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
  27 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
  28 .\" Copyright (c) 2014 Integros [integros.com]
  29 .\" Copyright 2019 Richard Laager. All rights reserved.
  30 .\" Copyright 2018 Nexenta Systems, Inc.
  31 .\" Copyright 2019 Joyent, Inc.
  32 .\"
  33 .Dd September 1, 2020
  34 .Dt ZFS-RENAME 8
  35 .Os
  36 .Sh NAME
  37 .Nm zfs Ns Pf - Cm rename
  38 .Nd Renames the given dataset (filesystem or snapshot).
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Cm rename
  42 .Op Fl f
  43 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
  44 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
  45 .Nm
  46 .Cm rename
  47 .Fl p
  48 .Op Fl f
  49 .Ar filesystem Ns | Ns Ar volume
  50 .Ar filesystem Ns | Ns Ar volume
  51 .Nm
  52 .Cm rename
  53 .Fl u
  54 .Op Fl f
  55 .Ar filesystem Ar filesystem
  56 .Nm
  57 .Cm rename
  58 .Fl r
  59 .Ar snapshot Ar snapshot
  60 .Sh DESCRIPTION
  61 .Bl -tag -width ""
  62 .It Xo
  63 .Nm
  64 .Cm rename
  65 .Op Fl f
  66 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
  67 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
  68 .Xc
  69 .It Xo
  70 .Nm
  71 .Cm rename
  72 .Fl p
  73 .Op Fl f
  74 .Ar filesystem Ns | Ns Ar volume
  75 .Ar filesystem Ns | Ns Ar volume
  76 .Xc
  77 .It Xo
  78 .Nm
  79 .Cm rename
  80 .Fl u
  81 .Op Fl f
  82 .Ar filesystem
  83 .Ar filesystem
  84 .Xc
  85 Renames the given dataset.
  86 The new target can be located anywhere in the ZFS hierarchy, with the exception
  87 of snapshots.
  88 Snapshots can only be renamed within the parent file system or volume.
  89 When renaming a snapshot, the parent file system of the snapshot does not need
  90 to be specified as part of the second argument.
  91 Renamed file systems can inherit new mount points, in which case they are
  92 unmounted and remounted at the new mount point.
  93 .Bl -tag -width "-a"
  94 .It Fl f
  95 Force unmount any file systems that need to be unmounted in the process.
  96 This flag has no effect if used together with the
  97 .Fl u
  98 flag.
  99 .It Fl p
 100 Creates all the nonexistent parent datasets.
 101 Datasets created in this manner are automatically mounted according to the
 102 .Sy mountpoint
 103 property inherited from their parent.
 104 .It Fl u
 105 Do not remount file systems during rename.
 106 If a file system's
 107 .Sy mountpoint
 108 property is set to
 109 .Sy legacy
 110 or
 111 .Sy none ,
 112 the file system is not unmounted even if this option is not given.
 113 .El
 114 .It Xo
 115 .Nm
 116 .Cm rename
 117 .Fl r
 118 .Ar snapshot Ar snapshot
 119 .Xc
 120 Recursively rename the snapshots of all descendent datasets.
 121 Snapshots are the only dataset that can be renamed recursively.
 122 .El