lib/libc/sys/swapon.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)swapon.2    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/swapon.2,v 1.6.2.6 2001/12/14 18:34:01 ru Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt SWAPON 2
  37 .Os
  38 .Sh NAME
  39 .Nm swapon
  40 .Nd add a swap device for interleaved paging/swapping
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fn swapon "const char *special"
  47 .Sh DESCRIPTION
  48 .Fn Swapon
  49 makes the block device
  50 .Fa special
  51 available to the system for
  52 allocation for paging and swapping.  The names of potentially
  53 available devices are known to the system and defined at system
  54 configuration time.  The size of the swap area on
  55 .Fa special
  56 is calculated at the time the device is first made available
  57 for swapping.
  58 .Sh RETURN VALUES
  59 If an error has occurred, a value of -1 is returned and
  60 .Va errno
  61 is set to indicate the error.
  62 .Sh ERRORS
  63 .Fn Swapon
  64 succeeds unless:
  65 .Bl -tag -width Er
  66 .It Bq Er ENOTDIR
  67 A component of the path prefix is not a directory.
  68 .It Bq Er ENAMETOOLONG
  69 A component of a pathname exceeded 255 characters,
  70 or an entire path name exceeded 1023 characters.
  71 .It Bq Er ENOENT
  72 The named device does not exist.
  73 .It Bq Er EACCES
  74 Search permission is denied for a component of the path prefix.
  75 .It Bq Er ELOOP
  76 Too many symbolic links were encountered in translating the pathname.
  77 .It Bq Er EPERM
  78 The caller is not the super-user.
  79 .It Bq Er ENOTBLK
  80 .Fa Special
  81 is not a block device.
  82 .It Bq Er EBUSY
  83 The device specified by
  84 .Fa special
  85 has already
  86 been made available for swapping
  87 .It Bq Er EINVAL
  88 The device configured by
  89 .Fa special
  90 was not
  91 configured into the system as a swap device.
  92 .It Bq Er ENXIO
  93 The major device number of
  94 .Fa special
  95 is out of range (this indicates no device driver exists
  96 for the associated hardware).
  97 .It Bq Er EIO
  98 An I/O error occurred while opening the swap device.
  99 .It Bq Er EFAULT
 100 .Fa Special
 101 points outside the process's allocated address space.
 102 .El
 103 .Sh SEE ALSO
 104 .Xr config 8 ,
 105 .Xr swapon 8
 106 .Sh BUGS
 107 There is no way to stop swapping on a disk so that the pack may be
 108 dismounted.
 109 .Pp
 110 This call will be upgraded in future versions of the system.
 111 .Sh HISTORY
 112 The
 113 .Fn swapon
 114 function call appeared in
 115 .Bx 4.0 .