summary refs log tree commit diff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2016-11-24 21:53:57 +0100
committerLudovic Courtès <ludo@gnu.org>2016-11-24 21:53:57 +0100
commitcbf1024e9907c7402e66c0c225dba7406fbd82e8 (patch)
tree332ccf548e65e545144859c62b675876dc3a7cbf
parent030f59fac939b4c747f3fa8037b2db6c1030f0eb (diff)
downloadguix-cbf1024e9907c7402e66c0c225dba7406fbd82e8.tar.gz
doc: Document 'wpa-supplicant-service-type'.
Reported by Chris Marusich <cmmarusich@gmail.com>.

* doc/guix.texi (Networking Services): Remove 'wpa-supplicant-service'
procedure, which doesn't exist, and document
'wpa-supplicant-service-type'.
-rw-r--r--doc/guix.texi19
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 0055d094e8..4d9c107a9c 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -8431,13 +8431,22 @@ configure networking."
 @end deffn
 
 @cindex WPA Supplicant
-@deffn {Scheme Procedure} wpa-supplicant-service @
-       [#:wpa-supplicant @var{wpa-supplicant}]
-Return a service that runs @url{https://w1.fi/wpa_supplicant/,WPA
+@defvr {Scheme Variable} wpa-supplicant-service-type
+This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA
 supplicant}, an authentication daemon required to authenticate against
-encrypted WiFi or ethernet networks. Service is started to listen for
+encrypted WiFi or ethernet networks.  It is configured to listen for
 requests on D-Bus.
-@end deffn
+
+The value of this service is the @code{wpa-supplicant} package to use.
+Thus, it can be instantiated like this:
+
+@lisp
+(use-modules (gnu services networking)
+             (gnu packages admin))
+
+(service wpa-supplicant-type wpa-supplicant)
+@end lisp
+@end defvr
 
 @cindex NTP
 @cindex real time clock