aboutsummaryrefslogtreecommitdiff
path: root/contrib/cpt-cat
diff options
context:
space:
mode:
authormerakor <cem@ckyln.com>2021-03-12 12:22:30 +0000
committermerakor <cem@ckyln.com>2021-03-12 12:22:30 +0000
commit81e3f00288d6fdc93de2dc31c065ebe3bdb1adf5 (patch)
treec68eef3692212bb7dd6be17f44b8afbdf478b5a7 /contrib/cpt-cat
parentf086f31f2e7c0418d888a2db5accf78ae0e5d8e0 (diff)
downloadcpt-81e3f00288d6fdc93de2dc31c065ebe3bdb1adf5.tar.gz
docs: update
FossilOrigin-Name: fb505a8b22eb533c8857eaa002228f2c950ac1cdb4c7b314daf7b61cb25bed53
Diffstat (limited to 'contrib/cpt-cat')
-rwxr-xr-xcontrib/cpt-cat27
1 files changed, 27 insertions, 0 deletions
diff --git a/contrib/cpt-cat b/contrib/cpt-cat
index b8dc34b..bfc9d66 100755
--- a/contrib/cpt-cat
+++ b/contrib/cpt-cat
@@ -1,6 +1,33 @@
#!/bin/sh -e
# Concatanate package files in the installed package database
# File names are printed to stderr.
+
+## SYNOPSIS:
+## .Nm
+## .Op Ar pkg
+## .Op Ar file...
+
+## DESCRIPTION:
+## .Nm
+## outputs the contents of the given package's database files to the standard
+## output. The names of the files being printed will also be printed, but to
+## stderr. Thus, you can pipe the contents of a file without worrying about
+## mixing filenames into that file.
+##
+## If no package is specified,
+## .Nm
+## will assume that the package in the current directory is going to be printed.
+##
+## If no file is specified,
+## .Nm
+## will print the contents
+## .Em build ,
+## .Em depends ,
+## .Em sources
+## and
+## .Em version
+## files.
+
case "$1" in
--help|-h)
printf 'usage: %s [pkg] [file...]\n' "${0##*/}"