diff --git a/doc/modbus_close.txt b/doc/modbus_close.txt index 485915f..cf150d3 100644 --- a/doc/modbus_close.txt +++ b/doc/modbus_close.txt @@ -9,7 +9,7 @@ modbus_close - close a Modbus connection SYNOPSIS -------- -*int modbus_close(*modbus_t 'ctx');* +*int modbus_close(modbus_t *'ctx');* DESCRIPTION diff --git a/doc/modbus_connect.txt b/doc/modbus_connect.txt index f03361b..4c8ac96 100644 --- a/doc/modbus_connect.txt +++ b/doc/modbus_connect.txt @@ -9,7 +9,7 @@ modbus_connect - establish a Modbus connection SYNOPSIS -------- -*int modbus_connect(*modbus_t 'ctx');* +*int modbus_connect(modbus_t *'ctx');* DESCRIPTION diff --git a/doc/modbus_flush.txt b/doc/modbus_flush.txt index be7cefc..5ccc2f5 100644 --- a/doc/modbus_flush.txt +++ b/doc/modbus_flush.txt @@ -9,7 +9,7 @@ modbus_flush - flush non-transmitted data SYNOPSIS -------- -*int modbus_flush(*modbus_t 'ctx');* +*int modbus_flush(modbus_t *'ctx');* DESCRIPTION diff --git a/doc/modbus_free.txt b/doc/modbus_free.txt index 7f97dfd..af1845d 100644 --- a/doc/modbus_free.txt +++ b/doc/modbus_free.txt @@ -9,7 +9,7 @@ modbus_free - free a libmodbus context SYNOPSIS -------- -*void modbus_free(*modbus_t 'ctx');* +*void modbus_free(modbus_t *'ctx');* DESCRIPTION diff --git a/doc/modbus_get_byte_timeout.txt b/doc/modbus_get_byte_timeout.txt index 4ce9dd1..41f4ae0 100644 --- a/doc/modbus_get_byte_timeout.txt +++ b/doc/modbus_get_byte_timeout.txt @@ -9,7 +9,7 @@ modbus_get_byte_timeout - get timeout between bytes SYNOPSIS -------- -*void modbus_get_byte_timeout(*modbus_t 'ctx', struct timeval *'timeout');* +*void modbus_get_byte_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION diff --git a/doc/modbus_get_response_timeout.txt b/doc/modbus_get_response_timeout.txt index 0e5138a..f48898f 100644 --- a/doc/modbus_get_response_timeout.txt +++ b/doc/modbus_get_response_timeout.txt @@ -9,7 +9,7 @@ modbus_get_response_timeout - get timeout for response SYNOPSIS -------- -*void modbus_get_response_timeout(*modbus_t 'ctx', struct timeval *'timeout');* +*void modbus_get_response_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION diff --git a/doc/modbus_new_rtu.txt b/doc/modbus_new_rtu.txt index 9e5cf94..c4e791c 100644 --- a/doc/modbus_new_rtu.txt +++ b/doc/modbus_new_rtu.txt @@ -9,7 +9,7 @@ modbus_new_rtu - create a libmodbus context for RTU SYNOPSIS -------- -*modbus_t modbus_new_rtu(const char *'device', int 'baud', char 'parity', int 'data_bit', int 'stop_bit');* +*modbus_t *modbus_new_rtu(const char *'device', int 'baud', char 'parity', int 'data_bit', int 'stop_bit');* diff --git a/doc/modbus_new_tcp.txt b/doc/modbus_new_tcp.txt index 220e037..767de7d 100644 --- a/doc/modbus_new_tcp.txt +++ b/doc/modbus_new_tcp.txt @@ -9,7 +9,7 @@ modbus_new_tcp - create a libmodbus context for TCP/IPv4 SYNOPSIS -------- -*modbus_t modbus_new_tcp(const char *'ip', int 'port');* +*modbus_t *modbus_new_tcp(const char *'ip', int 'port');* DESCRIPTION diff --git a/doc/modbus_new_tcp_pi.txt b/doc/modbus_new_tcp_pi.txt index fa3cc92..7f64b4f 100644 --- a/doc/modbus_new_tcp_pi.txt +++ b/doc/modbus_new_tcp_pi.txt @@ -9,7 +9,7 @@ modbus_new_tcp_pi - create a libmodbus context for TCP Protocol Independent SYNOPSIS -------- -*modbus_t modbus_new_tcp_pi(const char *'node', const char *'service');* +*modbus_t *modbus_new_tcp_pi(const char *'node', const char *'service');* DESCRIPTION diff --git a/doc/modbus_receive.txt b/doc/modbus_receive.txt index 8ee6591..ec78a98 100644 --- a/doc/modbus_receive.txt +++ b/doc/modbus_receive.txt @@ -9,7 +9,7 @@ modbus_receive - receive a indication request SYNOPSIS -------- -*int modbus_receive(*modbus_t 'ctx', uint8_t *'req');* +*int modbus_receive(modbus_t *'ctx', uint8_t *'req');* DESCRIPTION diff --git a/doc/modbus_receive_confirmation.txt b/doc/modbus_receive_confirmation.txt index 1764654..bc7db6e 100644 --- a/doc/modbus_receive_confirmation.txt +++ b/doc/modbus_receive_confirmation.txt @@ -9,7 +9,7 @@ modbus_receive_confirmation - receive a confirmation request SYNOPSIS -------- -*int modbus_receive_confirmation(*modbus_t 'ctx', uint8_t *'rsp');* +*int modbus_receive_confirmation(modbus_t *'ctx', uint8_t *'rsp');* DESCRIPTION diff --git a/doc/modbus_receive_from.txt b/doc/modbus_receive_from.txt index 8d4520a..4f5ffab 100644 --- a/doc/modbus_receive_from.txt +++ b/doc/modbus_receive_from.txt @@ -9,7 +9,7 @@ modbus_receive_from - receive a indication request from a socket SYNOPSIS -------- -*int modbus_receive_from(*modbus_t 'ctx', int sockfd, uint8_t *'req');* +*int modbus_receive_from(modbus_t *'ctx', int sockfd, uint8_t *'req');* DESCRIPTION diff --git a/doc/modbus_reply_exception.txt b/doc/modbus_reply_exception.txt index 9287708..9f9f261 100644 --- a/doc/modbus_reply_exception.txt +++ b/doc/modbus_reply_exception.txt @@ -41,7 +41,7 @@ successful. Otherwise it shall return -1 and set errno. ERRORS ------ -EINVAL:: +*EINVAL*:: The exception code is invalid diff --git a/doc/modbus_rtu_get_serial_mode.txt b/doc/modbus_rtu_get_serial_mode.txt index beab123..5ee3bb0 100644 --- a/doc/modbus_rtu_get_serial_mode.txt +++ b/doc/modbus_rtu_get_serial_mode.txt @@ -9,7 +9,7 @@ modbus_rtu_get_serial_mode - get the current serial mode SYNOPSIS -------- -*int modbus_rtu_get_serial_mode(*modbus_t 'ctx');* +*int modbus_rtu_get_serial_mode(modbus_t *'ctx');* DESCRIPTION @@ -30,7 +30,8 @@ currently used by the libmodbus context: automation because it can be used effectively over long distances and in electrically noisy environments. -This function is only available on Linux kernels 2.6.28 onwards. +This function is only available on Linux kernels 2.6.28 onwards and can only be +used with a context using a RTU backend. RETURN VALUE diff --git a/doc/modbus_rtu_set_serial_mode.txt b/doc/modbus_rtu_set_serial_mode.txt index 3728c37..5739fb5 100644 --- a/doc/modbus_rtu_set_serial_mode.txt +++ b/doc/modbus_rtu_set_serial_mode.txt @@ -9,7 +9,7 @@ modbus_rtu_set_serial_mode - set the serial mode SYNOPSIS -------- -*int modbus_rtu_set_serial_mode(*modbus_t 'ctx');* +*int modbus_rtu_set_serial_mode(modbus_t *'ctx');* DESCRIPTION diff --git a/doc/modbus_send_raw_request.txt b/doc/modbus_send_raw_request.txt index 84b5b9a..0b884ed 100644 --- a/doc/modbus_send_raw_request.txt +++ b/doc/modbus_send_raw_request.txt @@ -9,7 +9,7 @@ modbus_send_raw_request - send a raw request SYNOPSIS -------- -*int modbus_send_raw_request(*modbus_t 'ctx', uint8_t *'raw_req, int 'raw_req_length');* +*int modbus_send_raw_request(modbus_t *'ctx', uint8_t *'raw_req, int 'raw_req_length');* DESCRIPTION diff --git a/doc/modbus_set_byte_timeout.txt b/doc/modbus_set_byte_timeout.txt index 50da367..c1b8297 100644 --- a/doc/modbus_set_byte_timeout.txt +++ b/doc/modbus_set_byte_timeout.txt @@ -9,7 +9,7 @@ modbus_set_byte_timeout - set timeout between bytes SYNOPSIS -------- -*void modbus_set_byte_timeout(*modbus_t 'ctx', struct timeval *'timeout');* +*void modbus_set_byte_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION diff --git a/doc/modbus_set_debug.txt b/doc/modbus_set_debug.txt index 840a358..9ca161f 100644 --- a/doc/modbus_set_debug.txt +++ b/doc/modbus_set_debug.txt @@ -8,7 +8,7 @@ modbus_set_debug - set debug flag of the context SYNOPSIS -------- -*void modbus_set_debug(*modbus_t 'ctx', int 'boolean');* +*void modbus_set_debug(modbus_t *'ctx', int 'boolean');* DESCRIPTION diff --git a/doc/modbus_set_response_timeout.txt b/doc/modbus_set_response_timeout.txt index 82b3387..9baf03d 100644 --- a/doc/modbus_set_response_timeout.txt +++ b/doc/modbus_set_response_timeout.txt @@ -9,7 +9,7 @@ modbus_set_response_timeout - set timeout for response SYNOPSIS -------- -*void modbus_set_response_timeout(*modbus_t 'ctx', struct timeval *'timeout');* +*void modbus_set_response_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION