diff options
author | наб <[email protected]> | 2021-05-27 02:46:40 +0200 |
---|---|---|
committer | Brian Behlendorf <[email protected]> | 2021-06-09 13:05:34 -0700 |
commit | c650ceb64d59331845d64f40961b5171bd2ab5d2 (patch) | |
tree | 3c107c74bc8788163bcb5b7e065219644b10dde6 /man/man8/zpool-import.8 | |
parent | 13c9a41140f11928ad6d483bfb7aacdbafed6491 (diff) |
Lint most manpages
Reviewed-by: Richard Laager <[email protected]>
Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by: Tony Nguyen <[email protected]>
Reviewed-by: Ryan Moeller <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes #12129
Diffstat (limited to 'man/man8/zpool-import.8')
-rw-r--r-- | man/man8/zpool-import.8 | 115 |
1 files changed, 68 insertions, 47 deletions
diff --git a/man/man8/zpool-import.8 b/man/man8/zpool-import.8 index 66a8d94d6..1b1f3c5ae 100644 --- a/man/man8/zpool-import.8 +++ b/man/man8/zpool-import.8 @@ -18,7 +18,6 @@ .\" .\" CDDL HEADER END .\" -.\" .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved. .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved. @@ -30,50 +29,53 @@ .Dd August 9, 2019 .Dt ZPOOL-IMPORT 8 .Os +. .Sh NAME .Nm zpool-import -.Nd Lists ZFS storage pools available to import or import the specified pools +.Nd import ZFS storage pools or list available pools .Sh SYNOPSIS .Nm zpool .Cm import .Op Fl D -.Op Fl d Ar dir Ns | Ns device +.Oo Fl d Ar dir Ns | Ns Ar device Oc Ns … .Nm zpool .Cm import .Fl a .Op Fl DflmN -.Op Fl F Oo Fl n Oc Oo Fl T Oc Oo Fl X Oc +.Op Fl F Op Fl nTX .Op Fl -rewind-to-checkpoint -.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device +.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns Ar device .Op Fl o Ar mntopts -.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... +.Oo Fl o Ar property Ns = Ns Ar value Oc Ns … .Op Fl R Ar root .Nm zpool .Cm import -.Op Fl Dflm -.Op Fl F Oo Fl n Oc Oo Fl T Oc Oo Fl X Oc +.Op Fl Dflmt +.Op Fl F Op Fl nTX .Op Fl -rewind-to-checkpoint -.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device +.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns Ar device .Op Fl o Ar mntopts -.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... +.Oo Fl o Ar property Ns = Ns Ar value Oc Ns … .Op Fl R Ar root .Op Fl s .Ar pool Ns | Ns Ar id -.Op Ar newpool Oo Fl t Oc +.Op Ar newpool +. .Sh DESCRIPTION .Bl -tag -width Ds .It Xo .Nm zpool .Cm import .Op Fl D -.Op Fl d Ar dir Ns | Ns device +.Oo Fl d Ar dir Ns | Ns Ar device Oc Ns … .Xc Lists pools available to import. If the .Fl d or .Fl c options are not specified, this command searches for devices using libblkid -on Linux and geom on FreeBSD. +on Linux and geom on +.Fx . The .Fl d option can be specified multiple times, and all directories are searched. @@ -114,10 +116,10 @@ Lists destroyed pools only. .Cm import .Fl a .Op Fl DflmN -.Op Fl F Oo Fl n Oc Oo Fl T Oc Oo Fl X Oc -.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device +.Op Fl F Op Fl nTX +.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns Ar device .Op Fl o Ar mntopts -.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... +.Oo Fl o Ar property Ns = Ns Ar value Oc Ns … .Op Fl R Ar root .Op Fl s .Xc @@ -168,12 +170,13 @@ If successful, the data from the discarded transactions is irretrievably lost. This option is ignored if the pool is importable or already imported. .It Fl l Indicates that this command will request encryption keys for all encrypted -datasets it attempts to mount as it is bringing the pool online. Note that if -any datasets have a +datasets it attempts to mount as it is bringing the pool online. +Note that if any datasets have a .Sy keylocation of .Sy prompt -this command will block waiting for the keys to be entered. Without this flag +this command will block waiting for the keys to be entered. +Without this flag encrypted datasets will be left unavailable until the keys are loaded. .It Fl m Allows a pool to import when there is a missing log device. @@ -221,36 +224,42 @@ administrator can see how the pool would look like if they were to fully rewind. .It Fl s Scan using the default search path, the libblkid cache will not be -consulted. A custom search path may be specified by setting the -ZPOOL_IMPORT_PATH environment variable. +consulted. +A custom search path may be specified by setting the +.Sy ZPOOL_IMPORT_PATH +environment variable. .It Fl X Used with the .Fl F -recovery option. Determines whether extreme -measures to find a valid txg should take place. This allows the pool to +recovery option. +Determines whether extreme measures to find a valid txg should take place. +This allows the pool to be rolled back to a txg which is no longer guaranteed to be consistent. -Pools imported at an inconsistent txg may contain uncorrectable -checksum errors. For more details about pool recovery mode, see the +Pools imported at an inconsistent txg may contain uncorrectable checksum errors. +For more details about pool recovery mode, see the .Fl F -option, above. WARNING: This option can be extremely hazardous to the +option, above. +WARNING: This option can be extremely hazardous to the health of your pool and should only be used as a last resort. .It Fl T -Specify the txg to use for rollback. Implies +Specify the txg to use for rollback. +Implies .Fl FX . For more details about pool recovery mode, see the .Fl X -option, above. WARNING: This option can be extremely hazardous to the +option, above. +WARNING: This option can be extremely hazardous to the health of your pool and should only be used as a last resort. .El .It Xo .Nm zpool .Cm import -.Op Fl Dflm -.Op Fl F Oo Fl n Oc Oo Fl t Oc Oo Fl T Oc Oo Fl X Oc -.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns device +.Op Fl Dflmt +.Op Fl F Op Fl nTX +.Op Fl c Ar cachefile Ns | Ns Fl d Ar dir Ns | Ns Ar device .Op Fl o Ar mntopts -.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... +.Oo Fl o Ar property Ns = Ns Ar value Oc Ns … .Op Fl R Ar root .Op Fl s .Ar pool Ns | Ns Ar id @@ -309,12 +318,13 @@ If successful, the data from the discarded transactions is irretrievably lost. This option is ignored if the pool is importable or already imported. .It Fl l Indicates that this command will request encryption keys for all encrypted -datasets it attempts to mount as it is bringing the pool online. Note that if -any datasets have a +datasets it attempts to mount as it is bringing the pool online. +Note that if any datasets have a .Sy keylocation of .Sy prompt -this command will block waiting for the keys to be entered. Without this flag +this command will block waiting for the keys to be entered. +Without this flag encrypted datasets will be left unavailable until the keys are loaded. .It Fl m Allows a pool to import when there is a missing log device. @@ -350,38 +360,49 @@ property to .Ar root . .It Fl s Scan using the default search path, the libblkid cache will not be -consulted. A custom search path may be specified by setting the -ZPOOL_IMPORT_PATH environment variable. +consulted. +A custom search path may be specified by setting the +.Sy ZPOOL_IMPORT_PATH +environment variable. .It Fl X Used with the .Fl F -recovery option. Determines whether extreme -measures to find a valid txg should take place. This allows the pool to +recovery option. +Determines whether extreme measures to find a valid txg should take place. +This allows the pool to be rolled back to a txg which is no longer guaranteed to be consistent. Pools imported at an inconsistent txg may contain uncorrectable -checksum errors. For more details about pool recovery mode, see the +checksum errors. +For more details about pool recovery mode, see the .Fl F -option, above. WARNING: This option can be extremely hazardous to the +option, above. +WARNING: This option can be extremely hazardous to the health of your pool and should only be used as a last resort. .It Fl T -Specify the txg to use for rollback. Implies +Specify the txg to use for rollback. +Implies .Fl FX . For more details about pool recovery mode, see the .Fl X -option, above. WARNING: This option can be extremely hazardous to the +option, above. +WARNING: This option can be extremely hazardous to the health of your pool and should only be used as a last resort. .It Fl t Used with .Sy newpool . Specifies that .Sy newpool -is temporary. Temporary pool names last until export. Ensures that -the original pool name will be used in all label updates and therefore -is retained upon export. -Will also set -o cachefile=none when not explicitly specified. +is temporary. +Temporary pool names last until export. +Ensures that the original pool name will be used +in all label updates and therefore is retained upon export. +Will also set +.Fl o Sy cachefile Ns = Ns Sy none +when not explicitly specified. .El .El +. .Sh SEE ALSO .Xr zpool-export 8 , .Xr zpool-list 8 , |