Use GNU style like the rest of the file for my last commit.
[dragonfly/vkernel-mp.git] / usr.sbin / quot / quot.8
blob1d153bb2e11a79b04d32ce030e4a8c36e45b9e9d
1 .\" Copyright (C) 1994 Wolfgang Solfrank.
2 .\" Copyright (C) 1994 TooLs GmbH.
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\"    must display the following acknowledgement:
15 .\"     This product includes software developed by TooLs GmbH.
16 .\" 4. The name of TooLs GmbH may not be used to endorse or promote products
17 .\"    derived from this software without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 .\" IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .\" $FreeBSD: src/usr.sbin/quot/quot.8,v 1.12.2.5 2003/03/11 22:31:31 trhodes Exp $
31 .\" $DragonFly: src/usr.sbin/quot/quot.8,v 1.5 2006/05/21 16:15:05 swildner Exp $
32 .\"
33 .Dd February 8, 1994
34 .Dt QUOT 8
35 .Os
36 .Sh NAME
37 .Nm quot
38 .Nd display disk space occupied by each user
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl acfhknv
42 .Op Ar filesystem ...
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility
47 is used to gather statistics about the disk usage for each local user.
48 .Pp
49 The following options are available:
50 .Bl -tag -width indent
51 .It Fl a
52 Include statistics for all mounted file systems.
53 .It Fl c
54 Display three columns containing number of blocks per file,
55 number of files in this category, and aggregate total of
56 blocks in files with this or lower size.
57 .It Fl f
58 For each user, display count of files and space occupied.
59 .It Fl h
60 Estimate the number of blocks in each file based on its size.
61 Despite that this does not give the correct results (it does not
62 account for the holes in files), this option is not any faster
63 and thus is discouraged.
64 .It Fl k
65 Force the numbers to be reported in kilobyte counts.
66 By default, all sizes are reported in 512-byte block counts.
67 .It Fl n
68 Given a list of inodes (plus some optional data on each line)
69 in the standard input, for each file print out the owner (plus
70 the remainder of the input line). This is traditionally used
71 in the pipe:
72 .Bd -literal -offset indent
73 .\" ncheck filesystem | sort +0n | quot -n filesystem
74 ls -i | sed -e 's,^  *,,' | sort +0n | quot -n filesystem
75 .Ed
76 .Pp
77 to get a report of files and their owners.
78 .It Fl v
79 In addition to the default output, display the number of files
80 not accessed within 30, 60 and 90 days.
81 .El
82 .Sh ENVIRONMENT
83 .Bl -tag -width BLOCKSIZE
84 .It Ev BLOCKSIZE
85 If the environment variable
86 .Ev BLOCKSIZE
87 is set, and the
88 .Fl k
89 option is not specified, the block counts will be displayed in units of that
90 size block.
91 .El
92 .Sh SEE ALSO
93 .Xr df 1 ,
94 .Xr quota 1 ,
95 .Xr getmntinfo 3 ,
96 .Xr fstab 5 ,
97 .Xr mount 8
98 .Sh HISTORY
99 This implementation of
101 is by
102 .An Wolfgang Solfrank
103 / TooLs GmbH.
104 .Sh BUGS
105 .Xr ncheck 1
106 (which would be a lot more useful than
107 .Nm ls Fl i
108 in the example above)
109 does not exist in
110 .Dx .