fix the prototypes, minor cleanup to signal handlers

[unix-history] / usr / src / sbin / mount / mount.8

diff --git a/usr/src/sbin/mount/mount.8 b/usr/src/sbin/mount/mount.8
index 738eec0..e13ff14 100644 (file)
--- a/usr/src/sbin/mount/mount.8
+++ b/usr/src/sbin/mount/mount.8
@@ -1,217 +1,231 @@
-.\" Copyright (c) 1980, 1989 The Regents of the University of California.
+.\" Copyright (c) 1980, 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" 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.
+.\" %sccs.include.redist.roff%

 .\"
 .\"

-.\"    @(#)mount.8     6.14 (Berkeley) %G%
+.\"     @(#)mount.8    6.18 (Berkeley) %G%

 .\"
 .\"

-.TH MOUNT 8 ""
-.UC 4
-.SH NAME
-mount, umount \- mount and dismount file systems
-.SH SYNOPSIS
-.B mount
-[
-.B \-afrwu
-] [
-.B \-t
-nfs | ufs | external_type
-]
-.br
-.B mount
-[
-.B \-frwu
-]
-special | node
-.br
-.B mount
-[
-.B \-frwu
-] [
-.B \-t
-nfs | ufs | external_type
-] [
-.B \-o
-options
-]
-special node
-.br
-.PP
-.B umount
-[
-.B \-af
-] [
-.B \-t
-nfs | ufs | external_type
-]
-.br
-.B umount
-[
-.B \-f
-]
-special | node
-.br
-.SH DESCRIPTION
-.I Mount
-announces to the system that a removable file system is present on the
-block device \fIspecial\fP or the remote node ``rhost:path''. 
-The file \fInode\fP must exist already and
-it must be a directory.  It becomes the name of the newly mounted root.
-The optional arguments \fI-r\fP and \fI-w\fP indicate that the file
-system is to be mounted read-only or read-write, respectively.
-If either \fIspecial\fP or \fIfile\fP are not provided, the appropriate
-information is taken from the \fIfstab\fP file.  The \fI-f\fP option
-causes everything to be done except for the actual system call; if it's
+.Dd 
+.Dt MOUNT 8
+.Os BSD 4
+.Sh NAME
+.Nm mount ,
+.Nm umount
+.Nd mount and dismount file systems
+.Sh SYNOPSIS
+.Nm mount
+.Op Fl afrwu
+.Op Fl t Ar ufs | lfs | external_type
+.Nm mount
+.Op Fl frwu
+.Ar special | node
+.Nm mount
+.Op Fl frwu
+.Op Fl t Ar ufs | lfs | external_type
+.Op Fl o Ar options
+.Ar special node
+.Nm umount
+.Op Fl af
+.Op Fl t Ar ufs | lfs | external_type
+.Nm umount
+.Op Fl f
+.Ar special | node
+.Sh DESCRIPTION
+The
+.Nm mount
+command
+calls the
+.Xr mount 2
+system call to prepare and graft a
+.Ar special
+device or the remote node
+(rhost:path)
+on to the file system tree at the point
+.Ar node.
+If either
+.Ar special
+or
+.Ar node
+are not provided, the appropriate
+information is taken from the
+.Xr fstab 5
+file.
+.Pp
+The system maintains a list of currently mounted file systems.
+If no arguments are given to
+.Nm mount,
+this list is printed.
+.Pp
+Options available for the
+.Nm mount
+command:
+.Bl -tag -width indent
+.It Fl F
+The standard mount options are parsed and
+passed to external program via the
+.Fl F
+option
+as a decimal number.
+(See example below.)
+.It Fl f
+Causes everything to be done except for the actual system call; if it's

 not obvious, this ``fakes'' mounting the file system.
 not obvious, this ``fakes'' mounting the file system.

-This option is useful in conjunction with the \fI-v\fP flag to
+This option is useful in conjunction with the
+.Fl v
+flag to

 determine what the
 determine what the

-.I mount
+.Nm mount

 command is trying to do.
 command is trying to do.

