| blob | a12f90c61a1e3adf54c2b2f5a0082b57d9ccacf0 |
1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions
5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/.
6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
7 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
8 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
9 .\" This notice shall appear on any product containing this material.
10 .\" 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 or http://www.opensolaris.org/os/licensing.
11 .\" 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 the following below this CDDL HEADER, with the
12 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
13 .TH DF 1M "Apr 14, 2016"
14 .SH NAME
15 df \- displays number of free disk blocks and free files
16 .SH SYNOPSIS
17 .LP
18 .nf
19 \fB/usr/bin/df\fR [\fB-F\fR \fIFSType\fR] [\fB-abeghklmnPtVvZ\fR]
20 [\fB-o\fR \fIFSType-specific_options\fR]
21 [\fIblock_device\fR | \fIdirectory\fR | \fIfile\fR | \fIresource\fR ...]
22 .fi
24 .SH DESCRIPTION
25 .LP
26 The \fBdf\fR utility displays the amount of disk space occupied by mounted or
27 unmounted file systems, the amount of used and available space, and how much of
28 the file system's total capacity has been used. The file system is specified by
29 device, or by referring to a file or directory on the specified file system.
30 .sp
31 .LP
32 Used without operands or options, \fBdf\fR reports on all mounted file systems.
33 .sp
34 .LP
35 \fBdf\fR may not be supported for all \fIFSTypes\fR.
36 .sp
37 .LP
38 If \fBdf\fR is run on a networked mount point that the automounter has not yet
39 mounted, the file system size will be reported as zero. As soon as the
40 automounter mounts the file system, the sizes will be reported correctly.
41 .SH OPTIONS
42 .ne 2
43 .na
44 \fB\fB-a\fR\fR
45 .ad
46 .sp .6
47 .RS 4n
48 Reports on all file systems including ones whose entries in \fB/etc/mnttab\fR
49 (see \fBmnttab\fR(4)) have the \fBignore\fR option set.
50 .RE
52 .sp
53 .ne 2
54 .na
55 \fB\fB-b\fR\fR
56 .ad
57 .sp .6
58 .RS 4n
59 Prints the total number of kilobytes free.
60 .RE
62 .sp
63 .ne 2
64 .na
65 \fB\fB-e\fR\fR
66 .ad
67 .sp .6
68 .RS 4n
69 Prints only the number of files free.
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fB-F\fR \fIFSType\fR\fR
76 .ad
77 .sp .6
78 .RS 4n
79 Specifies the \fIFSType\fR on which to operate. The \fB-F\fR option is intended
80 for use with unmounted file systems. The \fIFSType\fR should be specified here
81 or be determinable from \fB/etc/vfstab\fR (see \fBvfstab\fR(4)) by matching the
82 \fIdirectory\fR, \fIblock_device\fR, or \fIresource\fR with an entry in the
83 table, or by consulting \fB/etc/default/fs\fR. See \fBdefault_fs\fR(4).
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fB-g\fR\fR
90 .ad
91 .sp .6
92 .RS 4n
93 Prints the entire \fBstatvfs\fR(2) structure. This option is used only for
94 mounted file systems. It can not be used with the \fB-o\fR option. This option
95 overrides the \fB-b\fR, \fB-e\fR, \fB-k\fR, \fB-n\fR, \fB-P\fR, and \fB-t\fR
96 options.
97 .RE
99 .sp
100 .ne 2
101 .na
102 \fB\fB-h\fR\fR
103 .ad
104 .sp .6
105 .RS 4n
106 Like \fB-k\fR, except that sizes are in a more human readable format. The
107 output consists of one line of information for each specified file system. This
108 information includes the file system name, the total space allocated in the
109 file system, the amount of space allocated to existing files, the total amount
110 of space available for the creation of new files by unprivileged users, and the
111 percentage of normally available space that is currently allocated to all files
112 on the file system. All sizes are scaled to a human readable format, for
113 example, \fB14K\fR, \fB234M\fR, \fB2.7G\fR, or \fB3.0T\fR. Scaling is done by
114 repetitively dividing by \fB1024\fR.
115 .sp
116 This option overrides the \fB-b\fR, \fB-e\fR, \fB-g\fR, \fB-k\fR, \fB-n\fR,
117 \fB-t\fR, and \fB-V\fR options. This option only works on mounted filesystems
118 and can not be used together with \fB-o\fR option.
119 .RE
121 .sp
122 .ne 2
123 .na
124 \fB\fB-k\fR\fR
125 .ad
126 .sp .6
127 .RS 4n
128 Prints the allocation in kbytes. The output consists of one line of information
129 for each specified file system. This information includes the file system name,
130 the total space allocated in the file system, the amount of space allocated to
131 existing files, the total amount of space available for the creation of new
132 files by unprivileged users, and the percentage of normally available space
133 that is currently allocated to all files on the file system. This option
134 overrides the \fB-b\fR, \fB-e\fR, \fB-n\fR, and \fB-t\fR options.
135 .RE
137 .sp
138 .ne 2
139 .na
140 \fB\fB-l\fR\fR
141 .ad
142 .sp .6
143 .RS 4n
144 Reports on local file systems only. This option is used only for mounted file
145 systems. It can not be used with the \fB-o\fR option.
146 .RE
148 .sp
149 .ne 2
150 .na
151 \fB\fB-m\fR\fR
152 .ad
153 .sp .6
154 .RS 4n
155 Like -k, except prints the allocation in mbytes.
156 .RE
158 .sp
159 .ne 2
160 .na
161 \fB\fB-n\fR\fR
162 .ad
163 .sp .6
164 .RS 4n
165 Prints only the \fIFSType\fR name. Invoked with no operands, this option prints
166 a list of mounted file system types. This option is used only for mounted file
167 systems. It can not be used with the \fB-o\fR option.
168 .RE
170 .sp
171 .ne 2
172 .na
173 \fB\fB-o\fR \fIFSType-specific_options\fR\fR
174 .ad
175 .sp .6
176 .RS 4n
177 Specifies \fIFSType-specific\fR options. These options are comma-separated,
178 with no intervening spaces. See the manual page for the \fIFSType-specific\fR
179 command for details.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fB-t\fR\fR
186 .ad
187 .sp .6
188 .RS 4n
189 Prints full listings with totals. This option overrides the \fB-b\fR, \fB-e\fR,
190 and \fB-n\fR options.
191 .RE
193 .sp
194 .ne 2
195 .na
196 \fB\fB-V\fR\fR
197 .ad
198 .sp .6
199 .RS 4n
200 Echoes the complete set of file system specific command lines, but does not
201 execute them. The command line is generated by using the options and operands
202 provided by the user and adding to them information derived from
203 \fB/etc/mnttab\fR, \fB/etc/vfstab\fR, or \fB/etc/default/fs\fR. This option may
204 be used to verify and validate the command line.
205 .RE
207 .sp
208 .ne 2
209 .na
210 \fB\fB-Z\fR\fR
211 .ad
212 .sp .6
213 .RS 4n
214 Displays mounts in all visible zones. By default, \fBdf\fR only displays mounts
215 located within the current zone. This option has no effect in a non-global
216 zone.
217 .RE
219 .sp
220 .ne 2
221 .na
222 \fB\fB-v\fR\fR
223 .ad
224 .sp .6
225 .RS 4n
226 Like \fB-k\fR, except that sizes are displayed in multiples of the smallest
227 block size supported by each specified file system.
228 .sp
229 The output consists of one line of information for each file system. This one
230 line of information includes the following:
231 .RS +4
232 .TP
233 .ie t \(bu
234 .el o
235 the file system's mount point
236 .RE
237 .RS +4
238 .TP
239 .ie t \(bu
240 .el o
241 the file system's name
242 .RE
243 .RS +4
244 .TP
245 .ie t \(bu
246 .el o
247 the total number of blocks allocated to the file system
248 .RE
249 .RS +4
250 .TP
251 .ie t \(bu
252 .el o
253 the number of blocks allocated to existing files
254 .RE
255 .RS +4
256 .TP
257 .ie t \(bu
258 .el o
259 the number of blocks available for the creation of new files by unprivileged
260 users
261 .RE
262 .RS +4
263 .TP
264 .ie t \(bu
265 .el o
266 the percentage of blocks in use by files
267 .RE
268 .RE
270 .sp
271 .ne 2
272 .na
273 \fB\fB-P\fR\fR
274 .ad
275 .sp .6
276 .RS 4n
277 Same as \fB-h\fR except in 512-byte units.
278 .RE
280 .SH OPERANDS
281 .LP
282 The \fBdf\fR utility interprets operands according to the following precedence:
283 \fIblock_device\fR, \fIdirectory\fR, \fIfile\fR. The following operands are
284 supported:
285 .sp
286 .ne 2
287 .na
288 \fB\fIblock_device\fR\fR
289 .ad
290 .sp .6
291 .RS 4n
292 Represents a block special device (for example, \fB/dev/dsk/c1d0s7\fR).
293 .RE
295 .sp
296 .ne 2
297 .na
298 \fB\fIdirectory\fR\fR
299 .ad
300 .sp .6
301 .RS 4n
302 Represents a valid directory name. \fBdf\fR reports on the file system that
303 contains \fIdirectory\fR.
304 .RE
306 .sp
307 .ne 2
308 .na
309 \fB\fIfile\fR\fR
310 .ad
311 .sp .6
312 .RS 4n
313 Represents a valid file name. \fBdf\fR reports on the file system that contains
314 \fIfile\fR.
315 .RE
317 .sp
318 .ne 2
319 .na
320 \fB\fIresource\fR\fR
321 .ad
322 .sp .6
323 .RS 4n
324 Represents an \fBNFS\fR resource name.
325 .RE
327 .SH USAGE
328 .LP
329 See \fBlargefile\fR(5) for the description of the behavior of \fBdf\fR when
330 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
331 .SH EXAMPLES
332 .LP
333 \fBExample 1 \fRExecuting the \fBdf\fR command
334 .sp
335 .LP
336 The following example shows the \fBdf\fR command and its output:
338 .sp
339 .in +2
340 .nf
341 example% \fB/usr/bin/df\fR
343 / (/dev/dsk/c0t0d0s0 ): 287530 blocks 92028 files
344 /system/contract (ctfs ): 0 blocks 2147483572 files
345 /system/object (objfs ): 0 blocks 2147483511 files
346 /usr (/dev/dsk/c0t0d0s6 ): 1020214 blocks 268550 files
347 /proc (/proc ): 0 blocks 878 files
348 /dev/fd (fd ): 0 blocks 0 files
349 /etc/mnttab (mnttab ): 0 blocks 0 files
350 /var/run (swap ): 396016 blocks 9375 files
351 /tmp (swap ): 396016 blocks 9375 files
352 /opt (/dev/dsk/c0t0d0s5 ): 381552 blocks 96649 files
353 /export/home (/dev/dsk/c0t0d0s7 ): 434364 blocks 108220 files
354 .fi
355 .in -2
356 .sp
358 .sp
359 .LP
360 where the columns represent the mount point, device (or "filesystem", according
361 to \fBdf\fR \fB-k\fR), free blocks, and free files, respectively. For contract
362 file systems, \fB/system/contract\fR is the mount point, \fBctfs\fR is the
363 contract file system (used by \fBSMF\fR) with 0 free blocks and
364 2147483582(\fBINTMAX\fR-1) free files. For object file systems,
365 \fB/system/object\fR is the mount point, \fBobjfs\fR is the object file system
366 (see \fBobjfs\fR(7FS)) with 0 free blocks and 2147483511 free files.
367 .LP
368 \fBExample 2 \fRWriting Portable Information About the \fB/usr\fR File System
369 .sp
370 .LP
371 The following example writes portable information about the \fB/usr\fR file
372 system:
374 .sp
375 .in +2
376 .nf
377 example% \fB/usr/bin/df -P /usr\fR
378 .fi
379 .in -2
380 .sp
382 .LP
383 \fBExample 3 \fRWriting Portable Information About the \fB/usr/src\fR file
384 System
385 .sp
386 .LP
387 Assuming that \fB/usr/src\fR is part of the \fB/usr\fR file system, the
388 following example writes portable information :
390 .sp
391 .in +2
392 .nf
393 example% \fB/usr/bin/df -P /usr/src\fR
394 .fi
395 .in -2
396 .sp
398 .LP
399 \fBExample 4 \fRUsing \fBdf\fR to Display Inode Usage
400 .sp
401 .LP
402 The following example displays inode usage on all \fBufs\fR file systems:
404 .sp
405 .in +2
406 .nf
407 example%\fB/usr/bin/df -F ufs -o i\fR
408 .fi
409 .in -2
410 .sp
412 .SH ENVIRONMENT VARIABLES
413 .LP
414 See \fBenviron\fR(5) for descriptions of the following environment variables
415 that affect the execution of \fBdf\fR: \fBLANG\fR, \fBLC_ALL\fR,
416 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
417 .SH EXIT STATUS
418 .LP
419 The following exit values are returned:
420 .sp
421 .ne 2
422 .na
423 \fB\fB0\fR\fR
424 .ad
425 .sp .6
426 .RS 4n
427 Successful completion.
428 .RE
430 .sp
431 .ne 2
432 .na
433 \fB\fB>0\fR\fR
434 .ad
435 .sp .6
436 .RS 4n
437 An error occurred.
438 .RE
440 .SH FILES
441 .ne 2
442 .na
443 \fB\fB/dev/dsk/*\fR\fR
444 .ad
445 .sp .6
446 .RS 4n
447 Disk devices
448 .RE
450 .sp
451 .ne 2
452 .na
453 \fB\fB/etc/default/fs\fR\fR
454 .ad
455 .sp .6
456 .RS 4n
457 Default local file system type. Default values can be set for the following
458 flags in \fB/etc/default/fs\fR. For example: \fBLOCAL=ufs\fR, where \fBLOCAL\fR
459 is the default partition for a command if no FSType is specified.
460 .RE
462 .sp
463 .ne 2
464 .na
465 \fB\fB/etc/mnttab\fR\fR
466 .ad
467 .sp .6
468 .RS 4n
469 Mount table
470 .RE
472 .sp
473 .ne 2
474 .na
475 \fB\fB/etc/vfstab\fR\fR
476 .ad
477 .sp .6
478 .RS 4n
479 List of default parameters for each file system
480 .RE
482 .SH ATTRIBUTES
483 .LP
484 See \fBattributes\fR(5) for descriptions of the following attributes:
486 .TS
487 box;
488 c | c
489 l | l .
490 ATTRIBUTE TYPE ATTRIBUTE VALUE
491 _
492 Interface Stability Standard
493 .TE
495 .SH SEE ALSO
496 .LP
497 \fBfind\fR(1), \fBdf_ufs\fR(1M), \fBmount\fR(1M), \fBstatvfs\fR(2),
498 \fBdefault_fs\fR(4), \fBmnttab\fR(4), \fBvfstab\fR(4), \fBattributes\fR(5),
499 \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5), \fBobjfs\fR(7FS)
500 .SH NOTES
501 .LP
502 If \fBUFS\fR logging is enabled on a file system, the disk space used for the
503 log is reflected in the \fBdf\fR report. The log is allocated from free blocks
504 on the file system, and it is sized approximately \fB1\fR Mbyte per \fB1\fR
505 Gbyte of file system, up to 256 Mbytes. The log size may be larger (up to a
506 maximum of 512 Mbytes) depending on the number of cylinder groups present in
507 the file system.