From a9b8ac50daf0cd28034c310dc1cda07ba9a2fc0c Mon Sep 17 00:00:00 2001
From: Marc Coquand <marc@mccd.space>
Date: Thu, 16 May 2024 09:29:19 -0500
Subject: Document environment variables

---
 bin/main.ml | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

(limited to 'bin')

diff --git a/bin/main.ml b/bin/main.ml
index 1fba7a3..cda58ca 100644
--- a/bin/main.ml
+++ b/bin/main.ml
@@ -7,10 +7,61 @@ let tag_arg =
 
 let headlines_t = Term.(const Stitch.start $ tag_arg $ const ())
 
+let envs =
+  let docs = "ENVIRONMENT VARIABLES" in
+  [ Cmd.Env.info
+      ~docs
+      ~doc:
+        "Directory where Stitch should search for notes. Needs to be set in order for \
+         the program to work. Must be absolute path, I.E /home/bob/notes"
+      "STITCH_DIRECTORY"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:
+        "Grep command to use (defaults to \"grep\"). Stitch also works well with ugrep, \
+         which greatly speeds up the program."
+      "STITCH_GREP_CMD"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:"Pattern to use for headlines. (Default \"* \")"
+      "STITCH_HEADLINE_PATTERN"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:
+        "Pattern to use by grep to fetch headlines. Needs to be double escaped for \
+         OCaml. (Default \"^\\* \")"
+      "STITCH_HEADLINE_PATTERN_REGEXP"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:"Pattern used by grep to find tags. (Default \":[a-z-]+:\", matches :a-tag:"
+      "STITCH_TAG_PATTERN"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:"Pattern for TODOS. Used for substitution. (Default \"* TODO\")"
+      "STITCH_TODO"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:
+        "Regexp used by grep to find TODO items. Needs to be double escaped for OCaml. \
+         (Default \"^\\* TODO\")"
+      "STITCH_TODO_REGEXP"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:"Pattern for DONE items. Used for substitution. (Default \"* DONE\")"
+      "STITCH_DONE"
+  ; Cmd.Env.info
+      ~docs
+      ~doc:
+        "Regexp used by grep to find DONE items. Needs to be double escaped for OCaml. \
+         (Default \"^\\* DONE\")"
+      "STITCH_DONE_REGEXP"
+  ]
+
+
 let headlines_cmd =
   let doc = "Show titles in a condensed list" in
   let man = [ `S Manpage.s_bugs; `P "Email bug reports to marc@mccd.space" ] in
-  let info = Cmd.info "headlines" ~version:"0.1" ~doc ~man in
+  let info = Cmd.info ~envs "headlines" ~version:"0.1" ~doc ~man in
   Cmd.v info headlines_t
 
 
-- 
cgit v1.2.3