Merge branch 'master' of git://github.com/illumos/illumos-gate
[unleashed.git] / usr / src / man / man5 / largefile.5
blob8c451b01933704bf74f860f4aba499ef3cb9c15e
1 '\" te
2 .\"  Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved
3 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
4 .\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
5 .\" 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
6 .\" or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add
7 .\" 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]
8 .TH LARGEFILE 5 "Sep 8, 2015"
9 .SH NAME
10 largefile \- large file status of utilities
11 .SH DESCRIPTION
12 .LP
13 A \fIlarge file\fR is a regular file whose size is greater than or equal to 2
14 Gbyte ( 2^31 bytes). A \fIsmall file\fR is a regular file whose size is less
15 than 2 Gbyte.
16 .SS "Large file aware utilities"
17 .LP
18 A utility is called \fIlarge file aware\fR if it can process large files in the
19 same manner as it does small files. A utility that is large file aware is able
20 to handle large files as input and generate as output large files that are
21 being processed. The exception is where additional files  are used as system
22 configuration files or support files that can augment the processing. For
23 example, the \fBfile\fR utility supports the \fB-m\fR option for an alternative
24 "magic" file and the \fB-f\fR option for a support file that can contain a list
25 of file names. It is unspecified whether a utility that is large file aware
26 will accept configuration or support files that are large files. If a large
27 file aware utility does not accept configuration or support files that are
28 large files, it will cause no data loss or corruption upon encountering such
29 files and will return an appropriate error.
30 .LP
31 The following \fB/usr/bin\fR utilities are large file aware:
32 .sp
34 .sp
35 .TS
36 l l l l l
37 l l l l l .
38 \fBadb\fR       \fBaliasadm\fR  \fBawk\fR       \fBbdiff\fR     \fBcat\fR
39 \fBchgrp\fR     \fBchmod\fR     \fBchown\fR     \fBcksum\fR     \fBcmp\fR
40 \fBcompress\fR  \fBcp\fR        \fBcsh\fR       \fBcsplit\fR    \fBcut\fR
41 \fBdd\fR        \fBdircmp\fR    \fBdu\fR        \fBegrep\fR     \fBfgrep\fR
42 \fBfile\fR      \fBfind\fR      \fBftp\fR       \fBgetconf\fR   \fBgrep\fR
43 \fBgzip\fR      \fBhead\fR      \fBjoin\fR      \fBjsh\fR       \fBksh\fR
44 \fBksh93\fR     \fBln\fR        \fBls\fR        \fBmailcompat\fR        \fBmailstats\fR
45 \fBmdb\fR       \fBmkdir\fR     \fBmkfifo\fR    \fBmore\fR      \fBmv\fR
46 \fBnawk\fR      \fBpage\fR      \fBpaste\fR     \fBpathchck\fR  \fBpg\fR
47 \fBpraliases\fR \fBrcp\fR       \fBremsh\fR     \fBrksh\fR      \fBrksh93\fR
48 \fBrm\fR        \fBrmdir\fR     \fBrsh\fR       \fBsed\fR       \fBsh\fR
49 \fBsort\fR      \fBsplit\fR     \fBsum\fR       \fBtail\fR      \fBtar\fR
50 \fBtee\fR       \fBtest\fR      \fBtouch\fR     \fBtr\fR        \fBuncompress\fR
51 \fBuudcode\fR   \fBuuencode\fR  \fBvacation\fR  \fBwc\fR        \fBzcat\fR
52 .TE
54 .LP
55 The following \fB/usr/xpg4/bin\fR utilities are large file aware:
56 .sp
58 .sp
59 .TS
60 l l l l l
61 l l l l l .
62 \fBawk\fR       \fBcp\fR        \fBchgrp\fR     \fBchown\fR     \fBdu\fR
63 \fBegrep\fR     \fBfgrep\fR     \fBfile\fR      \fBgrep\fR      \fBln\fR
64 \fBls\fR        \fBmore\fR      \fBmv\fR        \fBrm\fR        \fBsed\fR
65 \fBsh\fR        sort    tail    tr      
66 .TE
68 .LP
69 The following \fB/usr/xpg6/bin\fR utilities are large file aware:
70 .sp
72 .sp
73 .TS
74 l l l l l .
75 \fBgetconf\fR   \fBls\fR        \fBtr\fR                
76 .TE
78 .LP
79 The following \fB/usr/sbin\fR utilities are large file aware:
80 .sp
82 .sp
83 .TS
84 l l l l l
85 l l l l l .
86 \fBeditmap\fR   \fBinstall\fR   \fBmakemap\fR   \fBmkfile\fR    \fBmknod\fR
87 \fBmvdir\fR     \fBswap\fR                      
88 .TE
90 .LP
91 See the USAGE section of the \fBswap\fR(1M) manual page for limitations of
92 \fBswap\fR on block devices greater than 2 Gbyte on a 32-bit operating system.
93 .sp
95 The \fB/usr/bin/cpio\fR and \fB/usr/bin/pax\fR utilities are large file aware,
96 but cannot archive a file whose size exceeds 8 Gbyte - 1 byte.
97 .LP
98 The \fB/usr/bin/truss\fR utilities has been modified to read a dump file and
99 display information relevant to large files, such as offsets.
100 .SS "nfs file systems"
102 The following utilities are large file aware for \fBnfs\fR file systems:
107 l l
108 l l .
109 \fB/usr/lib/autofs/automountd\fR        \fB/usr/sbin/mount\fR
110 \fB/usr/lib/nfs/rquotad\fR      
113 .SS "ufs file systems"
115 The following \fB/usr/bin\fR utility is large file aware for \fBufs\fR file
116 systems:
118 \fBdf\fR
120 The following \fB/usr/lib/nfs\fR utility is large file aware for \fBufs\fR file
121 systems:
123 \fBrquotad\fR
125 The following \fB/usr/xpg4/bin\fR utility is large file aware for \fBufs\fR
126 file systems:
128 \fBdf\fR
130 The following \fB/usr/sbin\fR utilities are large file aware for \fBufs\fR file
131 systems:
136 l l l l l
137 l l l l l .
138 \fBclri\fR      \fBdcopy\fR     \fBedquota\fR   \fBff\fR        \fBfsck\fR
139 \fBfsdb\fR      \fBfsirand\fR   \fBfstyp\fR     \fBlabelit\fR   \fBlockfs\fR
140 \fBmkfs\fR      \fBmount\fR     \fBncheck\fR    \fBnewfs\fR     \fBquot\fR
141 \fBquota\fR     \fBquotacheck\fR        \fBquotaoff\fR  \fBquotaon\fR   \fBrepquota\fR
142 \fBtunefs\fR    \fBufsdump\fR   \fBufsrestore\fR        \fBumount\fR    
145 .SS "Large file safe utilities"
147 A utility is called \fBlarge file safe\fR if it causes no data loss or
148 corruption when it encounters a large file. A utility that is large file safe
149 is unable to process properly a large file, but returns an appropriate error.
151 The following \fB/usr/bin\fR utilities are large file safe:
156 l l l l l
157 l l l l l .
158 \fBaudioconvert\fR      \fBaudioplay\fR \fBaudiorecord\fR       \fBcomm\fR      \fBdiff\fR
159 \fBdiff3\fR     \fBdiffmk\fR    \fBed\fR        \fBlp\fR        \fBmail\fR
160 \fBmailcompat\fR        \fBmailstats\fR \fBmailx\fR     \fBpack\fR      \fBpcat\fR
161 \fBred\fR       \fBrmail\fR     \fBsdiff\fR     \fBunpack\fR    \fBvi\fR
162 \fBview\fR                              
166 The following \fB/usr/xpg4/bin\fR utilities are large file safe:
171 l l l l l .
172 \fBed\fR        \fBvi\fR        \fBview\fR              
176 The following \fB/usr/xpg6/bin\fR utility is large file safe:
181 l l l l l .
182 \fBed\fR                                
186 The following \fB/usr/sbin\fR utilities are large file safe:
191 l l l l l .
192 lpfilter                lpforms                 
195 .SH SEE ALSO
197 \fBlf64\fR(5), \fBlfcompile\fR(5), \fBlfcompile64\fR(5)