xref: /netbsd-src/sbin/mount_chfs/mount_chfs.8 (revision 976049247df70f8605ef662c8ff363f33e864bcc)
1.\" $NetBSD: mount_chfs.8,v 1.5 2021/06/07 21:44:35 dholland Exp $
2.\"
3.\" Copyright (c) 2011 The NetBSD Foundation, Inc.
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd June 7, 2021
28.Dt MOUNT_CHFS 8
29.Os
30.Sh NAME
31.Nm mount_chfs
32.Nd mount a CHFS flash file system
33.Sh SYNOPSIS
34.Nm
35.Sh DESCRIPTION
36Mounts a flash file system from a
37.Xr flash 4
38device.
39CHFS file systems can be only mounted from flash devices.
40For regular block devices like SSD drives or USB drives,
41please use a regular file system.
42The file system will be created during the first mount.
43CHFS stands for Chip File System.
44.Pp
45This command is normally executed by
46.Xr mount 8
47at boot time.
48.Pp
49The options are as follows:
50.Bl -tag -width Ds
51.It Fl o
52Options are specified with a
53.Fl o
54flag followed by a comma-separated string of options.
55See the
56.Xr mount 8
57man page for possible options and their meanings.
58.El
59.Sh EXAMPLES
60.Dl mount_chfs /dev/flash0 /mnt
61.Sh SEE ALSO
62.Xr flash 4 ,
63.Xr fstab 5 ,
64.Xr mount 8 ,
65.Xr flash 9
66.Sh HISTORY
67A
68.Nm
69utility appeared in
70.Nx 6.0 .
71CHFS was originally called ChewieFS during development.
72The name was changed to avoid legal issues and to have a more
73neutral name.
74.Sh AUTHORS
75CHFS was developed at the
76.An Department of Software Engineering, University of Szeged, Hungary.
77.Sh BUGS
78CHFS has a few known bugs as of 2011.
79Writing the FS full can cause problems.
80Truncating a file and growing it again can cause the new bytes
81not having all zeroes, but filled with the old content instead.
82