Annotation of 43BSDReno/lib/libc/gen/getfsent.3, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"    @(#)getfsent.3  6.8 (Berkeley) 6/23/90
                     19: .\"
                     20: .TH GETFSENT 3  "June 23, 1990"
                     21: .UC 4
                     22: .SH NAME
                     23: getfsent, getfsspec, getfsfile, setfsent, endfsent \- get file system descriptor file entry
                     24: .SH SYNOPSIS
                     25: .nf
                     26: .B #include <fstab.h>
                     27: .PP
                     28: .B struct fstab *getfsent()
                     29: .PP
                     30: .B struct fstab *getfsspec(spec)
                     31: .B char *spec;
                     32: .PP
                     33: .B struct fstab *getfsfile(file)
                     34: .B char *file;
                     35: .PP
                     36: .B int setfsent()
                     37: .PP
                     38: .B void endfsent()
                     39: .fi
                     40: .SH DESCRIPTION
                     41: .IR Getfsent ,
                     42: .IR getfsspec ,
                     43: and
                     44: .I getfsfile
                     45: each return a pointer to an object with the following structure
                     46: containing the broken-out fields of a line in the file system
                     47: description file,
                     48: .IR < fstab.h >.
                     49: .RS
                     50: .PP
                     51: .nf
                     52: .ta \w'#define 'u +\w'char\ \ 'u +\w'*fs_vfstype;\ \ 'u
                     53: struct fstab {
                     54:        char    *fs_spec;       /* block special device name */
                     55:        char    *fs_file;       /* file system path prefix */
                     56:        char    *fs_vfstype;    /* type of file system */
                     57:        char    *fs_mntops;     /* comma separated mount options */
                     58:        char    *fs_type;       /* rw, ro, sw, or xx */
                     59:        int     fs_freq;        /* dump frequency, in days */
                     60:        int     fs_passno;      /* pass number on parallel dump */
                     61: };
                     62: .ft R
                     63: .ad
                     64: .fi
                     65: .RE
                     66: .PP
                     67: The fields have meanings described in
                     68: .IR fstab (5).
                     69: .PP
                     70: .I Setfsent
                     71: opens the file (closing any previously opened file) or rewinds it
                     72: if it is already open.
                     73: .PP
                     74: .I Endfsent
                     75: closes the file.
                     76: .PP
                     77: .I Getfsspec
                     78: and
                     79: .I getfsfile
                     80: search the entire file (opening it if necessary) for a matching special
                     81: file name or file system file name.
                     82: .PP
                     83: For programs wishing to read the entire database,
                     84: .I getfsent
                     85: reads the next entry (opening the file if necessary).
                     86: .PP
                     87: All entries in the file with a type field equivalent to
                     88: .I FSTAB_XX
                     89: are ignored.
                     90: .SH FILES
                     91: /etc/fstab
                     92: .SH "SEE ALSO"
                     93: fstab(5)
                     94: .SH DIAGNOSTICS
                     95: .IR Getfsent ,
                     96: .IR getfsspec ,
                     97: and
                     98: .I getfsfile
                     99: return a null pointer (0) on EOF or error.
                    100: .I Setfsent
                    101: returns 0 on failure, 1 on success.
                    102: .I Endfsent
                    103: returns nothing.
                    104: .SH BUGS
                    105: All information is contained in a static area so it must be copied if it is
                    106: to be saved.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.