.\" $NetBSD: fstab.5,v 1.5.2.1 1995/11/16 20:11:11 pk Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993, 2002 .\" The Regents of the University of California. 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. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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. .\" .\" @(#)fstab.5 8.1 (Berkeley) 6/5/93 .\" .Dd March 28, 2002 .Dt FSTAB 5 .Os Darwin .Sh NAME .Nm fstab .Nd static information about the filesystems .Sh SYNOPSIS .Fd #include .Sh DESCRIPTION The file .Nm fstab contains descriptive information about the various file systems. .Nm fstab is only read by programs, and not written; it is the duty of the system administrator to properly create and maintain this file, using the .Xr vifs 8 command. Each filesystem is described on a separate line; fields on each line are separated by tabs or spaces. The order of records in .Nm fstab is important because .Xr diskarbitrationd 8 , .Xr fsck 8 , .Xr mount 8 , and .Xr umount 8 sequentially iterate through .Nm fstab doing their thing. .Pp The first field, .Pq Fa fs_spec , describes the block special device, the local filesystem, or the remote filesystem to be mounted. The .Xr diskarbitrationd program supports the identification of a local filesystem uniquely by its UUID or by its volume name, irrespective of hardware configuration and of hardware parallelism, using the constructs ``UUID'' and ``LABEL''. For APFS volumes, this field should never be the block special device as it is not constant. Only the constructs ``UUID'' and ``LABEL'' should be used. .Pp The second field, .Pq Fa fs_file , describes the mount point for the filesystem. For swap partitions, this field should be specified as ``none''. .Pp The third field, .Pq Fa fs_vfstype , describes the type of the filesystem. The system currently supports different filesystem types, including the following: .Bl -tag -width indent -offset indent .It Em apfs APFS is the Mac OS X default filesystem since version 10.13 (High Sierra). .It Em hfs HFS+ is the previous Mac OS X default filesystem. .It Em nfs a Sun Microsystems compatible ``Network File System'' .It Em msdos a DOS compatible filesystem .It Em cd9660 a CD-ROM filesystem (as per ISO 9660) .It Em fdesc an implementation of /dev/fd .It Em union a translucent filesystem .El .Pp The fourth field, .Pq Fa fs_mntops , describes the mount options associated with the filesystem. It is formatted as a comma separated list of options. It contains at least the type of mount (see .Fa fs_type below) plus any additional options appropriate to the filesystem type. .Pp The option ``auto'' can be used in the ``noauto'' form to cause a file system not to be mounted automatically (with ``mount -a'', or system boot time). .Pp The type of the mount is extracted from the .Fa fs_mntops field and stored separately in the .Fa fs_type field (it is not deleted from the .Fa fs_mntops field). If .Fa fs_type is ``rw'' or ``ro'' then the filesystem whose name is given in the .Fa fs_file field is normally mounted read-write or read-only on the specified special file. If .Fa fs_type is ``sw'' then the special file is made available as a piece of swap space by the .Xr swapon 8 command at the end of the system reboot procedure. The fields other than .Fa fs_spec and .Fa fs_type are unused. If .Fa fs_type is specified as ``xx'' the entry is ignored. This is useful to show disk partitions which are currently unused. .Pp The fifth field, .Pq Fa fs_freq , is used for these filesystems by the .Xr dump 8 command to determine which filesystems need to be dumped. If the fifth field is not present, a value of zero is returned and .Xr dump will assume that the filesystem does not need to be dumped. .Pp The sixth field, .Pq Fa fs_passno , is used by the .Xr fsck 8 program to determine the order in which filesystem checks are done at reboot time. The root filesystem should be specified with a .Fa fs_passno of 1, and other filesystems should have a .Fa fs_passno of 2. Filesystems within a drive will be checked sequentially, but filesystems on different drives will be checked at the same time to utilize parallelism available in the hardware. If the sixth field is not present or zero, a value of zero is returned and .Xr fsck will assume that the filesystem does not need to be checked. .Bd -literal #define FSTAB_RW "rw" /* read-write device */ #define FSTAB_RO "ro" /* read-only device */ #define FSTAB_SW "sw" /* swap device */ #define FSTAB_XX "xx" /* ignore totally */ struct fstab { char *fs_spec; /* block special device name */ char *fs_file; /* filesystem path prefix */ char *fs_vfstype; /* type of filesystem */ char *fs_mntops; /* comma separated mount options */ char *fs_type; /* rw, ro, sw, or xx */ int fs_freq; /* dump frequency, in days */ int fs_passno; /* pass number on parallel fsck */ }; .Ed .Pp The proper way to read records from .Pa fstab is to use the routines .Xr getfsent 3 , .Xr getfsspec 3 , .Xr getfstype 3 , and .Xr getfsfile 3 . .Sh EXAMPLES .Bd -literal UUID=2A1B02AD-467D-403A-8CCD-B87E50AD3DA2 none apfs rw UUID=DF000C7E-AE0C-3B15-B730-DFD2EF15CB91 /export apfs ro UUID=FAB060E9-79F7-33FF-BE85-E1D3ABD3EDEA none hfs rw,noauto LABEL=The\\040Volume\\040Name\\040Is\\040This none msdos ro .Ed .Sh FILES .Bl -tag -width /etc/fstab -compact .It Pa /etc/fstab The file .Nm fstab resides in .Pa /etc . .El .Sh SEE ALSO .Xr getfsent 3 , .Xr diskarbitrationd 8 .Sh HISTORY The .Nm file format appeared in .Bx 4.0 .