NAME
swapon
, swapoff
,
swapctl
—
specify devices for paging and
swapping
SYNOPSIS
swapon |
swapoff |
swapctl |
[-AeghklmsU ] [-a
file ... | -d
file ...] |
DESCRIPTION
Theswapon
, swapoff
and
swapctl
utilities are used to control swap devices in
the system. At boot time all swap entries in
/etc/fstab are added automatically when the system
goes multi-user. Swap devices use a fixed interleave; the maximum number of
devices is specified by the kernel configuration option
NSWAPDEV
, which is typically set to 4. There is no
priority mechanism.
The swapon
utility adds the specified swap
devices to the system. If the -a
option is used, all
swap devices in /etc/fstab will be added. The
following options are supported:
- “noauto”
- The device is ignored and will not be added or removed with this option.
- “crypt”
- Swap will be encrpted with a random key using a /dev/mapper name of swap-<device> , for example 'swap-da0s1b'. This will also load the dm_target_crypt module if necessary.
- “trim”
- Swap will be TRIMed if the device supports it, otherwise this option will be ignored.
If the -q
option is used informational
messages will not be written to standard output when a swap device is added.
If the -c
option is used, the device will be
encrypted with a random key. If the -E
option is
used, the device will be trimmed if it supports trim and the trim_enabled
sysctl is on. The -i
option asks user confirmation
before adding a swap device.
The swapoff
utility removes the specified
swap devices from the system. If the -a
option is
used, all swap devices in /etc/fstab will be
removed, unless their “noauto” option is also set. If the
-c
option is used the device is mapped to the
appropriate crypto device and the crypto device is removed as well. If this
option is specified in swapon
then it should also be
specified in swapoff
. If the
-q
option is used informational messages will not be
written to standard output when a swap device is removed. Note that
swapoff
will fail and refuse to remove a swap device
if there is insufficient VM (memory + remaining swap devices) to run the
system. The swapoff
utility must move swapped pages
out of the device being removed which could lead to high system loads for a
period of time, depending on how much data has been swapped out to that
device.
The swapctl
utility exists primarily for
those familiar with other BSDs and may be used to
add, remove, or list swap devices. Note that the -a
option is used differently in swapctl
and indicates
that a specific list of devices should be added. The
-d
option indicates that a specific list should be
removed. The -A
and -U
options to swapctl
operate on all swap entries in
/etc/fstab which do not have their
“noauto” option set.
Swap information can be generated using the
swapinfo(8) utility, pstat
-s
, or swapctl
-l
. The swapctl
utility has
the following options for listing swap:
-h
- Output values in human-readable form.
-g
- Output values in gigabytes.
-k
- Output values in kilobytes.
-m
- Output values in megabytes.
-l
- List the devices making up system swap.
-s
- Print a summary line for system swap. The swap is or should be crypted.
-e
-E
- Attempts to Trim the device if -[Aa] is used. The lower-case version of this option is deprecated.
-i
- Asks user confirmation when -a is used.
-q
- Less noisy output.
The
BLOCKSIZE
environment variable is used if not specifically overridden. 1K blocks are used by default.
FILES
- /dev/{ad,da}?s?b
- standard paging devices
- /dev/vn?s?b
- vnode disk paging device
- /etc/fstab
- ASCII filesystem description table
- /etc/vntab
- ASCII vnode file table
DIAGNOSTICS
These utilities may fail for the reasons described in swapon(2).
SEE ALSO
HISTORY
The swapon
utility appeared in
4.0BSD. The swapoff
and
swapctl
utilities appeared in
FreeBSD 5.1 and were later ported to
DragonFly 2.7.