| 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) |
| User's Guide for LINX Gateway | Guide how to use LINX Gateway (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 Doc (PDF) | See below for HTML versions of the man-pages |
The User's Guide and these lists contain hyperlinks to the PDF and HTML versions of the reference documentation, included in the distribution. Note that the MAN pages are the documentation source. For the User's Guide and the LINX Protocol specification, the HTML version are originals. After any updates, the scripts/make_linx_doc shall be run to recreate the HTML reference documentation and the PDF versions of the User's Guide, the LINX protocols and the MAN pages. This script requires the tools rman and htmldoc.
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_linx_doc. Please ignore some autogenerated hyperlinks to external Linux MAN pages; only links between the LINX MAn pages work.
An application usually uses the LINX API function calls, but the underlying LINX Socket API is also available.
| Reference Doc (PDF) | All LINX MAN pages in one PDF file. Others below are HTML. |
| 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 |
| mkethcon(1) | Command to create LINX ethernet connections |
| mklink(1) | Command to create LINX links |
| mktcpcon(1) | Command to create LINX TCP connections |
| mkshmcon(1) | Command to create LINX Shared Memory connections |
| mkriocon(1) | Command to create LINX RapidIO connections |
| mkcmclcon(1) | Command to create LINX Connection Manager Control Layer connections |
| rmethcon(1) | Command to destroy LINX ethernet connections |
| rmlink(1) | Command to destroy LINX links |
| rmtcpcon(1) | Command to destroy LINX TCP connections |
| rmshmcon(1) | Command to destroy LINX Shared Memory connections |
| rmriocon(1) | Command to destroy LINX RapidIO connections |
| rmcmclcon(1) | Command to destroy LINX Connection Manager Control Layer connections |
| linxgwcmd(1) | Command to find and test Gateway servers |
| linxgws(8) | Command to start the Gateway server |
| linxgws.conf(5) | Configuration file for Gateway server |
| 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_cancel_new_link(3) | Cancel the new link signal request - LINX API (same man-page as request_newlink) |
| linx_cancel_tmo(3) | Cancel the specified timeout - LINX API (same man-page as request_tmo) |
| linx_close(3) | Remove a LINX endpoint - 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_request_new_link(3) | Request a new link notification - LINX API |
| linx_modify_tmo(3) | Modify the specified timeout - LINX API (same man-page as request_tmo) |
| 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_request_tmo(3) | Request timeout with specified signal - LINX API |
| 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_opt(3) | Send a signal buffer, with alternative methods - LINX API (same man-page as send) |
| 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_sigattr(3) | Get an attribute of a signal buffer - LINX API |
| linx_sigsize(3) | Get the size of a signal buffer - LINX API |
| linx_types.h(3) | LINX data types |