Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-search.1.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pkgctl-search.1.asciidoc')
-rw-r--r--doc/man/pkgctl-search.1.asciidoc71
1 files changed, 71 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..8172b00
--- /dev/null
+++ b/doc/man/pkgctl-search.1.asciidoc
@@ -0,0 +1,71 @@
+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
+-------
+
+*-h, --help*::
+ Show a help text
+
+Filter Options
+--------------
+
+*--no-default-filter*::
+ Do not apply default filter (like -path:keys/pgp/*.asc)
+
+Output Options
+--------------
+
+*--json*::
+ Enable printing in JSON; Shorthand for `'--format json'`
+
+*-F, --format* 'FORMAT'::
+ Controls the formatting of the results; `FORMAT` is `'pretty'`, `'plain'`,
+ or `'json'` (default `pretty`)
+
+*-N, --no-line-number*::
+ Don't show line numbers when formatting results
+
+See Also
+--------
+
+linkman:pkgctl-auth[1]
+
+include::include/footer.asciidoc[]