From fc8de2a8f48485ad8b035a4e76098c4a7dbadb05 Mon Sep 17 00:00:00 2001
From: merakor <cem@ckyln.com>
Date: Fri, 12 Mar 2021 13:58:36 +0000
Subject: docs: update

FossilOrigin-Name: 143ea57c3d8309faf15399199d0e2930f07371a34c08ff16e9a9f5fbb0be6a23
---
 contrib/cpt-size | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'contrib/cpt-size')

diff --git a/contrib/cpt-size b/contrib/cpt-size
index 0e7b9d6..2812d56 100755
--- a/contrib/cpt-size
+++ b/contrib/cpt-size
@@ -1,6 +1,30 @@
 #!/bin/sh -ef
 # Show the size on disk for a package
 
+## SYNOPSIS:
+## .Nm
+## .Op Ar pkg...
+
+## DESCRIPTION:
+## .Nm
+## calculates the sizes of given
+## .Ar packages
+## using the files from the package manifest and outputs a total size of the
+## packages along with all the files associated with them.
+
+## CAVEATS:
+## .Nm
+## uses the non-POSIX
+## .Fl h
+## and
+## .Fl c
+## flags for
+## .Xr du 1 ,
+## which will not work with
+## .Em sbase ,
+## but it is a major performance improvement compared to calculating
+## total and human-readable sizes by hand.
+
 case "$1" in
     --help|-h)
         printf '%s\n' "usage: ${0##*/} [pkg...]"
-- 
cgit v1.2.3