summaryrefslogtreecommitdiff
path: root/doc/libwpactrl/index.html
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2017-08-10 21:41:58 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2017-08-10 21:41:58 +0000
commita759f40b5224c6337dc64a57db66937c3de42e9c (patch)
tree64ec4da81adfbd6744b516fb0470f51ee58c9239 /doc/libwpactrl/index.html
parent4d7c6aabeb10eee1cd2348af9224798c41849b14 (diff)
downloadbcnm-a759f40b5224c6337dc64a57db66937c3de42e9c.tar.xz
More doc
Diffstat (limited to 'doc/libwpactrl/index.html')
-rw-r--r--doc/libwpactrl/index.html14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/libwpactrl/index.html b/doc/libwpactrl/index.html
index d3a3424..7a0a644 100644
--- a/doc/libwpactrl/index.html
+++ b/doc/libwpactrl/index.html
@@ -147,7 +147,7 @@ the answer is bigger than <em>anslen</em> bytes.
</p>
<p>
-<code> ssize_t wpactrl_querysa (wpactrl_t *a, char const *q, stralloc *sa, tain_t *stamp) </code> <br />
+<code> int wpactrl_querysa (wpactrl_t *a, char const *q, stralloc *sa, tain_t *stamp) </code> <br />
Sends the query <em>q</em> to the connected instance
of wpa_supplicant, and reads its answer into the
<a href="//skarnet.org/software/skalibs/libstddjb/stralloc.html">stralloc</a>
@@ -472,5 +472,17 @@ written the results to the auxiliary pointer. <em>dt</em> can now be ignored. </
error. </li>
</ul>
+<h2> A working example </h2>
+
+<p>
+ The provided
+ <a href="bcnm-wpactrl-scan.c.txt">bcnm-wpactrl-scan.c</a>
+file is an example on how to program with
+<a href="//skarnet.org/software/skalibs/">skalibs</a> and libwpactrl. It connects to
+a wpa_supplicant instance (it takes the path to the Unix socket to wpa_supplicant as
+an argument), requests a scan, waits for the scan results with a timeout of 10
+seconds, and prints the results as is on its standard output.
+</p>
+
</body>
</html>