-.PP
-The optional argument \fI-t\fP can be used
-to indicate the file system type.
-The type \fBufs\fP is the default.
-If the type is not one of the internally known types,
-mount will attempt to execute a program in
-.B /sbin/mount_XXX
-where \fBXXX\fP is replaced by the type name.
-The standard mount options (see below) are parsed and
-passed to external program via the \fI-F\fP option
-as a decimal number.
-Any additional options specific to the program can
-be passed as a comma separated list;
-these options are distinguished by starting with a \fI-\fP (dash).
-Those options that take a value are specified
-using the syntax -option=value.
-For example, the mount command:
-.br
-       mount -t mfs -o nosuid,-N,-s=4000 /dev/dk0b /tmp
-.br
-causes mount to attempt to execute:
-.br
-       /sbin/mount_mfs -F 8 -N -s 4000 /dev/dk0b /tmp
-.PP
-Options are specified by a \fI-o\fP argument
+.It Fl o
+Options are specified with a
+.Fl o
+flag

 followed by a comma separated string of options.
 The following options apply to any file system that is being mounted:
 followed by a comma separated string of options.
 The following options apply to any file system that is being mounted:

-.IP "noexec" 12
+.Bl -tag -width indent
+.It noexec

 Do not allow execution of any binaries on the mounted file system.
 This options is useful for a server that has file systems containing
 binaries for architectures other than its own.
 Do not allow execution of any binaries on the mounted file system.
 This options is useful for a server that has file systems containing
 binaries for architectures other than its own.

-.IP "nosuid" 12
+.It nosuid

 Do not allow set-user-identifier or set-group-identifier bits to take effect.
 Do not allow set-user-identifier or set-group-identifier bits to take effect.

-.IP "nodev" 12
+.It nodev

 Do not interpret character or block special devices on the file system.
 This options is useful for a server that has file systems containing
 special devices for architectures other than its own.
 Do not interpret character or block special devices on the file system.
 This options is useful for a server that has file systems containing
 special devices for architectures other than its own.

-.IP "synchronous" 12
-All I/O to the file system should be done synchronously.
-.PP
-The \fI-u\fP flag indicates that the status of an already mounted file
+.It synchronous
+All
+.Tn I/O
+to the file system should be done synchronously.
+.El
+.It Fl r
+The file system object is to be mounted read-only.
+.It Fl t Ar "ufs \\*(Ba lfs \\*(Ba external type"
+The argument following the
+.Fl t
+is used to indicate the file system type.
+The type
+.Ar ufs
+is the default.
+The \fI-t\fP option can be used
+to indicate that the actions should only be taken on
+filesystems of the specified type.
+More than one type may be specified in a comma separated list.
+The list of filesystem types can be prefixed with ``no'' to
+specify the filesystem types on which no action should be taken.
+For example, the
+.Nm mount
+command:
+.Bd -literal -offset indent
+mount -a -t nonfs,mfs
+.Ed
+.Pp
+mounts all filesystems except those of type
+.Tn NFS
+and
+.Tn MFS .
+.Pp
+If the type is not one of the internally known types,
+mount will attempt to execute a program in
+.Pa /sbin/mount_ Ns Em XXX
+where
+.Em XXX
+is replaced by the type name.
+For example, nfs filesystems are mounted by the program
+.Pa /sbin/mount_nfs .
+.It Fl u
+The
+.Fl u
+flag indicates that the status of an already mounted file

 system should be changed.
 system should be changed.

-Any of the options above may be changed;
+Any of the options discussed above (the
+.Fl o
+option)
+may be changed;

 also a file system can be changed from read-only to read-write.
 The set of options is determined by first extracting the options
 also a file system can be changed from read-only to read-write.
 The set of options is determined by first extracting the options

-for the file system from the \fIfstab\fP table,
-then applying any options specified by the \fI-o\fP argument,
-and finally applying the \fI-r\fP or \fI-w\fP option.
-.PP
-The following list can be used to override
-the defaults for an nfs mount:
-.IP "hard" 12
-I/O system calls will retry until the server responds (default)
-.IP "soft" 12
-I/O system calls will fail and return errno after \fIretrans\fP request
-retransmissions
-.IP "spongy" 12
-Soft semantics for the stat, lookup, fsstat, readlink and readdir
-filesystem operations and hard semantics for the others.
-This option is meant to be similar to hard,
-except that processes will not be hung forever when
-they trip over mount points to dead servers.
-.IP "bg" 12
-If the first mount request times out, do retries in background
-.IP "intr" 12
-I/O system calls can be interrupted.
-.IP "noconn" 12
-Do not connect the socket.
-Used for UDP servers that send replies from a
-socket other than the nfs server socket.
-.IP "tcp" 12
-Use TCP transport instead of UDP.
-.IP "rsize=#" 12
-Set read size to \fI#\fP bytes.
-.IP "wsize=#" 12
-Set write size to \fI#\fP bytes.
-.IP "retry=#" 12
-Set mount retry count to \fI#\fP.
-.IP "retrans=#" 12
-Set retransmission count for nfs rpc's to \fI#\fP.
-.IP "timeo=#" 12
-Set initial nfs timeout to \fI#\fP in 0.1 sec intervals.
-.fi
-.PP
-.I Umount
-announces to the system that the removable file system \fInode\fP
-or whatever removable file system was previously mounted on device
-\fIspecial\fP should be removed.
-If the \fI-f\fP option is specified for
-.IR umount ,
-the file system is forcibly unmounted.
+for the file system from the
+.Xr fstab
+table,
+then applying any options specified by the
+.Fl o
+argument,
+and finally applying the
+.Fl r
+or
+.Fl w
+option.
+.It Fl v
+Verbose mode.
+.It Fl w
+The file system object is to be read and write.
+.It Fl
+Any additional options specific to the program can
+be passed as a comma separated list;
+these options are distinguished by starting with a
+.Fl
+(dash).
+.El
+.Pp
+Those options that take a value are specified
+using the syntax -option=value.
+For example, the mount command:
+.Bd -literal -offset indent
+mount -t mfs -o nosuid,-N,-s=4000 /dev/dk0b /tmp
+.Ed
+.Pp
+causes mount to attempt to execute:
+.Bd -literal -offset indent
+/sbin/mount_mfs -F 8 -N -s 4000 /dev/dk0b /tmp
+.Ed
+.Pp
+The options specific to NFS filesystems are described in the
+.Xr mount_nfs 8
+manual page.
+.Pp
+.Nm Umount
+removes the
+.Ar special
+device grafted at point
+.Ar node
+from file system tree.
+.Pp
+Options for the
+.Nm umount
+command:
+.Bl -tag -width indent
+.It Fl f
+The file system is forcibly unmounted.

 Active special devices continue to work,
 but all other files return errors if further accesses are attempted.
 The root file system cannot be forcibly unmounted.
 Active special devices continue to work,
 but all other files return errors if further accesses are attempted.
 The root file system cannot be forcibly unmounted.

-.PP
-If the \fI-a\fP option is present for either
-.I mount
-or
-.I umount,
-all of the file systems described in
-.I fstab
-are mounted or unmounted.
-The optional argument \fI-t\fP can be used
-to indicate that the actions should only be taken on
+.It Fl a
+All of the file systems described in
+.Xr fstab 5
+are unmounted.
+.It Fl t
+Is used to indicate the actions should only be taken on

 filesystems of the specified type.
 More than one type may be specified in a comma separated list.
 The list of filesystem types can be prefixed with ``no'' to
 specify the filesystem types on which no action should be taken.
 filesystems of the specified type.
 More than one type may be specified in a comma separated list.
 The list of filesystem types can be prefixed with ``no'' to
 specify the filesystem types on which no action should be taken.

-For example, the mount command:
-.br
-       mount -a -t nonfs,mfs
-.br
-mounts all filesystems except those of type NFS and MFS.
-.PP
-The system maintains a list of currently mounted file systems.
-If invoked without an argument,
-.I mount
-prints the list.
-The optional argument \fI-t\fP can be used
-to indicate that only filesystems of the specified type
-should be listed.
-More than one type may be specified in a comma separated list.
-The list of filesystem types can be prefixed with ``no'' to
-indicate the types of filesystems to be excluded from the listing.
-.PP
-Physically write-protected and magnetic tape file
-systems must be mounted read-only
-or errors will occur when access times are updated,
-whether or not any explicit write is attempted.
-.SH FILES
-/etc/fstab     file system table
-.SH "SEE ALSO"
-mount(2), unmount(2), fstab(5)
-.SH BUGS
-Mounting garbaged file systems will crash the system.
-.PP
-Mounting a root directory on a non-directory
-makes some apparently good path names invalid.
+(See example above for the
+.Nm mount
+command.)
+.El
+.Sh FILES
+.Bl -tag -width /etc/fstab -compact
+.It Pa /etc/fstab
+file system table
+.El
+.Sh SEE ALSO
+.Xr mount 2 ,
+.Xr unmount 2 ,
+.Xr fstab 5
+.Sh BUGS
+It is possible for a corrupted file system to cause a crash.
+.Sh HISTORY
+A
+.Nm
+command appeared in
+.At v6 .