From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Tue, 10 Jan 2023 22:16:46 +0000 (+0000)
Subject: Config inspection: Document the instance keys
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;h=10213944fefd1dbec661663532a0b91504c1fa23;p=hippotat.git

Config inspection: Document the instance keys

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

diff --git a/server/server.rs b/server/server.rs
index 98181b9..595e6a0 100644
--- a/server/server.rs
+++ b/server/server.rs
@@ -44,6 +44,11 @@ pub struct Opts {
   /// If none of the specified config keys are client-specific,
   /// only one line will be printed.  Otherwise the output will
   /// have one line per client association.
+  ///
+  /// Additional pseudo-config-keys are recognised:
+  /// `client`: our client virtual IP address;
+  /// `server`: server's logical name in the config;
+  /// `link`: the link name including the `[ ]`.
   #[clap(long)]
   print_config: Option<String>,
 }