From 55d6638c685877dbab7f788ff58d14299df88666 Mon Sep 17 00:00:00 2001
From: merakor <cem@ckyln.com>
Date: Thu, 4 Feb 2021 14:40:55 +0000
Subject: docs: update

FossilOrigin-Name: 866439df8a013c36f591f568e2a061df0eff2bbbc64120468e1a1527abf69f4a
---
 docs/cpt.texi | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

(limited to 'docs/cpt.texi')

diff --git a/docs/cpt.texi b/docs/cpt.texi
index 7c1a95f..2dcbf8a 100644
--- a/docs/cpt.texi
+++ b/docs/cpt.texi
@@ -1245,7 +1245,24 @@ if it fails.
 @node @samp{pkg_find()}
 @subsection @strong{TODO} @samp{pkg_find()}
 
-@samp{pkg_find()}
+@samp{pkg_find()} is the tool for searching packages. It accepts up to 3 arguments.
+
+@table @asis
+@item $1: Query
+This is the only mandatory argument. It accepts globbing, meaning
+that shell wildcards can be used in the query.
+@item $2: Match
+If this exists @samp{pkg_find()} will print every single match found
+in the search path. If it doesn't, @samp{pkg_find()} will print the first match and
+exit.
+@item $3: Type
+This is the argument to be passed to the @samp{test} function. Unless
+this argument is given, it defaults to @samp{-d}, which tests for directories.
+@end table
+
+@example
+pkg_find cpt
+@end example
 
 @node @samp{pkg_gentree}
 @subsection @strong{TODO} @samp{pkg_gentree}
-- 
cgit v1.2.3