Skip to content

Commit 3fb5666

Browse files
committed
Add mango-generated man page
1 parent fcdf68d commit 3fb5666

File tree

1 file changed

+112
-122
lines changed

1 file changed

+112
-122
lines changed

duf.1

Lines changed: 112 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -1,188 +1,178 @@
1-
.TH duf 1 "06 April 2021" "duf-0.6.2" "Disk Usage/Free Utility"
1+
.TH DUF 1 "2022-02-01" "duf" "duf - Disk Usage/Free Utility"
22
.SH NAME
3-
\fBduf \fP- Disk Usage/Free Utility
4-
\fB
3+
duf - Disk Usage/Free Utility
54
.SH SYNOPSIS
6-
.nf
7-
.fam C
8-
\fBduf\fP [ \fIoptions\fP ]
9-
10-
.fam T
11-
.fi
12-
.fam T
13-
.fi
5+
\fBduf\fP [\fIoptions\&.\&.\&.\fP] [\fIargument\&.\&.\&.\fP]
146
.SH DESCRIPTION
15-
Simple Disk Usage/Free Utility.
7+
Simple Disk Usage/Free Utility\&.
168
.PP
179
Features:
10+
.PP
1811
.RS
1912
.IP \(bu 3
20-
User-friendly, colorful output.
13+
User-friendly, colorful output\&.
2114
.IP \(bu 3
22-
Adjusts to your terminal's theme & width.
15+
Adjusts to your terminal's theme & width\&.
2316
.IP \(bu 3
24-
Sort the results according to your needs.
17+
Sort the results according to your needs\&.
2518
.IP \(bu 3
26-
Groups & filters devices.
19+
Groups & filters devices\&.
2720
.IP \(bu 3
28-
Can conveniently output JSON.
21+
Can conveniently output JSON\&.
2922
.SH OPTIONS
3023
.TP
31-
.B
3224
\fB-all\fP
33-
Include pseudo, duplicate, inaccessible file systems.
25+
include pseudo, duplicate, inaccessible file systems
26+
.TP
27+
\fB-avail-threshold\fP
28+
specifies the coloring threshold (yellow, red) of the avail column, must be integer with optional SI prefixes
3429
.TP
35-
.B
36-
\fB-hide\fP string
37-
Hide specific devices, separated with commas:
38-
local, network, fuse, special, loops, binds.
30+
\fB-hide\fP
31+
hide specific devices, separated with commas: local, network, fuse, special, loops, binds
3932
.TP
40-
.B
41-
\fB-hide-fs\fP string
42-
Hide specific filesystems, separated with commas.
33+
\fB-hide-fs\fP
34+
hide specific filesystems, separated with commas
35+
.TP
36+
\fB-hide-mp\fP
37+
hide specific mount points, separated with commas (supports wildcards)
4338
.TP
44-
.B
4539
\fB-inodes\fP
46-
List inode information instead of block usage.
40+
list inode information instead of block usage
4741
.TP
48-
.B
4942
\fB-json\fP
50-
Output all devices in JSON format.
43+
output all devices in JSON format
44+
.TP
45+
\fB-only\fP
46+
show only specific devices, separated with commas: local, network, fuse, special, loops, binds
5147
.TP
52-
.B
53-
\fB-only\fP string
54-
Show only specific devices, separated with commas:
55-
local, network, fuse, special, loops, binds.
48+
\fB-only-fs\fP
49+
only specific filesystems, separated with commas
5650
.TP
57-
.B
58-
\fB-only-fs\fP string
59-
Only specific filesystems, separated with commas.
51+
\fB-only-mp\fP
52+
only specific mount points, separated with commas (supports wildcards)
6053
.TP
61-
.B
62-
\fB-output\fP string
63-
Output fields: mountpoint, size, used, avail, usage, inodes,
64-
inodes_used, inodes_avail, inodes_usage, type, filesys‐tem.
54+
\fB-output\fP
55+
output fields: mountpoint, size, used, avail, usage, inodes, inodes_used, inodes_avail, inodes_usage, type, filesystem
6556
.TP
66-
.B
67-
\fB-sort\fP string
68-
Sort output by: mountpoint, size, used, avail, usage, inodes,
69-
inodes_used, inodes_avail, inodes_usage, type, filesys‐tem (default "mountpoint").
57+
\fB-sort\fP
58+
sort output by: mountpoint, size, used, avail, usage, inodes, inodes_used, inodes_avail, inodes_usage, type, filesystem
7059
.TP
71-
.B
72-
\fB-style\fP string
73-
Style: unicode, ascii (default "unicode").
60+
\fB-style\fP
61+
style: unicode, ascii
7462
.TP
75-
.B
76-
\fB-theme\fP string
77-
Color themes: dark, light (default "dark").
63+
\fB-theme\fP
64+
color themes: dark, light
65+
.TP
66+
\fB-usage-threshold\fP
67+
specifies the coloring threshold (yellow, red) of the usage bars as a floating point number from 0 to 1
7868
.TP
79-
.B
8069
\fB-version\fP
81-
Display version.
70+
display version
8271
.TP
83-
.B
8472
\fB-warnings\fP
85-
Output all warnings to STDERR.
73+
output all warnings to STDERR
8674
.TP
87-
.B
88-
\fB-width\fP uint
89-
Max output width.
75+
\fB-width\fP
76+
max output width
9077
.SH USAGE
91-
You can simply start \fBduf\fP without any command-line arguments:
78+
You can simply start duf without any command-line arguments:
79+
.PP
9280
.PP
93-
.nf
94-
.fam C
9581
$ duf
96-
97-
.fam T
98-
.fi
99-
If you supply arguments, \fBduf\fP will only list specific devices & mount points:
10082
.PP
101-
.nf
102-
.fam C
83+
.PP
84+
If you supply arguments, duf will only list specific devices & mount points:
85+
.PP
86+
.PP
10387
$ duf /home /some/file
104-
105-
.fam T
106-
.fi
88+
.PP
89+
.PP
10790
If you want to list everything (including pseudo, duplicate, inaccessible file systems):
10891
.PP
109-
.nf
110-
.fam C
92+
.PP
11193
$ duf --all
112-
113-
.fam T
114-
.fi
94+
.PP
95+
.PP
11596
You can show and hide specific tables:
11697
.PP
117-
.nf
118-
.fam C
98+
.PP
11999
$ duf --only local,network,fuse,special,loops,binds
100+
.PP
120101
$ duf --hide local,network,fuse,special,loops,binds
121-
122-
.fam T
123-
.fi
102+
.PP
103+
.PP
124104
You can also show and hide specific filesystems:
125105
.PP
126-
.nf
127-
.fam C
106+
.PP
128107
$ duf --only-fs tmpfs,vfat
108+
.PP
129109
$ duf --hide-fs tmpfs,vfat
130-
131-
.fam T
132-
.fi
110+
.PP
111+
.PP
112+
\&.\&.\&.or specific mount points:
113+
.PP
114+
.PP
115+
$ duf --only-mp /,/home,/dev
116+
.PP
117+
$ duf --hide-mp /,/home,/dev
118+
.PP
119+
.PP
120+
Wildcards inside quotes work:
121+
.PP
122+
.PP
123+
$ duf --only-mp '/sys/*,/dev/*'
124+
.PP
125+
.PP
133126
Sort the output:
134127
.PP
135-
.nf
136-
.fam C
128+
.PP
137129
$ duf --sort size
138-
139-
Valid keys are: mountpoint, size, used, avail, usage, inodes, inodes_used, inodes_avail, inodes_usage, type, filesystem.
140-
141-
.fam T
142-
.fi
130+
.PP
131+
.PP
132+
Valid keys are: mountpoint, size, used, avail, usage, inodes, inodes_used, inodes_avail, inodes_usage, type, filesystem\&.
133+
.PP
134+
.PP
143135
Show or hide specific columns:
144136
.PP
145-
.nf
146-
.fam C
137+
.PP
147138
$ duf --output mountpoint,size,usage
148-
149-
Valid keys are: mountpoint, size, used, avail, usage, inodes, inodes_used, inodes_avail, inodes_usage, type, filesystem.
150-
151-
.fam T
152-
.fi
139+
.PP
140+
.PP
141+
Valid keys are: mountpoint, size, used, avail, usage, inodes, inodes_used, inodes_avail, inodes_usage, type, filesystem\&.
142+
.PP
143+
.PP
153144
List inode information instead of block usage:
154145
.PP
155-
.nf
156-
.fam C
146+
.PP
157147
$ duf --inodes
158-
159-
.fam T
160-
.fi
161-
If \fBduf\fP doesn't detect your terminal's colors correctly, you can set a theme:
162148
.PP
163-
.nf
164-
.fam C
149+
.PP
150+
If duf doesn't detect your terminal's colors correctly, you can set a theme:
151+
.PP
152+
.PP
165153
$ duf --theme light
166-
167-
.fam T
168-
.fi
154+
.PP
155+
.PP
156+
duf highlights the availability & usage columns in red, green, or yellow, depending on how much space is still available\&. You can set your own thresholds:
157+
.PP
158+
.PP
159+
$ duf --avail-threshold="10G,1G"
160+
.PP
161+
$ duf --usage-threshold="0\&.5,0\&.9"
162+
.PP
163+
.PP
169164
If you prefer your output as JSON:
170165
.PP
171-
.nf
172-
.fam C
166+
.PP
173167
$ duf --json
174-
175-
.fam T
176-
.fi
168+
.PP
177169
.SH NOTES
178-
Portions of \fBduf\fP's code are copied and modified from https://github.com/shirou/gopsutil.
170+
Portions of duf's code are copied and modified from https://github\&.com/shirou/gopsutil\&.
179171
.PP
180-
gopsutil was written by WAKAYAMA Shirou and is distributed under BSD-3-Clause.
172+
gopsutil was written by WAKAYAMA Shirou and is distributed under BSD-3-Clause\&.
181173
.SH AUTHORS
182-
\fBduf\fP was written by Christian Muehlhaeuser <https://github.com/muesli/\fBduf\fP/issues>.
183-
.PP
184-
This manpage was written by Francisco Vilmar Cardoso Ruviaro for the Debian project (but may be used by others).
174+
duf was written by Christian Muehlhaeuser <https://github\&.com/muesli/duf>
185175
.SH COPYRIGHT
186-
Copyright (C) 2020 Christian Muehlhaeuser <https://github.com/muesli/\fBduf\fP/issues>.
176+
Copyright (C) 2020-2022 Christian Muehlhaeuser <https://github\&.com/muesli>
187177
.PP
188-
Released under MIT license.
178+
Released under MIT license\&.

0 commit comments

Comments
 (0)