branch for updated copyright for network 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 47477ab..699ac24 100644 (file)
--- a/usr/src/lib/libc/sys/swapon.2
+++ b/usr/src/lib/libc/sys/swapon.2
@@ -2,28 +2,86 @@
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"

-.\"    @(#)swapon.2    4.1 (Berkeley) %G%
+.\"    @(#)swapon.2    6.4 (Berkeley) %G%

 .\"
 .\"

-.TH VSWAPON 2V
+.TH SWAPON 2 ""

 .UC 4
 .SH NAME
 .UC 4
 .SH NAME

-vswapon \- add a swap device for interleaved paging/swapping
+swapon \- add a swap device for interleaved paging/swapping

 .SH SYNOPSIS
 .nf
 .SH SYNOPSIS
 .nf

-.B vswapon(name)
-.B char *name;
+.B swapon(special)
+.B char *special;

 .fi
 .SH DESCRIPTION
 .fi
 .SH DESCRIPTION

-.I Vswapon
-makes the argument block device available to the system for
-allocation for paging and swapping.  The number of blocks to be
-made available, as well as the names of all potentially available
-devices are known to the system, and are present in the system
-configuration file (e.g. /usr/src/sys/conf/confhp.c).
+.I Swapon
+makes the block device 
+.I 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 
+.I special 
+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
+is set to indicate the error.
+.SH ERRORS
+.I Swapon
+succeeds unless:
+.TP 15
+[ENOTDIR]
+A component of the path prefix is not a directory.
+.TP 15
+[EINVAL]
+The pathname contains a character with the high-order bit set.
+.TP 15
+[ENAMETOOLONG]
+A component of a pathname exceeded 255 characters,
+or an entire path name exceeded 1023 characters.
+.TP 15
+[ENOENT]
+The named device does not exist.
+.TP 15
+[EACCES]
+Search permission is denied for a component of the path prefix.
+.TP 15
+[ELOOP]
+Too many symbolic links were encountered in translating the pathname.
+.TP 15
+[EPERM]
+The caller is not the super-user.
+.TP 15
+[ENOTBLK]
+.I Special
+is not a block device.
+.TP 15
+[EBUSY]
+The device specified by \fIspecial\fP has already
+been made available for swapping
+.TP 15
+[EINVAL]
+The device configured by \fIspecial\fP was not
+configured into the system as a swap device.
+.TP 15
+[ENXIO]
+The major device number of 
+.I special
+is out of range (this indicates no device driver exists
+for the associated hardware).
+.TP 15
+[EIO]
+An I/O error occurred while opening the swap device.
+.TP 15
+[EFAULT]
+.I Special
+points outside the process's allocated address space.

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-swapon(8)
+swapon(8), config(8)

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

-This call is peculiar to this version of UNIX.
+This call will be upgraded in future versions of the system.