aboutsummaryrefslogtreecommitdiff
path: root/contrib/cpt-fork
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/cpt-fork')
-rwxr-xr-xcontrib/cpt-fork21
1 files changed, 20 insertions, 1 deletions
diff --git a/contrib/cpt-fork b/contrib/cpt-fork
index d0d8c1c..21e1618 100755
--- a/contrib/cpt-fork
+++ b/contrib/cpt-fork
@@ -1,6 +1,25 @@
#!/bin/sh -ef
# Fork a package to the current directory
+## SYNOPSIS:
+## .Nm
+## .Op Ar pkg...
+
+## DESCRIPTION:
+## .Nm
+## copies the given packages to the current directory.
+
+## HANDLING FORKED PACKAGES:
+## After forking a package, a user can either add the parent directory of the
+## package to their
+## .Ev CPT_PATH
+## or run
+## .Bd -literal -compact -offset indent
+## cpt-build && cpt-install
+## .Ed
+## inside the package directory to build and install the forked package.
+## see: cpt-link.1
+
case "$1" in ''|--help|-h) printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} [pkg...]" ; exit 0 ; esac
die() { printf '\033[1;31m!> \033[m%s\n' "$@" >&2; exit 1;}
@@ -21,7 +40,7 @@ for pkg; do
esac
# Sometimes forked packages are from the database and not from a repository.
- # We should remove the manifest in such a case.
+ # We should remove the manifest and etcsums in such a case.
rm -f "$pkg/manifest" "$pkg/etcsums"
printf 'forked package to %s\n' "$PWD/$pkg"