aboutsummaryrefslogtreecommitdiff
path: root/build-app.lisp
diff options
context:
space:
mode:
authorColin Okay <okay@toyful.space>2022-03-04 12:09:47 -0600
committerColin Okay <okay@toyful.space>2022-03-04 12:10:06 -0600
commit924896962c42acf55018521e9f08e5ba4b311903 (patch)
treedd073ba5fd6b9daa842991315ead1f2db70f9990 /build-app.lisp
parent1088702ed0c7f64f9fb9c5909ffec02b6b586924 (diff)
printout of oneliners updated
Diffstat (limited to 'build-app.lisp')
-rw-r--r--build-app.lisp52
1 files changed, 33 insertions, 19 deletions
diff --git a/build-app.lisp b/build-app.lisp
index 69338b1..3511a8c 100644
--- a/build-app.lisp
+++ b/build-app.lisp
@@ -61,9 +61,14 @@ you run the oneliner, all positional variables appear first.
;;; CLON SYNOPSIS DEFINITION
-(defsynopsis (:postfix "[TAGS ...] | N [ARGS ...]")
+(defsynopsis (:postfix "[ARGUMENTS ...]")
+
+
(group (:header "SEARCH OPTIONS")
- (text :contents "Return oneliners tagged with all of TAGS")
+ (text :contents "By default, ARGUMENTS are interpeted as search terms for oneliners. For example:")
+ (text :contents "$ ol grep awk # search for oneliners involving both grep and awk")
+ (text :contents " ")
+
(lispobj :long-name "limit"
:argument-type :optional
:argument-name "NUMBER"
@@ -71,20 +76,29 @@ you run the oneliner, all positional variables appear first.
:description "The maximum number of results to return."
:typespec 'integer)
(flag :long-name "all-flagged"
- :description "Return flagged oneliners. Ignores TAGS. Respects --limit")
+ :description "Return flagged oneliners.")
(flag :long-name "not-flagged"
:description "Request that no flagged oneliners are returned.")
(flag :long-name "newest"
- :description "Return newest oneliners. Ignores TAGs. Respects --limit up to server specified maxiumum."))
+ :description "Return newest oneliners."))
(text :contents " ")
- (group (:header "ONELINER EXECUTION OPTIONS")
- (text :contents "Runs the Nth search result with possible arguments ARGS.")
- (flag :long-name "id"
- :description "Refers a oneliner by its unique id instead of by result number.")
+
+
+ (group (:header "EXECUTION OPTIONS")
+ (text :contents "Several options override the default interpretation of ARGUMENTS.")
+ (text :contents "Execution options interpret the first argument as the identifier of a oneliner: ")
+ (text :contents "$ ol <EXECUTION OPTION> <NAME or ID> [MORE ARGUMENTS...]")
+ (text :contents " ")
+
+
+ (flag :long-name "run"
+ :description "Executes a oneliner by NAME or ID. See also help topic 'variables'.")
(flag :long-name "clip"
- :description "Put oneliner into clipboard instead of running it.")
- (flag :long-name "clear-cache"
- :description "Clears all cached search results from your system.")
+ :description "Like --run, but puts the oneliner into the clipboard."))
+ (text :contents " ")
+ (group (:header "OTHER OPTIONS")
+ (flag :long-name "info"
+ :description "View all info the oneliner given by NAME or ID")
(lispobj :long-name "timeout"
:argument-type :optional
:argument-name "SECONDS"
@@ -93,15 +107,15 @@ you run the oneliner, all positional variables appear first.
:description "How long to wait for standard output before giving up."))
(text :contents " ")
(group (:header "HELP OPTIONS")
- (flag :long-name "explain"
- :description "View oneliner explaination text.")
(flag :long-name "whois"
- :description "View information about a contributor. ARGS is just a contributor handle.")
- (enum :long-name "help"
- :enum '(:account :wiki :invites :variables)
- :argument-name "TOPIC"
- :description "Print help for a topic.
-Topics: wiki, account, invites, variables"))
+ :description "View information about a contributor. The first argument is a contributor handle.")
+ (flag :long-name "help"
+ :description "Print help for a topic. Topics: wiki, account, invites, variables"))
+
+ (group (:header "Advanced Options" :hidden t)
+ (flag :long-name "clear-cache"
+ :description "Clears all cached search results from your system."))
+
(group (:header "Variables" :hidden t)
(text :contents +oneliners-variables-help-text+))
(group (:header "Wiki" :hidden t)