summaryrefslogtreecommitdiff
path: root/bin/checklinks
diff options
context:
space:
mode:
Diffstat (limited to 'bin/checklinks')
-rwxr-xr-xbin/checklinks5
1 files changed, 4 insertions, 1 deletions
diff --git a/bin/checklinks b/bin/checklinks
index 3150293..d9df1a2 100755
--- a/bin/checklinks
+++ b/bin/checklinks
@@ -268,9 +268,12 @@ Set the level threshold to show status messages.
=item B<-p>, B<--parameter> I<parameter>=I<value>
While reading the links file, replace $I<parameter> with I<value>.
+
When used in conjuction with ct(1), $package will be set to the current
package's relative path (as seen from $HOME, like C<packages/caretaker>),
-and $etc will be set to $package/etc (like C<packages/caretaker/etc>)
+$etc will be set to $package/etc (like C<packages/caretaker/etc>) and $pkgdir
+will point to the package root (like C<packages>). Also, for each of these
+parameters, C<a_param> (like $a_etc) is the corresponding absolute path.
=item B<-q>, B<--quiet>