mkswap: tweak the man page
Note that option -v0 is obsolete, and remove the now unneeded comment about new-style swap areas. Further doublespace sentences, add some commas and articles, and alphabetize the options. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
This commit is contained in:
parent
a1939d7080
commit
83ff3782a3
|
@ -27,7 +27,7 @@ The
|
||||||
argument will usually be a disk partition (something like
|
argument will usually be a disk partition (something like
|
||||||
.IR /dev/sdb7 )
|
.IR /dev/sdb7 )
|
||||||
but can also be a file.
|
but can also be a file.
|
||||||
The Linux kernel does not look at partition Id's, but
|
The Linux kernel does not look at partition IDs, but
|
||||||
many installation scripts will assume that partitions
|
many installation scripts will assume that partitions
|
||||||
of hex type 82 (LINUX_SWAP) are meant to be swap partitions.
|
of hex type 82 (LINUX_SWAP) are meant to be swap partitions.
|
||||||
(\fBWarning: Solaris also uses this type. Be careful not to kill
|
(\fBWarning: Solaris also uses this type. Be careful not to kill
|
||||||
|
@ -39,7 +39,7 @@ parameter is superfluous but retained for backwards compatibility.
|
||||||
(It specifies the desired size of the swap area in 1024-byte blocks.
|
(It specifies the desired size of the swap area in 1024-byte blocks.
|
||||||
.B mkswap
|
.B mkswap
|
||||||
will use the entire partition or file if it is omitted.
|
will use the entire partition or file if it is omitted.
|
||||||
Specifying it is unwise - a typo may destroy your disk.)
|
Specifying it is unwise -- a typo may destroy your disk.)
|
||||||
|
|
||||||
The
|
The
|
||||||
.I PSZ
|
.I PSZ
|
||||||
|
@ -63,15 +63,15 @@ command in some boot script.
|
||||||
|
|
||||||
.SH WARNING
|
.SH WARNING
|
||||||
The swap header does not touch the first block. A boot loader or disk label
|
The swap header does not touch the first block. A boot loader or disk label
|
||||||
can be there, but it is not recommended setup. The recommended setup is to
|
can be there, but it is not a recommended setup. The recommended setup is to
|
||||||
use a separate partition for a Linux swap area.
|
use a separate partition for a Linux swap area.
|
||||||
|
|
||||||
.B mkswap like many others mkfs-like utils erases the first block to remove
|
.B mkswap, like many others mkfs-like utils, erases the first block to remove
|
||||||
.B old on-disk filesystems.
|
.B old on-disk filesystems.
|
||||||
|
|
||||||
.B mkswap
|
.B mkswap
|
||||||
refuses to erase the first block on a device with a disk
|
refuses to erase the first block on a device with a disk
|
||||||
label (SUN, BSD, ...) or on whole disk (e.g. /dev/sda).
|
label (SUN, BSD, ...) or on a whole disk (e.g. /dev/sda).
|
||||||
|
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.TP
|
.TP
|
||||||
|
@ -81,45 +81,45 @@ before creating the swap area.
|
||||||
If any are found, the count is printed.
|
If any are found, the count is printed.
|
||||||
.TP
|
.TP
|
||||||
.B \-f
|
.B \-f
|
||||||
Force - go ahead even if the command is stupid.
|
Force -- go ahead even if the command is stupid.
|
||||||
This allows the creation of a swap area larger than the file
|
This allows the creation of a swap area larger than the file
|
||||||
or partition it resides on.
|
or partition it resides on.
|
||||||
|
|
||||||
Without this option
|
Without this option,
|
||||||
.B mkswap
|
.B mkswap
|
||||||
will refuse to erase the first block on a device with a partition table or on
|
will refuse to erase the first block on a device with a partition table or on
|
||||||
whole disk (e.g. /dec/sda).
|
a whole disk (e.g. /dev/sda).
|
||||||
.TP
|
|
||||||
.BI \-p \ PSZ
|
|
||||||
Specify the page size in bytes to use. This option is usually unnecessary,
|
|
||||||
.B mkswap
|
|
||||||
reads the size from kernel.
|
|
||||||
.TP
|
.TP
|
||||||
.BI \-L \ label
|
.BI \-L \ label
|
||||||
Specify a label, to allow swapon by label.
|
Specify a label, to allow
|
||||||
(Only for new style swap areas.)
|
.B swapon
|
||||||
|
by label.
|
||||||
.TP
|
.TP
|
||||||
.BR \-v0 , \ \-v1
|
.BI \-p \ PSZ
|
||||||
Specify the swap space version. This option is deprecated and \-v1 is
|
Specify the page size (in bytes) to use. This option is usually unnecessary,
|
||||||
supported only.
|
.B mkswap
|
||||||
|
reads the size from the kernel.
|
||||||
The kernel has not supported v0 swap space format since 2.5.22. The new version
|
|
||||||
v1 is supported since 2.1.117.
|
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI \-U \ uuid
|
.BI \-U \ uuid
|
||||||
Specify the uuid to use. The default is to generate UUIDs.
|
Specify the uuid to use. The default is to generate a UUID.
|
||||||
|
.TP
|
||||||
|
.BR \-v1
|
||||||
|
Specify the swap-space version. The old \-v0 option has become obsolete
|
||||||
|
and now only \-v1 is supported.
|
||||||
|
|
||||||
|
The kernel has not supported v0 swap-space format since 2.5.22.
|
||||||
|
The new version v1 is supported since 2.1.117.
|
||||||
|
|
||||||
.SH NOTES
|
.SH NOTES
|
||||||
The maximum useful size of a swap area depends on the architecture and
|
The maximum useful size of a swap area depends on the architecture and
|
||||||
the kernel version.
|
the kernel version.
|
||||||
It is roughly 2GiB on i386, PPC, m68k, ARM, 1GiB on sparc, 512MiB on mips,
|
It is roughly 2GiB on i386, PPC, m68k and ARM, 1GiB on sparc, 512MiB on mips,
|
||||||
128GiB on alpha and 3TiB on sparc64. For kernels after 2.3.3 there is no
|
128GiB on alpha, and 3TiB on sparc64. For kernels after 2.3.3 there is no
|
||||||
such limitation.
|
such limitation.
|
||||||
|
|
||||||
Note that before 2.1.117 the kernel allocated one byte for each page,
|
Note that before version 2.1.117 the kernel allocated one byte for each page,
|
||||||
while it now allocates two bytes, so that taking a swap area of 2 GiB
|
while it now allocates two bytes, so that taking into use a swap area of 2 GiB
|
||||||
in use might require 2 MiB of kernel memory.
|
might require 2 MiB of kernel memory.
|
||||||
|
|
||||||
Presently, Linux allows 32 swap areas (this was 8 before Linux 2.4.10).
|
Presently, Linux allows 32 swap areas (this was 8 before Linux 2.4.10).
|
||||||
The areas in use can be seen in the file
|
The areas in use can be seen in the file
|
||||||
|
@ -130,10 +130,10 @@ The areas in use can be seen in the file
|
||||||
refuses areas smaller than 10 pages.
|
refuses areas smaller than 10 pages.
|
||||||
|
|
||||||
If you don't know the page size that your machine uses, you may be
|
If you don't know the page size that your machine uses, you may be
|
||||||
able to look it up with "cat /proc/cpuinfo" (or you may not -
|
able to look it up with "cat /proc/cpuinfo" (or you may not --
|
||||||
the contents of this file depend on architecture and kernel version).
|
the contents of this file depend on architecture and kernel version).
|
||||||
|
|
||||||
To setup a swap file, it is necessary to create that file before
|
To set up a swap file, it is necessary to create that file before
|
||||||
initializing it with
|
initializing it with
|
||||||
.BR mkswap ,
|
.BR mkswap ,
|
||||||
e.g. using a command like
|
e.g. using a command like
|
||||||
|
|
Loading…
Reference in New Issue