-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
171 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1 @@ | ||
SUBDIRS = src | ||
ACLOCAL_AMFLAGS = -I m4 | ||
SUBDIRS = src man |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
dist_man_MANS = lxi_init.3 lxi_connect.3 lxi_disconnect.3 lxi_send.3 lxi_receive.3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
.TH "lxi_connect" "3" "28 March 2016" | ||
|
||
.SH "NAME" | ||
lxi_connect \- connect to LXI device | ||
|
||
.SH "SYNOPSIS" | ||
.PP | ||
.B #include <lxi.h> | ||
|
||
.B int lxi_connect(char *address); | ||
|
||
.SH "DESCRIPTION" | ||
.PP | ||
The | ||
.BR lxi_connect() | ||
function connects to a LXI device at IP address pointed to by | ||
.I address | ||
|
||
.SH "RETURN VALUE" | ||
|
||
Upon successful completion | ||
.BR lxi_connect() | ||
returns a new connection handle, or | ||
.BR LXI_ERROR | ||
if an error occurred. | ||
|
||
.SH "SEE ALSO" | ||
.BR lxi_send (3), | ||
.BR lxi_receive (3), | ||
.BR lxi_disconnect (3), |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
.TH "lxi_disconnect" "3" "28 March 2016" | ||
|
||
.SH "NAME" | ||
lxi_disconnect \- disconnect a LXI connection | ||
|
||
.SH "SYNOPSIS" | ||
.PP | ||
.B #include <lxi.h> | ||
|
||
.B int lxi_disconnect(int device); | ||
|
||
.SH "DESCRIPTION" | ||
.PP | ||
The | ||
.BR lxi_disconnect() | ||
function disconnects an existing LXI connection handle pointed to by | ||
.I device | ||
|
||
.SH "RETURN VALUE" | ||
|
||
Upon successful completion | ||
.BR lxi_disconnect() | ||
returns | ||
.BR LXI_OK | ||
, else | ||
.BR LXI_ERROR | ||
is returned if an error occurred. | ||
|
||
.SH "SEE ALSO" | ||
.BR lxi_send (3), | ||
.BR lxi_receive (3), | ||
.BR lxi_disconnect (3), |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
.TH "lxi_init" "3" "28 March 2016" | ||
|
||
.SH "NAME" | ||
lxi_init \- initialize LXI library | ||
|
||
.SH "SYNOPSIS" | ||
.PP | ||
.B #include <lxi.h> | ||
|
||
.B int lxi_init(void); | ||
|
||
.SH "DESCRIPTION" | ||
.PP | ||
The | ||
.BR lxi_init() | ||
function initializes the LXI library. This is required before calling any other available lxi functions. | ||
|
||
.SH "RETURN VALUE" | ||
|
||
Upon successful completion | ||
.BR lxi_init() | ||
returns | ||
.BR LXI_OK | ||
, or | ||
.BR LXI_ERROR | ||
if an error occurred. | ||
|
||
.SH "SEE ALSO" | ||
.BR lxi_connect (3), | ||
.BR lxi_send (3), | ||
.BR lxi_receive (3), | ||
.BR lxi_disconnect (3), |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
.TH "lxi_send" "3" "28 March 2016" | ||
|
||
.SH "NAME" | ||
lxi_receive \- receive message from LXI device | ||
|
||
.SH "SYNOPSIS" | ||
.PP | ||
.B #include <lxi.h> | ||
|
||
.B int lxi_receive(int device, char *message, int length, int timeout); | ||
|
||
.SH "DESCRIPTION" | ||
.PP | ||
The . | ||
.BR lxi_receive() | ||
function receives up to | ||
.I length | ||
bytes in the message buffer pointed to by | ||
.I message | ||
|
||
.PP | ||
The | ||
.I timeout | ||
is in milliseconds. | ||
|
||
.SH "RETURN VALUE" | ||
|
||
Upon successful completion | ||
.BR lxi_receive() | ||
returns the number of bytes successfully received, or | ||
.BR LXI_ERROR | ||
if an error occurred. | ||
|
||
.SH "SEE ALSO" | ||
.BR lxi_open (3), | ||
.BR lxi_send (3), | ||
.BR lxi_disconnect (3), |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
.TH "lxi_send" "3" "28 March 2016" | ||
|
||
.SH "NAME" | ||
lxi_send \- send message to LXI device | ||
|
||
.SH "SYNOPSIS" | ||
.PP | ||
.B #include <lxi.h> | ||
|
||
.B int lxi_send(int device, char *message, int length, int timeout); | ||
|
||
.SH "DESCRIPTION" | ||
.PP | ||
The | ||
.BR lxi_send() | ||
function sends | ||
.I length | ||
bytes from the message buffer pointed to by | ||
.I message | ||
|
||
.PP | ||
The | ||
.I timeout | ||
is in miliseconds. | ||
|
||
.SH "RETURN VALUE" | ||
|
||
Upon successful completion | ||
.BR lxi_send() | ||
returns the number of bytes successfully sent, or | ||
.BR LXI_ERROR | ||
if an error occurred. | ||
|
||
.SH "SEE ALSO" | ||
.BR lxi_open (3), | ||
.BR lxi_receive (3), | ||
.BR lxi_disconnect (3), |