chiark / gitweb /
Config inspection: Document the instance keys
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Tue, 10 Jan 2023 22:16:46 +0000 (22:16 +0000)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Wed, 11 Jan 2023 02:12:41 +0000 (02:12 +0000)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
server/server.rs

index 98181b9a9b659cc70a3cceca557380493d045e2c..595e6a08d64d6fae4d4a2f5f997605362caf17cb 100644 (file)
@@ -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>,
 }