misc.online: Support for `auto`

[nailing-cargo.git] / README.md

diff --git a/README.md b/README.md
index c108724af7582f0bca2da8b9cbc7aa155db077bd..c4b414727e9794dedcdc265fa98a044254d55bd2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -516,11 +516,16 @@ other names are not looked up in this alias map.
 `[misc]`: Miscellaneous individual nailing-cargo config
 -------------------------------------------------------
 
- * <a name="misc_online">`online`</a>: boolean, specifying whether to
-   pass `--offline` to cargo (cargo's default is online mode).  The
-   default is offline, unless nailing-cargo can see that the cargo
-   subcommand being invoked is one which requires online access, in
-   which case the default is online.
+ * <a name="misc_online">`online`</a>:
+
+   Specifies whether to allow or prevent cargo from accessing the
+   network.  Value is a boolean or `'auto'`.  `'auto'` permits online
+   access if the cargo subcommand being invoked is one whose main
+   purpose involves online access.
+
+   Implemented by passing `--offline` to cargo when necessary ---
+   cargo's default is online.  nailing-cargo's default is
+   `'auto'`.
 
 Limitations and bugs
 ====================