From ce9541cf425c005f48901ab5781e0f56437ad8b2 Mon Sep 17 00:00:00 2001 From: merakor Date: Tue, 10 Aug 2021 23:31:25 +0000 Subject: cpt-search: add description searching mode FossilOrigin-Name: 065485d1faf9a5ec3ba5951049e2ac7882f1a3cb5587dc713f8c32a347a92b5e --- man/cpt-search.1 | 41 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 37 insertions(+), 4 deletions(-) (limited to 'man') diff --git a/man/cpt-search.1 b/man/cpt-search.1 index f59f7b9..299fed6 100644 --- a/man/cpt-search.1 +++ b/man/cpt-search.1 @@ -5,8 +5,15 @@ .Nd search for cpt packages .Sh SYNOPSIS .Nm -.Op Fl dso -.Op Ar query +.Op Fl ds +.Ar package... +.Nm +.Fl o +.Op Fl ds +.Nm +.Fl q +.Op Fl Fds +.Ar query .Sh DESCRIPTION .Nm can be used to search packages. Glob characters can also be used in the search. @@ -17,6 +24,10 @@ The options are as follows: Do not search the installed package database. .It Fl s , -single Only show the first instance of a package. +.It Fl q , -query +Search packages making use of package descriptions. +.It Fl F , -fixed +Run query mode interpreting the given pattern as a fixed string .It Fl o , -others Use the current directory as the package and show other instances of that package. @@ -24,9 +35,31 @@ package. Show help message .It Fl v , -version Print version information -.It Fl -verbose -Be more verbose .El +.Pp +The program has three modes of operations. The default operation is to search +for the packages given as positional arguments. +.Pp +If the +.Fl o +flag is specified, +.Nm +will use the name of the current directory to search for instances of other +packages with the same name. +.Pp +If the +.Fl q +flag is specified, +.Nm +will search through the name and description of packages using the given +.Ar query , +and run a case-insensitive search through +.Xr grep 1 . +If additionally the +.Fl F +flag is given, the given +.Ar query +will be considered a fixed string. .Sh EXAMPLES Below are usage examples for .Nm , -- cgit v1.2.3