utilities/diskus
utilities/diskus
1
0
Fork 0
mirror of https://github.com/sharkdp/diskus synced 2024-07-01 07:04:46 +00:00
Code Issues Projects Releases Wiki Activity

Add initial version of man page, closes #30

Browse Source
This commit is contained in:
sharkdp 2019-09-21 15:05:24 +02:00
parent 4000fdb755
commit 2f1babae6f
2 changed files with 37 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ci/before_deploy.bash vendored
View File

@ -23,7 +23,8 @@ pack() {
cp "target/$TARGET/release/$PROJECT_NAME" "$tempdir/$package_name/"
strip "$tempdir/$package_name/$PROJECT_NAME"
# readme and license
# manpage, readme and license
cp "doc/$PROJECT_NAME.1" "$tempdir/$package_name"
cp README.md "$tempdir/$package_name"
cp LICENSE-MIT "$tempdir/$package_name"
cp LICENSE-APACHE "$tempdir/$package_name"
@ -69,6 +70,10 @@ make_deb() {
install -Dm755 "target/$TARGET/release/$PROJECT_NAME" "$tempdir/usr/bin/$PROJECT_NAME"
strip "$tempdir/usr/bin/$PROJECT_NAME"
# manpage
install -Dm644 "doc/$PROJECT_NAME.1" "$tempdir/usr/share/man/man1/$PROJECT_NAME.1"
gzip --best "$tempdir/usr/share/man/man1/$PROJECT_NAME.1"
# readme and license
install -Dm644 README.md "$tempdir/usr/share/doc/$PROJECT_NAME/README.md"
install -Dm644 LICENSE-MIT "$tempdir/usr/share/doc/$PROJECT_NAME/LICENSE-MIT"

31
doc/diskus.1 Normal file
View File

@ -0,0 +1,31 @@
.TH DISKUS "1"
.SH NAME
diskus - Compute disk usage for the given filesystem entries
.SH SYNOPSIS
.B diskus
.RB [OPTIONS]
.RB [path...]
.SH OPTIONS
.TP
\fB\-j\fR, \fB\-\-threads\fR <N>
Set the number of threads (default: 3 x num cores)
.TP
\fB\-\-size\-format\fR <type>
Output format for file sizes (decimal: MB, binary: MiB) [default: decimal]
[possible values: decimal, binary]
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Do not hide filesystem errors
.TP
\fB\-b\fR, \fB\-\-apparent\-size\fR
Compute apparent size instead of disk usage
.TP
\fB\-h\fR, \fB\-\-help\fR
Prints help information
.TP
\fB\-V\fR, \fB\-\-version\fR
Prints version information
.SH ARGUMENTS
.TP
<path>...
List of filesystem paths