From 3cdb021bbe2c712b35180dfaecc31aaf07fc4d1a Mon Sep 17 00:00:00 2001 From: merakor Date: Thu, 4 Feb 2021 09:15:55 +0000 Subject: docs: update FossilOrigin-Name: fe4da8579b2d3046d754f207680c00f1d73e38ada24a60f2e05fb1e8c55532fe --- docs/cpt.org | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/cpt.org b/docs/cpt.org index dfddc38..e3c1d9b 100644 --- a/docs/cpt.org +++ b/docs/cpt.org @@ -1056,7 +1056,20 @@ if it fails. :DESCRIPTION: Query package locations :END: -=pkg_find()= +=pkg_find()= is the tool for searching packages. It accepts up to 3 arguments. + +- $1: Query :: This is the only mandatory argument. It accepts globbing, meaning + that shell wildcards can be used in the query. +- $2: Match :: If this exists =pkg_find()= will print every single match found + in the search path. If it doesn't, =pkg_find()= will print the first match and + exit. +- $3: Type :: This is the argument to be passed to the =test= function. Unless + this argument is given, it defaults to =-d=, which tests for directories. + +#+begin_src sh +pkg_find cpt +#+end_src + *** TODO =pkg_gentree= :PROPERTIES: -- cgit v1.2.3