xref: /csrg-svn/share/man/man5/fstab.5 (revision 38673)
Copyright (c) 1980, 1989 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)fstab.5 6.2 (Berkeley) 08/18/89

FSTAB 5 ""
C 4
NAME
fstab - static information about the file systems
SYNOPSIS
#include <fstab.h>
DESCRIPTION
The file /etc/fstab contains descriptive information about the various file systems. /etc/fstab is only read by programs, and not written; it is the duty of the system administrator to properly create and maintain this file. Each file system is described on a separate line; fields on each line are separated by tabs or spaces. The order of records in /etc/fstab is important because fsck, mount, and umount sequentially iterate through /etc/fstab doing their thing.

The first field, (\c \|fs_spec ), describes the block special device or remote file system to be mounted. For file systems of type ufs , the special file name is the block special file name, and not the character special file name. If a program needs the character special file name, the program must create it by appending a ``r'' after the last ``/'' in the special file name.

The second field, (\c \|fs_file ), describes the mount point for the file system. For swap partitions, this field should be specified as ``none''.

The third field, (\c \|fs_vfstype ), describes the type of the file system. The system currently supports three types of file systems:

ufs 8
the local UNIX file system
nfs 8
a Sun Microsystems ``Network File System''
swap 8
a disk partition to be used for swapping

The fourth field, (\c \|fs_mntops ), describes the mount options associated with the file system. It is formatted as a comma separated list of options. It contains at least the type of mount (see fs_type below) plus any additional options appropriate to the file system type.

The type of the mount is extracted from the fs_mntops field and stored separately in the fs_type field (it is not deleted from the fs_mntops field). If fs_type is ``rw'' or ``ro'' then the file system whose name is given in the fs_file field is normally mounted read-write or read-only on the specified special file. If fs_type is ``rq'', then the file system is normally mounted read-write, the file system is automatically processed by the quotacheck (8) command, and disk quotas are enabled with quotaon (8). File system quotas are maintained in a file ``quotas'', which is located at the root of the associated file system. If fs_type is ``sw'' then the special file is made available as a piece of swap space by the swapon (8) command at the end of the system reboot procedure. The fields other than fs_spec and fs_type are unused. If fs_type is specified as ``xx'' the entry is ignored. This is useful to show disk partitions which are currently unused.

The fifth field, (\c \|fs_freq ), is used for these file systems by the dump (8) command to determine which file systems need to be dumped. If the fifth field is not present, a value of zero is returned and dump will assume that the file system does not need to be dumped.

The sixth field, (\c \|fs_passno ), is used by the fsck (8) program to determine the order in which file system checks are done at reboot time. The root file system should be specified with a fs_passno of 1, and other file systems should have larger numbers. File systems within a drive should have distinct numbers, but file systems on different drives can be checked on the same pass to utilize parallelism available in the hardware. If the sixth field is not present, a value of zero is returned and fsck will assume that the file system does not need to be checked.


#define FSTAB_RW "rw" /* read-write device */
#define FSTAB_RO "ro" /* read-only device */
#define FSTAB_RQ "rq" /* read-write with quotas */
#define FSTAB_SW "sw" /* swap device */
#define FSTAB_XX "xx" /* ignore totally */

struct fstab { char *fs_spec; /* block special device name */ char *fs_file; /* file system path prefix */ char *fs_vfstype; /* type of file system */ 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 dump */ };

The proper way to read records from /etc/fstab is to use the routines getfsent(), getfsspec(), getfstype(), and getfsfile().

FILES
/etc/fstab
SEE ALSO
getfsent(3)