Changeset View
Changeset View
Standalone View
Standalone View
sbin/zfsbootcfg/zfsbootcfg.8
- This file was added.
| Property | Old Value | New Value |
|---|---|---|
| svn:eol-style | null | native \ No newline at end of property |
| svn:keywords | null | FreeBSD=%H \ No newline at end of property \ No newline at end of property \ No newline at end of property \ No newline at end of property |
| svn:mime-type | null | text/plain \ No newline at end of property |
| .\" Copyright (c) 2016 Andriy Gapon | |||||
| .\" All rights reserved. | |||||
| .\" | |||||
| .\" 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. | |||||
| .\" | |||||
| .\" 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$ | |||||
| .\" | |||||
| .Dd October 12, 2016 | |||||
| .Dt ZFSBOOTCFG 8 | |||||
| .Os | |||||
| .Sh NAME | |||||
| .Nm zfsbootcfg | |||||
| .Nd "specify zfsboot options for next reboot" | |||||
wblock: The suggestion was to s/reboot/boot/, not remote "the". So for this line, it should be:
```.Nd… | |||||
avgAuthorUnsubmitted Not Done Inline ActionsSorry for my misunderstanding, will fix. avg: Sorry for my misunderstanding, will fix. | |||||
| .Sh SYNOPSIS | |||||
Done Inline ActionsThis should probably just be "next boot". wblock: This should probably just be "next boot". | |||||
| .Nm | |||||
| .Ao Ar options Ac | |||||
| .Sh DESCRIPTION | |||||
| .Nm | |||||
| is used to set | |||||
| .Xr boot.config 5 | |||||
| style options to be used by | |||||
Done Inline ActionsThis should be either The .Nm utility is used to set OR .Nm is used to set rpokala: This should be either
The
.Nm
utility is used to set
OR
.Nm
is used to… | |||||
wblockUnsubmitted Not Done Inline ActionsIt's hard to say how to mark this up. The sentence probably should read (rendered) as zfsbootcfg is used to set boot.config(5)-style options to be used by This markup renders okay, but might not be the right way to do it: .Nm is used to set .Xr boot.config 5 Ns -style options to be used by wblock: It's hard to say how to mark this up. The sentence probably should read (rendered) as… | |||||
| .Xr zfsboot 8 | |||||
| or | |||||
| .Xr gptzfsboot 8 | |||||
| the next time the machine is booted. | |||||
| Once | |||||
| .Xr zfsboot 8 | |||||
Done Inline Actionsthe next time the machine is booted. rpokala: the next time the machine is booted. | |||||
| or | |||||
| .Xr gptzfsboot 8 | |||||
| reads the information, it is deleted. | |||||
| If booting fails the machine automatically reverts to the previous | |||||
wblockUnsubmitted Done Inline ActionsMissing a comma for the pause after "fails": If booting fails, the machine automatically reverts to the previous wblock: Missing a comma for the pause after "fails":
```If booting fails, the machine automatically… | |||||
| boot configuration for the next boot. | |||||
Done Inline ActionsIf booting fails, wblock: `If booting fails,` | |||||
wblockUnsubmitted Done Inline ActionsProbably don't need "boot" again here: configuration for the next boot. wblock: Probably don't need "boot" again here:
```configuration for the next boot.``` | |||||
| The information is stored in a special reserved area of a ZFS pool. | |||||
Done Inline ActionsPassive -> active No need for the possessive "its" here, just "the". wblock: Passive -> active
s/will automatically revert/automatically reverts/
No need for the… | |||||
| .Xr zfsboot 8 | |||||
Done Inline Actionsboot configuration for the next boot. wblock: `boot configuration for the next boot.` | |||||
| or | |||||
| .Xr gptzfsboot 8 | |||||
| read the boot options information from the first disk found in the first | |||||
wblockUnsubmitted Done Inline Actionsread the boot option information from the first disk found in the first wblock: ```read the boot option information from the first disk found in the first``` | |||||
| ZFS pool found. | |||||
| .Sh ENVIRONMENT | |||||
Done Inline Actionsread the boot option information from the first disk found in the first wblock: `read the boot option information from the first disk found in the first` | |||||
| .Bl -tag -width vfs.zfs.boot.primary_pool -compact | |||||
Done Inline ActionsZFS pool found. wblock: `ZFS pool found.` | |||||
| .It Ev vfs.zfs.boot.primary_pool | |||||
| The | |||||
| .Xr kenv 1 | |||||
| variable that identifies a pool for which the options are written. | |||||
| .It Ev vfs.zfs.boot.primary_vdev | |||||
| The | |||||
| .Xr kenv 1 | |||||
| variable that identifies a disk within the pool where the options | |||||
| are written. | |||||
| .El | |||||
| .Sh EXAMPLES | |||||
| Try to boot to a new | |||||
| .Em boot environment | |||||
| without changing the | |||||
| .Cm bootfs | |||||
| property of a pool: | |||||
| .Pp | |||||
| .Dl "zfsbootcfg ""zfs:tank/ROOT/newbe:"" | |||||
Done Inline Actionswithout changing the rpokala: without changing the | |||||
| .Pp | |||||
| To clear the boot options: | |||||
| .Pp | |||||
| .Dl "zfsbootcfg """" | |||||
Done Inline Actionss/znextboot/zfsbootcfg/ (or use .Nm? I'm not sure if that works in this context...?) rpokala: s/znextboot/zfsbootcfg/
(or use .Nm? I'm not sure if that works in this context...?) | |||||
| .Sh SEE ALSO | |||||
| .Xr boot.config 5 , | |||||
| .Xr gptzfsboot 8 , | |||||
| .Xr zfsboot 8 | |||||
Done Inline ActionsSame as above. rpokala: Same as above. | |||||
| .Sh HISTORY | |||||
| .Nm | |||||
| appeared in | |||||
| .Fx 12.0 . | |||||
| .Sh AUTHORS | |||||
| This manual page was written by | |||||
| .An Andriy Gapon Aq Mt avg@FreeBSD.org . | |||||
Done Inline Actions.Fx 12.0 . rpokala: .Fx 12.0 . | |||||
Not Done Inline ActionsI was not sure what to put here. avg: I was not sure what to put here.
Will I have to change the version when I MFC the change to… | |||||
| .Sh CAVEATS | |||||
| At the moment, | |||||
| .Nm | |||||
| uses the | |||||
Done Inline ActionsNeeds a comma after "moment" wblock: Needs a comma after "moment" | |||||
| .Ev vfs.zfs.boot.primary_pool | |||||
| and | |||||
| .Ev vfs.zfs.boot.primary_vdev | |||||
Done Inline Actionsuses the rpokala: uses the | |||||
| .Xr kenv 1 | |||||
| variables to determine a ZFS pool and a disk in it where the options | |||||
| are to be stored. | |||||
| The variables are set by the ZFS boot chain, so there is an assumption | |||||
| that the same boot disk is going to be used for the next reboot. | |||||
| There is no | |||||
| .Nm | |||||
| option to specify a different pool or a different disk. | |||||
| .Pp | |||||
| .Nm | |||||
| should be extended to install new | |||||
| .Xr zfsboot 8 | |||||
| blocks in a ZFS pool. | |||||
Done Inline Actions"be able to" is not needed. wblock: "be able to" is not needed. | |||||
The suggestion was to s/reboot/boot/, not remote "the". So for this line, it should be: