BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / swapon.2

diff --git a/usr/src/lib/libc/sys/swapon.2 b/usr/src/lib/libc/sys/swapon.2
index ee6260a..a4523c3 100644 (file)
--- a/usr/src/lib/libc/sys/swapon.2
+++ b/usr/src/lib/libc/sys/swapon.2
@@ -1,100 +1,113 @@
-.\" Copyright (c) 1980 The Regents of the University of California.
+.\" Copyright (c) 1980, 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: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.

 .\"
 .\"

-.\"    @(#)swapon.2    6.6 (Berkeley) 6/23/90
+.\" 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.

 .\"
 .\"

-.TH SWAPON 2 "June 23, 1990"
-.UC 4
-.SH NAME
-swapon \- add a swap device for interleaved paging/swapping
-.SH SYNOPSIS
-.nf
-.B swapon(special)
-.B char *special;
-.fi
-.SH DESCRIPTION
-.I Swapon
+.\"     @(#)swapon.2   6.7 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt SWAPON 2
+.Os BSD 4
+.Sh NAME
+.Nm swapon
+.Nd add a swap device for interleaved paging/swapping
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn swapon "const char *special"
+.Sh DESCRIPTION
+.Fn Swapon

 makes the block device 
 makes the block device 

-.I special 
+.Fa special

 available to the system for
 allocation for paging and swapping.  The names of potentially
 available devices are known to the system and defined at system
 configuration time.  The size of the swap area on 
 available to the system for
 allocation for paging and swapping.  The names of potentially
 available devices are known to the system and defined at system
 configuration time.  The size of the swap area on 

-.I special 
+.Fa special

 is calculated at the time the device is first made available
 for swapping.
 is calculated at the time the device is first made available
 for swapping.

-.SH "RETURN VALUE
-If an error has occurred, a value of \-1 is returned and
-.I errno
+.Sh RETURN VALUES
+If an error has occurred, a value of -1 is returned and
+.Va errno

 is set to indicate the error.
 is set to indicate the error.

-.SH ERRORS
-.I Swapon
+.Sh ERRORS
+.Fn Swapon

 succeeds unless:
 succeeds unless:

-.TP 15
-[ENOTDIR]
+.Bl -tag -width ENAMETOOLONG
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named device does not exist.
 The named device does not exist.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Search permission is denied for a component of the path prefix.
 Search permission is denied for a component of the path prefix.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EPERM]
+.It Bq Er EPERM

 The caller is not the super-user.
 The caller is not the super-user.

-.TP 15
-[ENOTBLK]
-.I Special
+.It Bq Er ENOTBLK
+.Fa Special

 is not a block device.
 is not a block device.

-.TP 15
-[EBUSY]
-The device specified by \fIspecial\fP has already
+.It Bq Er EBUSY
+The device specified by
+.Fa special
+has already

 been made available for swapping
 been made available for swapping

-.TP 15
-[EINVAL]
-The device configured by \fIspecial\fP was not
+.It Bq Er EINVAL
+The device configured by
+.Fa special
+was not

 configured into the system as a swap device.
 configured into the system as a swap device.

-.TP 15
-[ENXIO]
+.It Bq Er ENXIO

 The major device number of 
 The major device number of 

-.I special
+.Fa special

 is out of range (this indicates no device driver exists
 for the associated hardware).
 is out of range (this indicates no device driver exists
 for the associated hardware).

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while opening the swap device.
 An I/O error occurred while opening the swap device.

-.TP 15
-[EFAULT]
-.I Special
+.It Bq Er EFAULT
+.Fa Special

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.SH "SEE ALSO"
-swapon(8), config(8)
-.SH BUGS
+.Sh SEE ALSO
+.Xr swapon 8 ,
+.Xr config 8
+.Sh BUGS

 There is no way to stop swapping on a disk so that the pack may be
 dismounted.
 There is no way to stop swapping on a disk so that the pack may be
 dismounted.

-.PP
+.Pp

 This call will be upgraded in future versions of the system.
 This call will be upgraded in future versions of the system.

+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.0 .