1 .\" Copyright (c) 1980, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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 .\" 4. 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.
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
28 .\" @(#)swapon.8 8.1 (Berkeley) 6/5/93
29 .\" $FreeBSD: src/sbin/swapon/swapon.8,v 1.15.2.2 2001/12/14 15:17:56 ru Exp $
30 .\" $DragonFly: src/sbin/swapon/swapon.8,v 1.4 2007/08/10 18:28:27 swildner Exp $
36 .Nm swapon , swapoff , swapctl
37 .Nd "specify devices for paging and swapping"
39 .Nm swapon Fl aeq | Ar
40 .Nm swapoff Fl aq | Ar
53 utilities are used to control swap devices in the system.
54 At boot time all swap entries in
56 are added automatically when the system goes multi-user.
57 Swap devices use a fixed interleave; the maximum number of devices
58 is specified by the kernel configuration option
60 which is typically set to 4.
61 There is no priority mechanism.
65 utility adds the specified swap devices to the system.
68 option is used, all swap devices in
70 will be added, unless their
75 option is used informational messages will not be
76 written to standard output when a swap device is added.
79 option is used, the device will be trimmed if
80 it supports trim and the trim_enabled sysctl is on.
84 utility removes the specified swap devices from the system.
87 option is used, all swap devices in
89 will be removed, unless their
94 option is used informational messages will not be
95 written to standard output when a swap device is removed.
98 will fail and refuse to remove a swap device if there is insufficient
99 VM (memory + remaining swap devices) to run the system.
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.
109 utility exists primarily for those familiar with other
112 used to add, remove, or list swap devices.
115 option is used differently in
117 and indicates that a specific list of devices should be added.
120 option indicates that a specific list should be removed.
127 operate on all swap entries in
129 which do not have their
133 Swap information can be generated using the
143 utility has the following options for listing swap:
144 .Bl -tag -width indent
146 Output values in human-readable form.
148 Output values in gigabytes.
150 Output values in kilobytes.
152 Output values in megabytes.
154 List the devices making up system swap.
156 Print a summary line for system swap.
158 Attempts to Trim the device if -[Aa] is used.
162 environment variable is used if not specifically
164 1K blocks are used by default.
167 .Bl -tag -width ".Pa /dev/{ad,da}?s?b" -compact
168 .It Pa /dev/{ad,da}?s?b
169 standard paging devices
171 vnode disk paging device
173 ASCII filesystem description table
175 ASCII vnode file table
178 These utilities may fail for the reasons described in
196 utilities appeared in
198 and were later ported to