freebsd-dev/sbin/swapon/swapon.8

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)swapon.8	8.1 (Berkeley) 6/5/93
.\" $FreeBSD$
.\"
.Dd June 5, 1993
.Dt SWAPON 8
.Os BSD 4
.Sh NAME
.Nm swapon
.Nd "specify additional device for paging and swapping"
.Sh SYNOPSIS
.Nm swapon
.Fl a
.Nm swapon
.Ar special_file ...
.Sh DESCRIPTION
.Nm Swapon
is used to specify additional devices on which paging and swapping
are to take place.
The system begins by swapping and paging on only a single device
so that only one disk is required at bootstrap time.
Calls to
.Nm
normally occur in the system multi-user initialization file
.Pa /etc/rc
making all swap devices available, so that the paging and swapping
activity is interleaved across several devices.
.Pp
Normally, the first form is used:
.Bl -tag -width indent
.It Fl a
All devices marked as ``sw''
swap devices in
.Pa /etc/fstab
are made available unless their ``noauto'' option is also set.
.El
.Pp
The second form gives individual block devices as given
in the system swap configuration table.  The call makes only this space
available to the system for swap allocation.
.Sh SEE ALSO
.Xr swapon 2 ,
.Xr fstab 5 ,
.Xr init 8 ,
.Xr pstat 8 ,
.Xr rc 8 ,
.Xr vnconfig 8
.Sh FILES
.Bl -tag -width "/dev/{wd,da}?s?b" -compact
.It Pa /dev/{wd,da}?s?b
standard paging devices
.It Pa /dev/vn0b
vnode disk paging device
.It Pa /etc/fstab
ASCII filesystem description table
.It Pa /etc/vntab
ASCII vnode file table
.El
.Sh BUGS
There is no way to stop paging and swapping on a device.
It is therefore not possible to make use of devices which may be
dismounted during system operation.
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.0 .
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\" Copyright (c) 1980, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)swapon.8 8.1 (Berkeley) 6/5/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\"`
			`.Dd June 5, 1993`
			`.Dt SWAPON 8`
			`.Os BSD 4`
			`.Sh NAME`
			`.Nm swapon`
			`.Nd "specify additional device for paging and swapping"`
			`.Sh SYNOPSIS`
			`.Nm swapon`
			`.Fl a`
			`.Nm swapon`
			`.Ar special_file ...`
			`.Sh DESCRIPTION`
			`.Nm Swapon`
			`is used to specify additional devices on which paging and swapping`
			`are to take place.`
			`The system begins by swapping and paging on only a single device`
			`so that only one disk is required at bootstrap time.`
			`Calls to`
.Nm swapon -> .Nm. Sort #includes. Add rcsid. 1998-08-03 06:35:01 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`normally occur in the system multi-user initialization file`
			`.Pa /etc/rc`
			`making all swap devices available, so that the paging and swapping`
			`activity is interleaved across several devices.`
			`.Pp`
			`Normally, the first form is used:`
.Nm swapon -> .Nm. Sort #includes. Add rcsid. 1998-08-03 06:35:01 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl a`
			All devices marked as ``sw''
			`swap devices in`
			`.Pa /etc/fstab`
Make the noauto flag usable for swap devices too. Closes PR#1542 Submitted-By: David Leonard <d@scry.dstc.edu.au> 1996-09-06 06:01:05 +00:00			are made available unless their ``noauto'' option is also set.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.El`
			`.Pp`
			`The second form gives individual block devices as given`
			`in the system swap configuration table. The call makes only this space`
			`available to the system for swap allocation.`
			`.Sh SEE ALSO`
			`.Xr swapon 2 ,`
add missing comma(s) in .Xr macros 1996-09-23 22:24:39 +00:00			`.Xr fstab 5 ,`
			`.Xr init 8 ,`
Revert last commit and SEE ALSO pstat(8) instead. Submitted by: Bruce Evans 1998-02-01 06:46:37 +00:00			`.Xr pstat 8 ,`
.Xr vnconfig 8. This was suggested by Dworkin Muller <dworkin@village.org> when he tried to figure out how to swap to a file and had to ask me for help. 1997-08-26 00:32:06 +00:00			`.Xr rc 8 ,`
			`.Xr vnconfig 8`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh FILES`
Refer to current names for swap partitions in the `FILES' section. PR: docs/11709 Submitted by: Matthew D. Fuller <fullermd@over-yonder.net> 1999-05-17 05:19:13 +00:00			`.Bl -tag -width "/dev/{wd,da}?s?b" -compact`
			`.It Pa /dev/{wd,da}?s?b`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`standard paging devices`
Mention /dev/vn0b and /dev/vntab. ascii -> ASCII transform had already happened in an earlier commit. PR: docs/13645 Submitted by: Stephen Roznowski <sjr@home.com> 1999-09-26 00:05:45 +00:00			`.It Pa /dev/vn0b`
			`vnode disk paging device`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Pa /etc/fstab`
Correct spelling : ascii -> ASCII PR: docs/13702 Submitted by: Stephen J. Roznowski <sjr@home.com> Reviewed by: mpp 1999-09-20 09:15:23 +00:00			`ASCII filesystem description table`
Mention /dev/vn0b and /dev/vntab. ascii -> ASCII transform had already happened in an earlier commit. PR: docs/13645 Submitted by: Stephen Roznowski <sjr@home.com> 1999-09-26 00:05:45 +00:00			`.It Pa /etc/vntab`
			`ASCII vnode file table`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.El`
			`.Sh BUGS`
			`There is no way to stop paging and swapping on a device.`
			`It is therefore not possible to make use of devices which may be`
			`dismounted during system operation.`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.0 .`