teach manpages about largefile's demise
[unleashed.git] / share / man / man8 / mkfile.8
bloba0e4c14259662865488ee490c673a74f304fceb1
1 '\" te
2 .\"  Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH MKFILE 8 "Feb 20, 2008"
7 .SH NAME
8 mkfile \- create a file
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBmkfile\fR [\fB-nv\fR] \fIsize\fR [g | k | b | m] \fIfilename\fR...
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fBmkfile\fR creates one or more files that are suitable for use as
19 \fBNFS-mounted\fR swap areas, or as local swap areas. When a root user executes
20 \fBmkfile()\fR, the sticky bit is set and the file is padded with zeros by
21 default.   When non-root users execute  \fBmkfile()\fR, they must manually set
22 the sticky bit using  \fBchmod\fR(1). The default \fBsize\fR is in bytes, but
23 it can be flagged as gigabytes, kilobytes, blocks, or megabytes, with the
24 \fBg\fR, \fBk\fR, \fBb\fR, or \fBm\fR suffixes, respectively.
25 .SH OPTIONS
26 .sp
27 .ne 2
28 .na
29 \fB\fB-n\fR\fR
30 .ad
31 .RS 6n
32 Create an empty \fIfilename\fR. The size is noted, but disk blocks are not
33 allocated until data is written to them. Files created with this option cannot
34 be swapped over local UFS mounts.
35 .RE
37 .sp
38 .ne 2
39 .na
40 \fB\fB-v\fR\fR
41 .ad
42 .RS 6n
43 Verbose.  Report the names and sizes of created files.
44 .RE
46 .SH EXIT STATUS
47 .sp
48 .LP
49 The following exit values are returned:
50 .sp
51 .ne 2
52 .na
53 \fB\fB0\fR\fR
54 .ad
55 .RS 6n
56 Success.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fB>0\fR\fR
63 .ad
64 .RS 6n
65 An error occurred.
66 .RE
68 .SH ATTRIBUTES
69 .sp
70 .LP
71 See \fBattributes\fR(5) for descriptions of the following attributes:
72 .sp
74 .sp
75 .TS
76 box;
77 c | c
78 l | l .
79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
81 Interface Stability     Committed
82 .TE
84 .SH SEE ALSO
85 .sp
86 .LP
87 \fBchmod\fR(1), \fBswap\fR(8), \fBattributes\fR(5)