summary refs log tree commit diff
diff options
context:
space:
mode:
authorTobias Geerinckx-Rice <me@tobias.gr>2021-10-30 15:48:48 +0200
committerTobias Geerinckx-Rice <me@tobias.gr>2021-10-31 00:57:07 +0200
commit943dd59beb5b30437f940405fd2b56fea73764cb (patch)
treebb393100c8d03648e761bc5fb562d3b9d36f4a34
parentc73d1e68cf64d108ed9e6433b286f03da1f16d54 (diff)
downloadguix-943dd59beb5b30437f940405fd2b56fea73764cb.tar.gz
ui: Add top-level options to help text.
This also makes automated ‘guix --h<Tab>’ completion possible.

* guix/ui.scm (show-guix-help): Document that an OPTION's an option,
and all valid options.
-rw-r--r--guix/ui.scm11
1 files changed, 9 insertions, 2 deletions
diff --git a/guix/ui.scm b/guix/ui.scm
index eb7f0afcfd..4b4f21d32c 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -2098,8 +2098,15 @@ contain a 'define-command' form."
     (lambda (command)
       (eq? category (command-category command))))
 
-  (format #t (G_ "Usage: guix COMMAND ARGS...
-Run COMMAND with ARGS.\n"))
+  (format #t (G_ "Usage: guix OPTION | COMMAND ARGS...
+Run COMMAND with ARGS, if given.\n"))
+
+  (display (G_ "
+  -h, --help             display this helpful text again and exit"))
+  (display (G_ "
+  -V, --version          display version and copyright information and exit"))
+  (newline)
+
   (newline)
   (format #t (G_ "COMMAND must be one of the sub-commands listed below:\n"))