chiark / gitweb /
prefs docs: Describe the prefs.toml format in the usage message
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Mon, 7 Jun 2021 00:39:50 +0000 (01:39 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Mon, 7 Jun 2021 00:39:50 +0000 (01:39 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
cli/otter.rs

index eb20af3ac365b6677fa7af8bdff9d0fa96690531..f76f2d0659853df73822785a5b2b92048fe855ad 100644 (file)
@@ -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())