about summary refs log tree commit diff
path: root/nixos/doc
diff options
context:
space:
mode:
authorCraige McWhirter <craige@mcwhirter.io>2019-08-15 08:29:13 +1000
committerworldofpeace <worldofpeace@protonmail.ch>2019-09-26 22:52:21 -0400
commitcce7486deb2be3375c0a58899af5e5ff802bf869 (patch)
treef226c4d406a561043c811a84e6f3ac96ac4d5ac9 /nixos/doc
parentbc0072305bfb0203c7624cf3a78b0ed533c590fe (diff)
downloadnixlib-cce7486deb2be3375c0a58899af5e5ff802bf869.tar
nixlib-cce7486deb2be3375c0a58899af5e5ff802bf869.tar.gz
nixlib-cce7486deb2be3375c0a58899af5e5ff802bf869.tar.bz2
nixlib-cce7486deb2be3375c0a58899af5e5ff802bf869.tar.lz
nixlib-cce7486deb2be3375c0a58899af5e5ff802bf869.tar.xz
nixlib-cce7486deb2be3375c0a58899af5e5ff802bf869.tar.zst
nixlib-cce7486deb2be3375c0a58899af5e5ff802bf869.zip
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
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/configuration/wireless.xml11
1 files changed, 9 insertions, 2 deletions
diff --git a/nixos/doc/manual/configuration/wireless.xml b/nixos/doc/manual/configuration/wireless.xml
index 9c0e3a8d7aa4..247d29d58314 100644
--- a/nixos/doc/manual/configuration/wireless.xml
+++ b/nixos/doc/manual/configuration/wireless.xml
@@ -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