git.proxmox.com Git - mirror_zfs.git/blob

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 https://opensource.org/licenses/CDDL-1.0.

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 .\"

31 .\"

32 .Dd February 16, 2019

33 .Dt ZFS-MOUNT 8

34 .Os

35 .

36 .Sh NAME

37 .Nm zfs-mount

38 .Nd manage mount state of ZFS filesystems

39 .Sh SYNOPSIS

40 .Nm zfs

41 .Cm mount

42 .Nm zfs

43 .Cm mount

44 .Op Fl Oflv

45 .Op Fl o Ar options

46 .Fl a Ns | Ns Fl R Ar filesystem Ns | Ns Ar filesystem

47 .Nm zfs

48 .Cm unmount

49 .Op Fl fu

50 .Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint

51 .

52 .Sh DESCRIPTION

53 .Bl -tag -width ""

54 .It Xo

55 .Nm zfs

56 .Cm mount

57 .Xc

58 Displays all ZFS file systems currently mounted.

59 .It Xo

60 .Nm zfs

61 .Cm mount

62 .Op Fl Oflv

63 .Op Fl o Ar options

64 .Fl a Ns | Ns Fl R Ar filesystem Ns | Ns Ar filesystem

65 .Xc

66 Mount ZFS filesystem on a path described by its

67 .Sy mountpoint

68 property, if the path exists and is empty.

69 If

70 .Sy mountpoint

71 is set to

72 .Em legacy ,

73 the filesystem should be instead mounted using

74 .Xr mount 8 .

75 .Bl -tag -width "-O"

76 .It Fl O

77 Perform an overlay mount.

78 Allows mounting in non-empty

79 .Sy mountpoint .

80 See

81 .Xr mount 8

82 for more information.

83 .It Fl a

84 Mount all available ZFS file systems.

85 Invoked automatically as part of the boot process if configured.

86 .It Fl R

87 Mount the specified filesystems along with all their children.

88 .It Ar filesystem

89 Mount the specified filesystem.

90 .It Fl o Ar options

91 An optional, comma-separated list of mount options to use temporarily for the

92 duration of the mount.

93 See the

94 .Em Temporary Mount Point Properties

95 section of

96 .Xr zfsprops 7

97 for details.

98 .It Fl l

99 Load keys for encrypted filesystems as they are being mounted.

100 This is equivalent to executing

101 .Nm zfs Cm load-key

102 on each encryption root before mounting it.

103 Note that if a filesystem has

104 .Sy keylocation Ns = Ns Sy prompt ,

105 this will cause the terminal to interactively block after asking for the key.

106 .It Fl v

107 Report mount progress.

108 .It Fl f

109 Attempt to force mounting of all filesystems, even those that couldn't normally

110 be mounted (e.g. redacted datasets).

111 .El

112 .It Xo

113 .Nm zfs

114 .Cm unmount

115 .Op Fl fu

116 .Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint

117 .Xc

118 Unmounts currently mounted ZFS file systems.

119 .Bl -tag -width "-a"

120 .It Fl a

121 Unmount all available ZFS file systems.

122 Invoked automatically as part of the shutdown process.

123 .It Fl f

124 Forcefully unmount the file system, even if it is currently in use.

125 This option is not supported on Linux.

126 .It Fl u

127 Unload keys for any encryption roots unmounted by this command.

128 .It Ar filesystem Ns | Ns Ar mountpoint

129 Unmount the specified filesystem.

130 The command can also be given a path to a ZFS file system mount point on the

131 system.

132 .El

133 .El