'\" te
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 2008, 2015, Oracle and/or its affiliates. All    rights reserved.
.TH swap 1M "11 Feb 2015" "SunOS 5.11" "System Administration Commands"
.SH NAME
swap \- swap administrative interface
.SH SYNOPSIS
.LP
.nf
\fB/usr/sbin/swap\fR \fB-a\fR \fIswapname\fR [\fIswaplow\fR] [\fIswaplen\fR]
.fi

.LP
.nf
\fB/usr/sbin/swap\fR \fB-d\fR \fIswapname\fR [\fIswaplow\fR]
.fi

.LP
.nf
\fB/usr/sbin/swap\fR \fB-l\fR [\fB-h\fR | \fB-k\fR]
.fi

.LP
.nf
\fB/usr/sbin/swap\fR \fB-s\fR [\fB-h\fR]
.fi

.SH DESCRIPTION
.sp
.LP
The \fBswap\fR utility provides a method of adding, deleting, and monitoring the system swap areas used by the memory manager.
.SH OPTIONS
.sp
.LP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-a\fR \fIswapname\fR [\fIswaplow\fR] [\fIswaplen\fR]\fR
.ad
.sp .6
.RS 4n
Add the specified swap area. This option can only be used by  an administrator who is assigned the File System Management rights profile or by root. \fIswapname\fR is the name of the swap area or regular file. For example, on system running a UFS root file system, specify a slice, such as \fB/dev/dsk/c0t0d0s1\fR, or a regular file for a swap area. On a system running a ZFS file system, specify a ZFS volume, such as \fB/dev/zvol/dsk/rpool/swap\fR, for a swap area. Using a regular file for swap is not supported on a ZFS file system. In addition, you cannot use the same ZFS volume for both the swap area and a dump device when the system is running a ZFS root file system.
.sp
\fIswaplow\fR is the offset in 512-byte blocks into the file where the swap area should begin. \fIswaplen\fR is the desired length of the swap area in 512-byte blocks. The value of \fIswaplen\fR can not be less than \fB16\fR. For example, if \fIn\fR blocks are specified, then (\fIn\fR-1) blocks would be the actual swap length. \fIswaplen\fR must be at least one page in length. The size of a page of memory can be determined by using the \fBpagesize\fR command. See \fBpagesize\fR(1). Since the first page of a swap file is automatically skipped, and a swap file needs to be at least one page in length, the minimum size should be a multiple of 2 pagesize bytes. The size of a page of memory is machine-dependent.
.sp
\fIswaplow\fR + \fIswaplen\fR must be less than or equal to the size of the swap file. If \fIswaplen\fR is not specified, an area will be added starting at \fIswaplow\fR and extending to the end of the designated file. If neither \fIswaplow\fR nor \fIswaplen\fR are specified, the whole file will be used except for the first page. Swap areas are normally added automatically during system startup by the \fB/usr/sbin/swapadd\fR script. This script adds all swap areas which have been specified in the \fB/etc/vfstab\fR file; for the syntax of these specifications, see \fBvfstab\fR(4).
.sp
You can encrypt a ZFS volume used as a swap device by specifying the \fBencrypted\fR option in \fBvfstab\fR(4) and specifying the \fBencryption\fR property for the ZFS volume. See \fBzfs\fR(1M).
.sp
To use an \fBNFS\fR or local file system \fIswapname\fR, you should first create a file using \fBmkfile\fR(1M). A local file system swap file can now be added to the running system by just running the \fBswap\fR \fB-a\fR command. For \fBNFS\fR mounted swap files, the server needs to export the directory containing the file. Do this by performing the following steps:
.RS +4
.TP
1.
Set sticky bit on the new swap file created with \fBmkfile\fR(1M):
.sp
.in +2
.nf
# \fBchmod 1600 path-to-swap-file\fR
.fi
.in -2
.sp

.RE
.RS +4
.TP
2.
Run this on NFS server:
.sp
.in +2
.nf
share -F nfs -o \ 
rw=clientname,root=clientname directory-with-swap-file 
.fi
.in -2

.RE
.RS +4
.TP
3.
Have the client add the following lines to \fB/etc/vfstab\fR:
.sp
.in +2
.nf
server:directory-with-swap-file -   
local-path-to-directory nfs    -   yes   - 
local-path-to-directory/swap-file -  -           
swap   - no    - 
.fi
.in -2

