shithub: riscv

ref: ccf72da47d29772af51b0b348d2845fbbbd8a881
dir: /sys/man/8/swap/

View raw version
.TH SWAP 8
.SH NAME
swap \- establish a swap file
.SH SYNOPSIS
.B swap
.I file 
.SH DESCRIPTION
.I Swap
establishes a file for the system to swap on.
If
.I file
is an existing file, it is used for system swap. If it
does not exist, a new file is created. If
.I file
is a directory, a unique file is created in that directory
on which to swap.
The environment variable
.B swap
is set to the full name of the resulting file.
The number of blocks available in the file or device
must be at least the number of swap blocks configured
at system boot time.
.PP
If a swap channel has already been set and no blocks
are currently valid in the file the old file will be
closed and then replaced. If any blocks are valid on
the device an error is returned instead.
.SH SOURCE
.B /sys/src/cmd/swap.c
.SH BUGS
Swapping to a file served by a local user-level process
will lead to deadlock if the process isn't made non-swappable
(see the
.B noswap
ctl-message in
.IR proc (3)).
.SH "SEE ALSO"
.IR swap (3),
.IR proc (3)