870fc32fc9
Most subcommands got their own manpages (e.g. create). Some related commands grouped into a single manpage and symlinks created (e.g. set, get, and inherit). I did this when topics were either too short to warrant their own file or so interrelated that a user would want to refer between commands in the same file. Corrected .Sx internal references to .Xr cross refs; lots of .Sx references from when text was all in zfs.8 needed to be changed to .Xr zfs-$SUBCOMMAND 8 cross references. Divided subcommand list in zfs(8) into sections of related functionality. This required writing new descriptions for some commands. Preserved ".Os Linux", `.Os` macro parsing behavior differs between mandoc from the "BSD" mandoc package (available on Ubuntu) and man from Ubuntu's man-db package, which calls groff to format the manpages. Groff handles the `.Os` macro differently and wrongly, defaulting it to "BSD" in `/usr/share/groff/*/tmac/mdoc/doc-common`, instead of getting the default from `uname`. A future set of changes will introduce build-time preprocessing of manpages for platform-specific documentation and can insert the correct operating system name. Added SEE ALSO sections, the newly-divided zfs-*.8 subcommand man pages needed their own SEE ALSO sections pointing to related subcommands and, in some cases, documentation from other packages (e.g. zfs-share.8). Reviewed-by: Matt Ahrens <matt@delphix.com> Reviewed-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Reviewed-by: Sean Eric Fagan <sef@ixsystems.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ross Williams <ross@ross-williams.net> Closes #9559
107 lines
3.0 KiB
Groff
107 lines
3.0 KiB
Groff
.\"
|
|
.\" CDDL HEADER START
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.\" 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]
|
|
.\"
|
|
.\" CDDL HEADER END
|
|
.\"
|
|
.\"
|
|
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
|
|
.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
|
|
.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
|
|
.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
|
|
.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
|
|
.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
|
|
.\" Copyright (c) 2014 Integros [integros.com]
|
|
.\" Copyright 2019 Richard Laager. All rights reserved.
|
|
.\" Copyright 2018 Nexenta Systems, Inc.
|
|
.\" Copyright 2019 Joyent, Inc.
|
|
.\"
|
|
.Dd June 30, 2019
|
|
.Dt ZFS-UPGRADE 8
|
|
.Os Linux
|
|
.Sh NAME
|
|
.Nm zfs Ns Pf - Cm upgrade
|
|
.Nd Manage upgrading the on-disk version of filesystems.
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Cm upgrade
|
|
.Nm
|
|
.Cm upgrade
|
|
.Fl v
|
|
.Nm
|
|
.Cm upgrade
|
|
.Op Fl r
|
|
.Op Fl V Ar version
|
|
.Fl a | Ar filesystem
|
|
.Sh DESCRIPTION
|
|
.Bl -tag -width ""
|
|
.It Xo
|
|
.Nm
|
|
.Cm upgrade
|
|
.Xc
|
|
Displays a list of file systems that are not the most recent version.
|
|
.It Xo
|
|
.Nm
|
|
.Cm upgrade
|
|
.Fl v
|
|
.Xc
|
|
Displays a list of currently supported file system versions.
|
|
.It Xo
|
|
.Nm
|
|
.Cm upgrade
|
|
.Op Fl r
|
|
.Op Fl V Ar version
|
|
.Fl a | Ar filesystem
|
|
.Xc
|
|
Upgrades file systems to a new on-disk version.
|
|
Once this is done, the file systems will no longer be accessible on systems
|
|
running older versions of the software.
|
|
.Nm zfs Cm send
|
|
streams generated from new snapshots of these file systems cannot be accessed on
|
|
systems running older versions of the software.
|
|
.Pp
|
|
In general, the file system version is independent of the pool version.
|
|
See
|
|
.Xr zpool 8
|
|
for information on the
|
|
.Nm zpool Cm upgrade
|
|
command.
|
|
.Pp
|
|
In some cases, the file system version and the pool version are interrelated and
|
|
the pool version must be upgraded before the file system version can be
|
|
upgraded.
|
|
.Bl -tag -width "-V"
|
|
.It Fl V Ar version
|
|
Upgrade to the specified
|
|
.Ar version .
|
|
If the
|
|
.Fl V
|
|
flag is not specified, this command upgrades to the most recent version.
|
|
This
|
|
option can only be used to increase the version number, and only up to the most
|
|
recent version supported by this software.
|
|
.It Fl a
|
|
Upgrade all file systems on all imported pools.
|
|
.It Ar filesystem
|
|
Upgrade the specified file system.
|
|
.It Fl r
|
|
Upgrade the specified file system and all descendent file systems.
|
|
.El
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr zpool-upgrade 8
|