summaryrefslogtreecommitdiff
path: root/noncore/net/wellenreiter/libwellenreiter/docs
Side-by-side diff
Diffstat (limited to 'noncore/net/wellenreiter/libwellenreiter/docs') (more/less context) (ignore whitespace changes)
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/quickintro88
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/wl_conf.817
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/wl_log.812
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/wl_sniff.821
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.826
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/wl_types.825
6 files changed, 0 insertions, 189 deletions
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/quickintro b/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
deleted file mode 100644
index 97458b7..0000000
--- a/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
+++ b/dev/null
@@ -1,88 +0,0 @@
-
-Name: libwellenreiter
-Author: Martin J. Muench
-
-NOTE: This is just a very short summary of the functions included
-in libwellenreiter, written because a lack of time. The whole
-library will be rewritten with extended documentation and
-test programs.
-
---
-Wellenreiter types:
-In proto.hh the following type (wl_network_t) is declared:
-
-typedef struct {
- int net_type; /* 1 = Accesspoint ; 2 = Ad-Hoc */
- int ssid_len; /* Length of SSID */
- int channel; /* Channel */
- int wep; /* 1 = WEP enabled ; 0 = disabled */
- char mac[64]; /* MAC address of Accesspoint */
- char bssid[128]; /* BSSID of Accesspoint */
-} wl_network_t;
-
-When a network is found, the structure has to be set and
-sent to the send_network_found() function.
-
-When the GUI receives a found network string it calls the
-get_network_found() function to get its own structure set.
-
---
-Included functions:
-
---
-Protocol:
-
-Send a found network to GUI:
-int send_network_found (const char *, int, void *);
-
-The first two arguments are the guihost and the guiport.
-The third is the filled structure (wl_network_t), that will
-be send to the GUI.
-
-Setup structure for found network:
-int get_network_found (void *, const char *);
-
-When the GUI receives a new network found packet it calls
-this function and passes a wl_network_t structure and the
-received buffer. The function will strip the data from
-the buffer and set it to the structure.
-
---
-Log to syslog/info:
-void wl_loginfo(const char *, ...);
-
-Log to syslog/err:
-void wl_logerr(const char *, ...);
-
-Use like printf() function with format strings and so on.
-
---
-Setup udp socket for incoming commands:
-int commsock(const char *, int);
-
-Fist argument is the host where it should listen and second
-is the port. Socket is returned, on failure -1 is returned.
-
-
-Recvfrom socket:
-int recv_commsock(int *, char *, int);
-
-First argument is the address of the socket, second is a buffer
-that should be filled in and the third is the maxlength of the
-buffer. On error, -1 is returned, on success the number of
-packet type is returned. (return value should be used with switch
-command, for types see proto.hh)
-
-Send command to udp socket:
-int sendcomm(const char *, int, const char *, ...);
-
-First two arguments are the host and port where the command should
-be send to, followed by buffer that should be send. On error, -1
-is returned.
-
-
----
-
-Thats it for the moment.
-
-mjm.
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/wl_conf.8 b/noncore/net/wellenreiter/libwellenreiter/docs/wl_conf.8
deleted file mode 100644
index 8d2fe27..0000000
--- a/noncore/net/wellenreiter/libwellenreiter/docs/wl_conf.8
+++ b/dev/null
@@ -1,17 +0,0 @@
-wl_conf
-
-#include <wellenreiter/wl_conf.hh>
-
-int wl_checkcfg(void);
-int wl_cfgvalue(const char *token, char *out, int maxlen);
-
-wl_checkcfg checks whether the wellenreiter configfile exists.
-wl_cfgvalue searches for the given token and copies maxlen
-characters of its value to out.
-
-wl_ckeckcfg returns 1 if the file exists and is readable and
-0 on error.
-
-wl_cfgvalue returns -1 on error, 0 if nothing was found and
-1 on success.
-
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/wl_log.8 b/noncore/net/wellenreiter/libwellenreiter/docs/wl_log.8
deleted file mode 100644
index 00262bd..0000000
--- a/noncore/net/wellenreiter/libwellenreiter/docs/wl_log.8
+++ b/dev/null
@@ -1,12 +0,0 @@
-wl_log
-
-#include <wellenreiter/wl_log.hh>
-
-void wl_loginfo(const char *string, ...)
-void wl_logerr(const char *string, ...)
-
-wl_loginfo() and wl_err() write string to syslog(),
-either to INFO or to ERR.
-
-no return values
-
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/wl_sniff.8 b/noncore/net/wellenreiter/libwellenreiter/docs/wl_sniff.8
deleted file mode 100644
index 9a65223..0000000
--- a/noncore/net/wellenreiter/libwellenreiter/docs/wl_sniff.8
+++ b/dev/null
@@ -1,21 +0,0 @@
-sniff.cc
-
-#include <wellenreiter/sniff.hh>
-
-void process_packets(const struct pcap_pkthdr *pkthdr,
- const unsigned char *packet,
- char *guihost,
- int guiport)
-
-The function process_packets() will use libpcap to get the
-informations for a 802.11b packet. When it finds a valid
-network it calls the wl_send function and sends a found
-network packet to the guiport on the guihost.
-
-
-Return value
-
-none
-
-NOTE: process_packets() is void at the moment because there
-will be alot of non-critical and annoying errors.
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8 b/noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8
deleted file mode 100644
index 62e935b..0000000
--- a/noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8
+++ b/dev/null
@@ -1,26 +0,0 @@
-wl_sock
-
-#include <wellenreiter/wl_sock.hh>
-
-int wl_setupsock(const char *host, int port, struct sockaddr_in *)
-int wl_send(const char *host, int port, const char *string, ...)
-int wl_recv(int *socket, struct sockaddr_in *, char *out, int len)
-
-
-wl_setupsock() returns the number of the activated udp socket.
-
-wl_send() sends string to the given host.
-
-wl_recv() checks for incoming data on a socket (created using
-wl_setupsock()). It writes the incoming data to out with a
-maxlen of len.
-
-
-wl_setupsock() returns -1 on error and the number of socket on
-success.
-wl_send() returns 0 on error and 1 on success.
-wl_recv() returns -1 on error and the type of the received packet
-on success.
-
-Note: To use this function you have to set a sockaddr_in structure
-and pass it to wl_setupsock and wl_receive.
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/wl_types.8 b/noncore/net/wellenreiter/libwellenreiter/docs/wl_types.8
deleted file mode 100644
index d12f564..0000000
--- a/noncore/net/wellenreiter/libwellenreiter/docs/wl_types.8
+++ b/dev/null
@@ -1,25 +0,0 @@
-wl_types.hh
-
-wl_types.hh contains the global buffers and type definitions.
-
-At the moment these are:
-
-/* Type definitions, to be continued */
-#define WL_NETFOUND 01
-#define WL_NETLOST 02
-#define WL_STARTSNIFF 98
-#define WL_STOPSNIFF 99
-
-#define WL_SOCKBUF 512 /* Buffer for wl_send and wl_recv calls */
-
-/* WL network structure */
-typedef struct {
- int net_type; /* 1 = Accesspoint ; 2 = Ad-Hoc */
- int ssid_len; /* Length of SSID */
- int channel; /* Channel */
- int wep; /* 1 = WEP enabled ; 0 = disabled */
- char mac[64]; /* MAC address of Accesspoint */
- char bssid[128]; /* BSSID of Net */
-} wl_network_t;
-
-Will be filled up with other structs and size definitions asap.