sbin/swapon/swapon.8

   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.8    8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD: src/sbin/swapon/swapon.8,v 1.15.2.2 2001/12/14 15:17:56 ru Exp $
  34 .\" $DragonFly: src/sbin/swapon/swapon.8,v 1.4 2007/08/10 18:28:27 swildner Exp $
  35 .\"
  36 .Dd September 7, 2010
  37 .Dt SWAPON 8
  38 .Os
  39 .Sh NAME
  40 .Nm swapon , swapoff , swapctl
  41 .Nd "specify devices for paging and swapping"
  42 .Sh SYNOPSIS
  43 .Nm swapon Fl aq | Ar
  44 .Nm swapoff Fl aq | Ar
  45 .Nm swapctl
  46 .Op Fl AghklmsU
  47 .Oo
  48 .Fl a Ar
  49 |
  50 .Fl d Ar
  51 .Oc
  52 .Sh DESCRIPTION
  53 The
  54 .Nm swapon , swapoff
  55 and
  56 .Nm swapctl
  57 utilities are used to control swap devices in the system.
  58 At boot time all swap entries in
  59 .Pa /etc/fstab
  60 are added automatically when the system goes multi-user.
  61 Swap devices use a fixed interleave; the maximum number of devices
  62 is specified by the kernel configuration option
  63 .Dv NSWAPDEV ,
  64 which is typically set to 4.
  65 There is no priority mechanism.
  66 .Pp
  67 The
  68 .Nm swapon
  69 utility adds the specified swap devices to the system.
  70 If the
  71 .Fl a
  72 option is used, all swap devices in
  73 .Pa /etc/fstab
  74 will be added, unless their
  75 .Dq noauto
  76 option is also set.
  77 If the
  78 .Fl q
  79 option is used informational messages will not be
  80 written to standard output when a swap device is added.
  81 .Pp
  82 The
  83 .Nm swapoff
  84 utility removes the specified swap devices from the system.
  85 If the
  86 .Fl a
  87 option is used, all swap devices in
  88 .Pa /etc/fstab
  89 will be removed, unless their
  90 .Dq noauto
  91 option is also set.
  92 If the
  93 .Fl q
  94 option is used informational messages will not be
  95 written to standard output when a swap device is removed.
  96 Note that
  97 .Nm swapoff
  98 will fail and refuse to remove a swap device if there is insufficient
  99 VM (memory + remaining swap devices) to run the system.
 100 The
 101 .Nm swapoff
 102 utility
 103 must move swapped pages out of the device being removed which could
 104 lead to high system loads for a period of time, depending on how
 105 much data has been swapped out to that device.
 106 .Pp
 107 The
 108 .Nm swapctl
 109 utility exists primarily for those familiar with other
 110 .Bx Ns s
 111 and may be
 112 used to add, remove, or list swap devices.
 113 Note that the
 114 .Fl a
 115 option is used differently in
 116 .Nm swapctl
 117 and indicates that a specific list of devices should be added.
 118 The
 119 .Fl d
 120 option indicates that a specific list should be removed.
 121 The
 122 .Fl A
 123 and
 124 .Fl U
 125 options to
 126 .Nm swapctl
 127 operate on all swap entries in
 128 .Pa /etc/fstab
 129 which do not have their
 130 .Dq noauto
 131 option set.
 132 .Pp
 133 Swap information can be generated using the
 134 .Xr swapinfo 8
 135 utility,
 136 .Nm pstat
 137 .Fl s ,
 138 or
 139 .Nm swapctl
 140 .Fl l .
 141 The
 142 .Nm swapctl
 143 utility has the following options for listing swap:
 144 .Bl -tag -width indent
 145 .It Fl h
 146 Output values in human-readable form.
 147 .It Fl g
 148 Output values in gigabytes.
 149 .It Fl k
 150 Output values in kilobytes.
 151 .It Fl m
 152 Output values in megabytes.
 153 .It Fl l
 154 List the devices making up system swap.
 155 .It Fl s
 156 Print a summary line for system swap.
 157 .Pp
 158 The
 159 .Ev BLOCKSIZE
 160 environment variable is used if not specifically
 161 overridden.
 162 1K blocks are used by default.
 163 .El
 164 .Sh FILES
 165 .Bl -tag -width ".Pa /dev/{ad,da}?s?b" -compact
 166 .It Pa /dev/{ad,da}?s?b
 167 standard paging devices
 168 .It Pa /dev/vn?s?b
 169 vnode disk paging device
 170 .It Pa /etc/fstab
 171 ASCII filesystem description table
 172 .It Pa /etc/vntab
 173 ASCII vnode file table
 174 .El
 175 .Sh DIAGNOSTICS
 176 These utilities may fail for the reasons described in
 177 .Xr swapon 2 .
 178 .Sh SEE ALSO
 179 .Xr swapon 2 ,
 180 .Xr fstab 5 ,
 181 .Xr init 8 ,
 182 .Xr pstat 8 ,
 183 .Xr rc 8 ,
 184 .Xr vnconfig 8
 185 .Sh HISTORY
 186 The
 187 .Nm swapon
 188 utility appeared in
 189 .Bx 4.0 .
 190 The
 191 .Nm swapoff
 192 and
 193 .Nm swapctl
 194 utilities appeared in
 195 .Fx 5.1
 196 and were later ported to
 197 .Dx 2.7 .