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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)swapon.8    8.1 (Berkeley) 6/5/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd November 29, 2021
  32 .Dt SWAPON 8
  33 .Os
  34 .Sh NAME
  35 .Nm swapon , swapoff , swapctl
  36 .Nd "specify devices for paging and swapping"
  37 .Sh SYNOPSIS
  38 .Nm swapon
  39 .Oo Fl F Ar fstab
  40 .Oc
  41 .Fl aLq | E Ar
  42 .Nm swapoff
  43 .Oo Fl F Ar fstab
  44 .Oc
  45 .Fl afLq | Ar
  46 .Nm swapctl
  47 .Op Fl AfghklmsU
  48 .Oo
  49 .Fl a Ar
  50 |
  51 .Fl d Ar
  52 .Oc
  53 .Sh DESCRIPTION
  54 The
  55 .Nm swapon , swapoff
  56 and
  57 .Nm swapctl
  58 utilities are used to control swap devices in the system.
  59 At boot time all swap entries in
  60 .Pa /etc/fstab
  61 are added automatically when the system goes multi-user.
  62 Swap devices use a fixed interleave; the maximum number of devices
  63 is unlimited.
  64 There is no priority mechanism.
  65 .Pp
  66 The
  67 .Nm swapon
  68 utility adds the specified swap devices to the system.
  69 If the
  70 .Fl a
  71 option is used, all swap devices in
  72 .Pa /etc/fstab
  73 will be added, unless their
  74 .Dq noauto
  75 or
  76 .Dq late
  77 option is also set.
  78 If the
  79 .Fl L
  80 option is specified,
  81 swap devices with the
  82 .Dq late
  83 option will be added as well as ones with no option.
  84 If the
  85 .Fl q
  86 option is used,
  87 informational messages will not be
  88 written to standard output when a swap device is added.
  89 The
  90 .Fl E
  91 option causes each of following devices to receive a
  92 .Dv BIO_DELETE
  93 command.
  94 This command marks the device's blocks as unused, except those that
  95 might store a disk label.
  96 This marking can erase a crash dump.
  97 To delay
  98 .Nm swapon
  99 for a device until after
 100 .Nm savecore
 101 has copied the crash dump to another location, use the
 102 .Dq late
 103 option.
 104 .Pp
 105 The
 106 .Nm swapoff
 107 utility removes the specified swap devices from the system.
 108 If the
 109 .Fl a
 110 option is used, all swap devices in
 111 .Pa /etc/fstab
 112 will be removed, unless their
 113 .Dq noauto
 114 option is also set.
 115 If the
 116 .Fl L
 117 option is specified,
 118 only swap devices with the
 119 .Dq late
 120 option will be removed.
 121 If the
 122 .Fl q
 123 option is used,
 124 informational messages will not be
 125 written to standard output when a swap device is removed.
 126 Note that
 127 .Nm swapoff
 128 will fail and refuse to remove a swap device if a very conservative
 129 check does not conclude that there is sufficient VM (memory +
 130 remaining swap devices) to run the system.
 131 The
 132 .Fl f
 133 option turns off this check, which could deadlock the system
 134 if there is insufficient swap space remaining.
 135 .Pp
 136 The
 137 .Nm swapoff
 138 utility
 139 must move swapped pages out of the device being removed which could
 140 lead to high system loads for a period of time, depending on how
 141 much data has been swapped out to that device.
 142 .Pp
 143 Other options supported by both
 144 .Nm swapon
 145 and
 146 .Nm swapoff
 147 are as follows:
 148 .Bl -tag -width indent
 149 .It Fl F Ar fstab
 150 Specify the
 151 .Pa fstab
 152 file to use (in conjunction with
 153 .Fl a Ns ).
 154 .El
 155 .Pp
 156 The
 157 .Nm swapctl
 158 utility exists primarily for those familiar with other
 159 .Bx Ns s
 160 and may be
 161 used to add, remove, or list swap devices.
 162 Note that the
 163 .Fl a
 164 option is used differently in
 165 .Nm swapctl
 166 and indicates that a specific list of devices should be added.
 167 The
 168 .Fl d
 169 option indicates that a specific list should be removed.
 170 The
 171 .Fl A
 172 and
 173 .Fl U
 174 options to
 175 .Nm swapctl
 176 operate on all swap entries in
 177 .Pa /etc/fstab
 178 which do not have their
 179 .Dq noauto
 180 option set.
 181 .Pp
 182 Swap information can be generated using the
 183 .Xr swapinfo 8
 184 utility,
 185 .Nm pstat
 186 .Fl s ,
 187 or
 188 .Nm swapctl
 189 .Fl l .
 190 The
 191 .Nm swapctl
 192 utility has the following options for listing swap:
 193 .Bl -tag -width indent
 194 .It Fl h
 195 Output values in human-readable form.
 196 .It Fl g
 197 Output values in gigabytes.
 198 .It Fl k
 199 Output values in kilobytes.
 200 .It Fl m
 201 Output values in megabytes.
 202 .It Fl l
 203 List the devices making up system swap.
 204 .It Fl s
 205 Print a summary line for system swap.
 206 .Pp
 207 The
 208 .Ev BLOCKSIZE
 209 environment variable is used if not specifically
 210 overridden.
 211 512 byte blocks are used by default.
 212 .El
 213 .Sh FILES
 214 .Bl -tag -width ".Pa /dev/{ada,da}?s?b" -compact
 215 .It Pa /dev/{ada,da}?s?b
 216 standard paging devices
 217 .It Pa /dev/md?
 218 memory disk devices
 219 .It Pa /etc/fstab
 220 .Tn ASCII
 221 file system description table
 222 .El
 223 .Sh DIAGNOSTICS
 224 These utilities may fail for the reasons described in
 225 .Xr swapon 2 .
 226 .Sh SEE ALSO
 227 .Xr swapon 2 ,
 228 .Xr fstab 5 ,
 229 .Xr init 8 ,
 230 .Xr mdconfig 8 ,
 231 .Xr pstat 8 ,
 232 .Xr rc 8
 233 .Sh HISTORY
 234 The
 235 .Nm swapon
 236 utility appeared in
 237 .Bx 4.0 .
 238 The
 239 .Nm swapoff
 240 and
 241 .Nm swapctl
 242 utilities appeared in
 243 .Fx 5.1 .