xref: /netbsd-src/sbin/mount_nilfs/mount_nilfs.8 (revision cdc507f0d27576e5c4f30629a5cfe9e1f5271dbe)
1.\" $NetBSD: mount_nilfs.8,v 1.6 2022/05/24 20:50:17 andvar Exp $
2.\"
3.\" Copyright (c) 2008, 2009 Reinoud Zandijk
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
27.\"
28.Dd June 1, 2016
29.Dt MOUNT_NILFS 8
30.Os
31.Sh NAME
32.Nm mount_nilfs
33.Nd mount a NILFS file system
34.Sh SYNOPSIS
35.Nm
36.Op Fl c Ar checkpoint
37.Op Fl o Ar options
38.Op Fl t Ar gmtoff
39.Ar special
40.Ar node
41.Sh DESCRIPTION
42NILFS is a log-structured file system designed to support fast
43writing, fast recovery times, live snapshots, concurrent read-only
44snapshot mounts, and live file system resizing.
45Its inodes are managed using B-trees.
46.Pp
47The
48.Nm
49command attaches the NILFS file system residing on the specified
50.Ar special
51device node on the location indicated with
52.Ar node .
53.Pp
54.Bl -tag -width XXXoptions
55.It Fl c Ar checkpoint
56Select the checkpoint number
57.Ar checkpoint
58to be mounted instead of the default last one.
59.It Fl o Ar options
60Use the specified mount
61.Ar options
62as specified in
63.Xr mount 8 .
64.It Fl t Ar gmtoff
65Set the time zone offset (in seconds) from UTC to
66.Ar gmtoff ,
67with positive values indicating east of the Prime Meridian.
68If not set, the user's current time zone will be used.
69.El
70.Sh SEE ALSO
71.Xr mount 2 ,
72.Xr vnd 4 ,
73.Xr fstab 5 ,
74.Xr mount 8 ,
75.Xr mount_lfs 8 ,
76.Xr umount 8 ,
77.Xr vnconfig 8
78.Sh HISTORY
79NILFS is a file system developed by NTT and released in 2005 for
80Linux.
81Version 2 is available since 2009.
82This cleanroom implementation was written by
83.An -nosplit
84.An Reinoud Zandijk
85for
86.Nx
87in 2009, and has first been released as part of
88.Nx 6 .
89.Sh AUTHORS
90This implementation of NILFS was written by
91.An Reinoud Zandijk .
92.Sh CAVEATS
93This implementation currently only supports read-only operation.
94See
95.Xr mount_lfs 8
96for an older log-structured file system with write support.
97Also see
98.Xr wapbl 4
99and
100.Xr mount 8
101for fast journal-based recovery using FFS.
102