X-Git-Url: https://git.subgeniuskitty.com/unix-history/.git/blobdiff_plain/616b39cfd43635750f882bcc913de9faa2dd8ceb..931b84159d85fd72bcdaea7605d8cc23858a3364:/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 ddb72b06a9..396ae3ada9 100644
--- a/usr/src/lib/libc/sys/swapon.2
+++ b/usr/src/lib/libc/sys/swapon.2
@@ -1,88 +1,87 @@
-.\" Copyright (c) 1980 The Regents of the University of California.
+.\" Copyright (c) 1980, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
-.\"	@(#)swapon.2	6.6 (Berkeley) %G%
+.\"     @(#)swapon.2	6.7 (Berkeley) %G%
 .\"
-.TH SWAPON 2 ""
-.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
+.Dd 
+.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 
-.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 
-.I special 
+.Fa 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
+.Sh RETURN VALUES
+If an error has occurred, a value of -1 is returned and
+.Va errno
 is set to indicate the error.
-.SH ERRORS
-.I Swapon
+.Sh ERRORS
+.Fn Swapon
 succeeds unless:
-.TP 15
-[ENOTDIR]
+.Bl -tag -width ENAMETOOLONG
+.It Bq Er ENOTDIR
 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.
-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG
 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.
-.TP 15
-[EACCES]
+.It Bq Er EACCES
 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.
-.TP 15
-[EPERM]
+.It Bq Er EPERM
 The caller is not the super-user.
-.TP 15
-[ENOTBLK]
-.I Special
+.It Bq Er ENOTBLK
+.Fa Special
 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
-.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.
-.TP 15
-[ENXIO]
+.It Bq Er ENXIO
 The major device number of 
-.I special
+.Fa special
 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.
-.TP 15
-[EFAULT]
-.I Special
+.It Bq Er EFAULT
+.Fa Special
 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.
-.PP
+.Pp
 This call will be upgraded in future versions of the system.
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.0 .