.RE
.RS +4
.TP
4.
Enable NFS client service on the client:
.sp
.in +2
.nf
svcadm enable nfs/client
.fi
.in -2

.RE
.RS +4
.TP
5.
Reboot the client.
.RE
.RE

.sp
.ne 2
.mk
.na
\fB\fB-d\fR \fIswapname\fR\fR
.ad
.sp .6
.RS 4n
Delete the specified swap area. This option can only be used by the super-user. \fIswapname\fR is the name of the swap file: for example, \fB/dev/dsk/c0t0d0s1\fR or a regular file. \fIswaplow\fR is the offset in 512-byte blocks into the swap area to be deleted. If \fIswaplow\fR is not specified, the area will be deleted starting at the second page. When the command completes, swap blocks can no longer be allocated from this area and all swap blocks previously in use in this swap area have been moved to other swap areas.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-h\fR\fR
.ad
.sp .6
.RS 4n
All sizes are scaled to a human readable format. Scaling is done by repetitively dividing by 1024.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-k\fR\fR
.ad
.sp .6
.RS 4n
Write the files sizes in units of 1024 bytes.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-l\fR\fR
.ad
.sp .6
.RS 4n
List the status of all the swap areas. The output has five columns:
.sp
.ne 2
.mk
.na
\fB\fBpath\fR\fR
.ad
.sp .6
.RS 4n
The path name for the swap area.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdev\fR\fR
.ad
.sp .6
.RS 4n
The major/minor device number in decimal if it is a block special device; zeroes otherwise.
.RE

.sp
.ne 2
.mk
.na
\fB\fBswaplo\fR\fR
.ad
.sp .6
.RS 4n
The \fIswaplow\fR value for the area in 512-byte blocks.
.RE

.sp
.ne 2
.mk
.na
\fB\fBblocks\fR\fR
.ad
.sp .6
.RS 4n
The \fIswaplen\fR value for the area in 512-byte blocks.
.RE

.sp
.ne 2
.mk
.na
\fB\fBfree\fR\fR
.ad
.sp .6
.RS 4n
The number of 512-byte blocks in this area that are not currently allocated.
.RE

The list does not include swap space in the form of physical memory because this space is not associated with a particular swap area.
.sp
If \fBswap\fR \fB-l\fR is run while \fIswapname\fR is in the process of being deleted (by \fBswap\fR\fB-d\fR), the string \fBINDEL\fR will appear in a sixth column of the swap stats.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-s\fR\fR
.ad
.sp .6
.RS 4n
Print summary information about total swap space usage and availability:
.sp
.ne 2
.mk
.na
\fB\fBallocated\fR\fR
.ad
.sp .6
.RS 4n
The total amount of swap space in bytes currently allocated for use as backing store.
.RE

.sp
.ne 2
.mk
.na
\fB\fBreserved\fR\fR
.ad
.sp .6
.RS 4n
The total amount of swap space in bytes not currently allocated, but claimed by memory mappings for possible future use.
.RE

.sp
.ne 2
.mk
.na
\fB\fBused\fR\fR
.ad
.sp .6
.RS 4n
The total amount of swap space in bytes that is either allocated or reserved.
.RE

.sp
.ne 2
.mk
.na
\fB\fBavailable\fR\fR
.ad
.sp .6
.RS 4n
The total swap space in bytes that is currently available for future reservation and allocation.
.RE

These numbers include swap space from all configured swap areas as listed by the \fB-l\fR option, as well swap space in the form of physical memory.
.RE

.SH USAGE
.sp
.LP
A block device larger than 2 Gbytes can be fully utilized for swap up to 2^63 \(mi1 bytes.
.SH ENVIRONMENT VARIABLES
.sp
.LP
See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBswap\fR: \fBLC_CTYPE\fR and \fBLC_MESSAGE\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/core-os
.TE

.SH SEE ALSO
.sp
.LP
\fBpagesize\fR(1), \fBmkfile\fR(1M), \fBshareall\fR(1M), \fBzfs\fR(1M), \fBgetpagesize\fR(3C), \fBvfstab\fR(4), \fBattributes\fR(5), \fBlargefile\fR(5)
.SH NOTES
.sp
.LP
For information about setting up a swap area with \fBZFS\fR, see the \fIZFS Administration Guide\fR.
.SH WARNINGS
.sp
.LP
No check is done to determine if a swap area being added overlaps with an existing file system.