Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJelle van der Waa <jelle@archlinux.org>2023-07-01 15:21:32 +0200
committerLevente Polyak <anthraxx@archlinux.org>2024-01-07 02:35:18 +0100
commit4673ad6c89bbdca632b22edfc2ef35486b7a635b (patch)
treeb67ea8a55ea0461ed76d2798b2db19174b93d25a /doc
parent78dd15099684615e98d20dfaa2b9fbe5ca3f6e6b (diff)
feat(search): add subcommand to search across the packaging group
Search for an expression across the GitLab packaging group. To use a filter, include it in your query. You may use wildcards (*) to use glob matching. Available filters for the blobs scope: path, extension. Every usage of the search command must be authenticated. Consult the 'pkgctl auth' command to authenticate with GitLab or view the authentication status. This command uses bats for pretty printing the results including line numbers and syntax highlighting. Component: pkgctl search Co-authored-by: Christian Heusel <christian@heusel.eu> Co-authored-by: Levente Polyak <anthraxx@archlinux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/man/pkgctl-search.1.asciidoc58
-rw-r--r--doc/man/pkgctl.1.asciidoc4
2 files changed, 62 insertions, 0 deletions
diff --git a/doc/man/pkgctl-search.1.asciidoc b/doc/man/pkgctl-search.1.asciidoc
new file mode 100644
index 0000000..fb79b88
--- /dev/null
+++ b/doc/man/pkgctl-search.1.asciidoc
@@ -0,0 +1,58 @@
+pkgctl-search(1)
+================
+
+Name
+----
+pkgctl-search - Search for an expression across the GitLab packaging group
+
+Synopsis
+--------
+pkgctl search [OPTIONS] QUERY
+
+Description
+-----------
+
+Search for an expression across the GitLab packaging group.
+
+To use a filter, include it in your query. You may use wildcards (*) to
+use glob matching.
+
+Available filters for the blobs scope: path, extension
+
+Every usage of the search command must be authenticated. Consult the
+'pkgctl auth' command to authenticate with GitLab or view the authentication
+status.
+
+Search Tips
+-----------
+
+ Syntax Description Example
+ ───────────────────────────────────────
+ " Exact search "gem sidekiq"
+ ~ Fuzzy search J~ Doe
+ | Or display | banner
+ + And display +banner
+ - Exclude display -banner
+ * Partial bug error 50*
+ \ Escape \*md
+ # Issue ID #23456
+ ! Merge request !23456
+
+Options
+-------
+
+*--json*::
+ Enable printing results in JSON
+
+*--no-default-filter*::
+ Do not apply default filter (like -path:keys/pgp/*.asc)
+
+*-h, --help*::
+ Show a help text
+
+See Also
+--------
+
+linkman:pkgctl-auth[1]
+
+include::include/footer.asciidoc[]
diff --git a/doc/man/pkgctl.1.asciidoc b/doc/man/pkgctl.1.asciidoc
index 74edf68..1164561 100644
--- a/doc/man/pkgctl.1.asciidoc
+++ b/doc/man/pkgctl.1.asciidoc
@@ -44,6 +44,9 @@ pkgctl release::
pkgctl repo::
Manage Git packaging repositories and their configuration
+pkgctl search::
+ Search for an expression across the GitLab packaging group
+
pkgctl version::
Show pkgctl version information
@@ -56,6 +59,7 @@ linkman:pkgctl-db[1]
linkman:pkgctl-diff[1]
linkman:pkgctl-release[1]
linkman:pkgctl-repo[1]
+linkman:pkgctl-search[1]
linkman:pkgctl-version[1]
include::include/footer.asciidoc[]