From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Mon, 7 Jun 2021 00:39:50 +0000 (+0100)
Subject: prefs docs: Describe the prefs.toml format in the usage message
X-Git-Tag: otter-0.7.0~51
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=95b89e8e3432d2b57745edfbf073ac356521164b;p=otter.git

prefs docs: Describe the prefs.toml format in the usage message

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/cli/otter.rs b/cli/otter.rs
index eb20af3a..f76f2d06 100644
--- a/cli/otter.rs
+++ b/cli/otter.rs
@@ -324,6 +324,11 @@ fn main() {
   };
 
   let extra_help: ExtraMessage = &|w|{
+    write!(w, r#"
+PREFS is a TOML file containing a table [options].  The entries in options
+are named after long command line options.   The values are the corresponding
+option values; or`true` and `false` for just --option or --no-option.
+"#)?;
     writeln!(w, "\nSubcommands:")?;
     let maxlen = inventory::iter::<Subcommand>.into_iter()
       .map(|Subcommand{verb,..}| verb.len())