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 .\" 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.
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.2 8.1 (Berkeley) 6/4/93
35 .Nd control devices for interleaved paging/swapping
43 .Fn swapon "const char *special"
45 .Fn swapoff "const char *special" "u_int flags"
50 makes the block device
52 available to the system for
53 allocation for paging and swapping.
54 The names of potentially
55 available devices are known to the system and defined at system
57 The size of the swap area on
59 is calculated at the time the device is first made available
64 system call disables paging and swapping on the given device.
65 All associated swap metadata are deallocated, and the device
66 is made available for other purposes.
70 argument points to the name of the device or file used for swapping.
73 argument takes the following flags:
74 .Bl -tag -width SWAPOFF_FORCE
76 Overrides a very conservative check that prevents swapoff
77 if the total amount of free memory and remaining swap
78 devices space might be unsufficient for the system to continue
82 If an error has occurred, a value of -1 is returned and
84 is set to indicate the error.
93 A component of the path prefix is not a directory.
94 .It Bq Er ENAMETOOLONG
95 A component of a pathname exceeded 255 characters,
96 or an entire path name exceeded 1023 characters.
98 The named device does not exist.
100 Search permission is denied for a component of the path prefix.
102 Too many symbolic links were encountered in translating the pathname.
104 The caller is not the super-user.
109 points outside the process's allocated address space.
114 can fail for the following reasons:
120 is not a block device.
122 The device specified by
125 been made available for swapping
127 The major device number of
129 is out of range (this indicates no device driver exists
130 for the associated hardware).
132 An I/O error occurred while opening the swap device.
134 Corrupted data was detected while reading from the file system to open the
143 The system is not currently swapping to
146 Not enough virtual memory is available to safely disable
147 paging and swapping to the given device.
156 system call appeared in
160 system call appeared in