From 81e3f00288d6fdc93de2dc31c065ebe3bdb1adf5 Mon Sep 17 00:00:00 2001
From: merakor <cem@ckyln.com>
Date: Fri, 12 Mar 2021 12:22:30 +0000
Subject: docs: update

FossilOrigin-Name: fb505a8b22eb533c8857eaa002228f2c950ac1cdb4c7b314daf7b61cb25bed53
---
 contrib/cpt-export | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'contrib/cpt-export')

diff --git a/contrib/cpt-export b/contrib/cpt-export
index d0ce36a..0e7495b 100755
--- a/contrib/cpt-export
+++ b/contrib/cpt-export
@@ -1,6 +1,17 @@
 #!/bin/sh -ef
 # Turn an installed package into a CPT tarball
 
+## SYNOPSIS:
+## .Nm
+## .Op Ar pkg
+
+## DESCRIPTION:
+## .Nm
+## creates a package tarball of an installed package using the system files
+## declared on the package's manifest. If no package name is given,
+## .Nm
+## will use the name of the current directory as the package.
+
 case "$1" in
     --help|-h)
         printf 'usage: %s [pkg]\n' "${0##*/}"
@@ -15,6 +26,11 @@ cpt-list "${1:-null}" >/dev/null
 read -r ver rel 2>/dev/null < \
     "$CPT_ROOT/var/db/cpt/installed/$1/version"
 
+### Environment variables:
+### The compression method can be changed while creating a tarball, using the
+### .Ev CPT_COMPRESS
+### environment variable.
+
 # Fallback to gzip if there is a typo
 case "$CPT_COMPRESS" in bz2|gz|xz|zst) ;; *) CPT_COMPRESS=gz; esac
 
-- 
cgit v1.2.3