raw/man8/swapon.8

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" 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    6.3 (Berkeley) 3/16/91
  33 .\"
  34 .\" Sun Dec 27 12:31:30 1992: Modified by faith@cs.unc.edu
  35 .\" Sat Mar  6 20:46:02 1993: Modified by faith@cs.unc.edu
  36 .\" Sat Oct  9 09:35:30 1993: Converted to man format by faith@cs.unc.edu
  37 .\" Sat Nov 27 20:22:42 1993: Updated authorship information, faith@cs.unc.edu
  38 .\" Mon Sep 25 14:12:38 1995: Added -v and -p information
  39 .\" Tue Apr 30 03:32:07 1996: Added some text from A. Koppenhoefer
  40 .\"
  41 .TH SWAPON 8 "25 September 1995" "Linux 1.x" "Linux Programmer's Manual"
  42 .SH NAME
  43 swapon, swapoff \- enable/disable devices and files for paging and swapping
  44 .SH SYNOPSIS
  45 .B /sbin/swapon [\-h \-V]
  46 .br
  47 .B /sbin/swapon \-a [\-v] [\-e]
  48 .br
  49 .BI "/sbin/swapon [\-v] [\-p " "priority" "] " " specialfile " ...
  50 .br
  51 .B /sbin/swapon [\-s]
  52 .br
  53 .B /sbin/swapoff [\-h \-V]
  54 .br
  55 .B /sbin/swapoff \-a
  56 .br
  57 .BI /sbin/swapoff " specialfile " ...
  58 .SH DESCRIPTION
  59 .B Swapon
  60 is used to specify devices on which paging and swapping are to take place.
  61 Calls to
  62 .B swapon
  63 normally occur in the system multi-user initialization file
  64 .I /etc/rc
  65 making all swap devices available, so that the paging and swapping activity
  66 is interleaved across several devices and files.
  67
  68 Normally, the first form is used:
  69 .TP
  70 .B \-h
  71 Provide help
  72 .TP
  73 .B \-V
  74 Display version
  75 .TP
  76 .B \-s
  77 Display swap usage summary by device. Equivalent to "cat /proc/swaps".
  78 Not available before Linux 2.1.25.
  79 .TP
  80 .B \-a
  81 All devices marked as ``swap'' swap devices in
  82 .I /etc/fstab
  83 are made available. Devices that are already running as swap are silently
  84 skipped.
  85 .TP
  86 .B \-e
  87 When
  88 .B \-a
  89 is used with swapon,
  90 .B
  91 \-e
  92 makes swapon silently skip devices that
  93 do not exist.
  94 .TP
  95 .BI \-p " priority"
  96 Specify priority for
  97 .BR swapon .
  98 This option is only available if
  99 .B swapon
 100 was compiled under and is used under a 1.3.2 or later kernel.
 101 .I priority
 102 is a value between 0 and 32767. See
 103 .BR swapon (2)
 104 for a full description of swap priorities. Add
 105 .BI pri= value
 106 to the option field of
 107 .I /etc/fstab
 108 for use with
 109 .BR "swapon -a" .
 110 .PP
 111 .B Swapoff
 112 disables swapping on the specified devices and files.
 113 When the
 114 .B \-a
 115 flag is given, swapping is disabled on all known swap devices and files
 116 (as found in
 117 .I /proc/swaps
 118 or
 119 .IR /etc/fstab ).
 120 .SH NOTE
 121 You should not use
 122 .B swapon
 123 on a file with holes.
 124 Swap over NFS may not work.
 125 .SH SEE ALSO
 126 .BR swapon (2),
 127 .BR swapoff (2),
 128 .BR fstab (5),
 129 .BR init (8),
 130 .BR mkswap (8),
 131 .BR rc (8),
 132 .BR mount (8)
 133 .SH FILES
 134 .I /dev/hd??
 135 standard paging devices
 136 .br
 137 .I /dev/sd??
 138 standard (SCSI) paging devices
 139 .br
 140 .I /etc/fstab
 141 ascii filesystem description table
 142 .SH HISTORY
 143 The
 144 .B swapon
 145 command appeared in 4.0BSD.