xref: /netbsd-src/sbin/mount_nilfs/mount_nilfs.8 (revision cdc507f0d27576e5c4f30629a5cfe9e1f5271dbe)

.\" $NetBSD: mount_nilfs.8,v 1.6 2022/05/24 20:50:17 andvar Exp $
.\"
.\" Copyright (c) 2008, 2009 Reinoud Zandijk
.\" 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 ``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 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.
.\"
.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
.\"
.Dd June 1, 2016
.Dt MOUNT_NILFS 8
.Os
.Sh NAME
.Nm mount_nilfs
.Nd mount a NILFS file system
.Sh SYNOPSIS
.Nm
.Op Fl c Ar checkpoint
.Op Fl o Ar options
.Op Fl t Ar gmtoff
.Ar special
.Ar node
.Sh DESCRIPTION
NILFS is a log-structured file system designed to support fast
writing, fast recovery times, live snapshots, concurrent read-only
snapshot mounts, and live file system resizing.
Its inodes are managed using B-trees.
.Pp
The
.Nm
command attaches the NILFS file system residing on the specified
.Ar special
device node on the location indicated with
.Ar node .
.Pp
.Bl -tag -width XXXoptions
.It Fl c Ar checkpoint
Select the checkpoint number
.Ar checkpoint
to be mounted instead of the default last one.
.It Fl o Ar options
Use the specified mount
.Ar options
as specified in
.Xr mount 8 .
.It Fl t Ar gmtoff
Set the time zone offset (in seconds) from UTC to
.Ar gmtoff ,
with positive values indicating east of the Prime Meridian.
If not set, the user's current time zone will be used.
.El
.Sh SEE ALSO
.Xr mount 2 ,
.Xr vnd 4 ,
.Xr fstab 5 ,
.Xr mount 8 ,
.Xr mount_lfs 8 ,
.Xr umount 8 ,
.Xr vnconfig 8
.Sh HISTORY
NILFS is a file system developed by NTT and released in 2005 for
Linux.
Version 2 is available since 2009.
This cleanroom implementation was written by
.An -nosplit
.An Reinoud Zandijk
for
.Nx
in 2009, and has first been released as part of
.Nx 6 .
.Sh AUTHORS
This implementation of NILFS was written by
.An Reinoud Zandijk .
.Sh CAVEATS
This implementation currently only supports read-only operation.
See
.Xr mount_lfs 8
for an older log-structured file system with write support.
Also see
.Xr wapbl 4
and
.Xr mount 8
for fast journal-based recovery using FFS.