| README | Read about LINX for Linux |
| RELEASE_NOTES | Release Notes for this release, including the version |
| User's Guide | Guide how to use LINX for Linux (PDF version) |
| LINX Protocols | Description of the OS-independent LINX Protocols (PDF version) |
| ChangeLog | History of changes |
| Example linx_basic README | Example application, simple client/server communication |
| Example linx_bmark README | Example application with test statistics |
| Reference Documentation |
HTML versions of the LINX man-pages, see below.
(Also PDF versions are in the distribution) |
The User's Guide and the list below, contains hyperlinks to the HTML versions of the reference documentation, included in the distribution. Note that the MAN pages are the documentation source, and both PDF and HTML reference documentation must be recreated after updating the MAN pages.
The reference manual pages are in MAN-page format inside the doc/manNN/ directories. Those are the original files, accessed by the Linux "man" command, after setting MANPATH to include the LINX doc directory. Example, reading the top linx(7) reference page:
MANPATH=/YourPathToLinxDirectory/doc:$MANPATH man linx
Also HTML and PDF versions of the reference manual pages are included in the LINX distribution. They must be generated from the MAN pages with the scripts scripts/make_html and scripts/make_pdf, requiring tools which are not included. The HTML pages currently have nicer layout and include hyperlinks between the LINX manual pages. Please ignore other autogenerated hyperlinks; only links between the LINX pages work.
An application usually uses the LINX API function calls, but the underlying LINX Socket API is also available.
| linx(7) | Document which describes LINX and the LINX Socket API. The MAN pages below describe the LINX API. |
| linxcfg(1) | Command to create LINX links to other nodes |
| linxstat(1) | Command to see LINX statistics , both local and remote connections |
| linxdisc(8) | Daemon to discover LINX nodes and auto-create links to other nodes |
| linxdisc.conf(5) | Configuration file for linxdisc |
| linx.h(3) | Main LINX API header file (see also linx_types.h below) |
| linx_alloc(3) | Allocate a signal buffer - LINX API |
| linx_attach(3) | Attach to supervise another endpoint - LINX API |
| linx_close(3) | Remove a LINX endpoint - LINX API |
| linx_create_eth_link(3) | Create an Ethernet link in the Ethernet Connection Manager - LINX API |
| linx_destroy_eth_link(3) | Destory an Ethernet link in the Ethernet Connection Manager - LINX API |
| linx_detach(3) | Remove an attachment - LINX API (same man-page as attach) |
| linx_free_buf(3) | Free a signal buffer - LINX API |
| linx_free_name(3) | Free the name returned by linx_get_name - LINX API |
| linx_free_stat(3) | Free the statistics struct returned by linx_get_stat - LINX API |
| linx_get_descriptor(3) | Get underlying socket descriptor - LINX API |
| linx_get_name(3) | Get the name of a LINX endpoint, from the id - LINX API |
| linx_get_spid(3) | Get the identifier of the own LINX endpoint - LINX API |
| linx_get_stat(3) | Get the statistics about LINX - LINX API |
| linx_hunt(3) | Locate a LINX endpoint with a given name - LINX API |
| linx_hunt_from(3) | Locate a LINX endpoint, but set another to own the hunt - LINX API (same man-page as hunt) |
| linx_open(3) | Create own LINX endpoint; all other calls go through this endpoint - LINX API |
| linx_receive(3) | Receive a signal buffer; block if not yet arrived - LINX API |
| linx_receive_from(3) | Receive a signal buffer from specified endpoint - LINX API (same man-page as receive) |
| linx_receive_w_tmo(3) | Receive a signal buffer with timeout - LINX API (same man-page as receive) |
| linx_send(3) | Send a signal buffer to a LINX endpoint - LINX API |
| linx_sender(3) | Get the sender of a signal buffer - LINX API |
| linx_send_w_s(3) | Send a signal buffer, but set somebody else as sender - LINX API (same man-page as send) |
| linx_set_sigsize(3) | Resize a signal buffer - LINX API (same man-page as sigsize) |
| linx_sigsize(3) | Get the size of a signal buffer - LINX API |
| linx_types.h(3) | LINX data types |