nixos/doc: Clarify wireless examples

This commits makes it clearer to a novice reader how to configure several diferent types of SSID connections that were otherwise obscurely documented Resolves #66650
2019-09-26 22:52:21 -04:00
parent bc0072305b
commit cce7486deb
2 changed files with 21 additions and 4 deletions
@@ -19,10 +19,17 @@
  NixOS lets you specify networks for wpa_supplicant declaratively:
 <programlisting>
 <xref linkend="opt-networking.wireless.networks"/> = {
-  echelon = {
+  echelon = {                # SSID with no spaces or special characters
    psk = "abcdefgh";
  };
-  "free.wifi" = {};
+  "echelon's AP" = {         # SSID with spaces and/or special characters
+    psk = "ijklmnop";
+  };
+  echelon = {                # Hidden SSID
+    hidden = true;
+    psk = "qrstuvwx";
+  };
+  free.wifi = {};            # Public wireless network
 };
 </programlisting>
  Be aware that keys will be written to the nix store in plaintext! When no