Skip to content

Commit 159a615

Browse files
committed
Reinstate the old PktUART manpages to avoid 559 problems in the .po files.
(This is the actual number) Signed-off-by: andypugh <andy@bodgesoc.org>
1 parent 39eaa69 commit 159a615

3 files changed

Lines changed: 55 additions & 0 deletions

File tree

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
\# Author Boris Skegin
2+
\# Issued under the terms of the GPL v2 License or any later version
3+
.TH hm2_pktuart_read "3hm2" "2016-02-26" "LinuxCNC Documentation" "Hostmot2"
4+
.SH NAME
5+
6+
hm2_pktuart_read \- read data from a Hostmot2 UART buffer
7+
8+
.SH SYNTAX
9+
.nf
10+
.B #include <hostmot2-serial.h>
11+
.HP
12+
int hm2_pktuart_read(char *name, unsigned char data[], rtapi_u8 *num_frames, rtapi_u16 *max_frame_length, rtapi_u16 frame_sizes[])
13+
14+
.SH DESCRIPTION
15+
\fBhm2_pktuart_read\fR reads data from the PktUART "name".
16+
17+
DEPRECATED except in setup code.
18+
19+
Please see the combined document hm2_pktuart.3hm2
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
\# Author Boris Skegin
2+
\# Issued under the terms of the GPL v2 License or any later version
3+
.TH hm2_pktuart_send "3hm2" "2016-02-29" "LinuxCNC Documentation" "Hostmot2"
4+
.SH NAME
5+
6+
hm2_pktuart_send \- write data to a Hostmot2 PktUART
7+
8+
.SH SYNTAX
9+
.nf
10+
.B #include <hostmot2-serial.h>
11+
.HP
12+
int hm2_uart_send(char *name, unsigned char data[], rtapi_u8 *num_frames, rtapi_u16 frame_sizes[])
13+
14+
.SH DESCRIPTION
15+
\fBhm2_pktuart_send\fR writes "num_frames" of data to the PktUART "name" from the
16+
buffer "data" with frame sizes preset in "frame_sizes[]" array.
17+
18+
Please see the combined document hm2_pktuart.3hm2 for how to use this
19+
function.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
\# Author Boris Skegin
2+
\# Issued under the terms of the GPL v2 License or any later version
3+
.TH hm2_pktuart_setup "3hm2" "2016-02-29" "LinuxCNC Documentation" "Hostmot2"
4+
.SH NAME
5+
6+
hm2_pktuart_setup \- setup a Hostmot2 PktUART instance
7+
.SH SYNTAX
8+
.nf
9+
.B #include <hostmot2-serial.h>
10+
.HP
11+
int hm2_pktuart_setup(char *name, int bitrate, rtapi_s32 tx_mode, rtapi_s32 rx_mode, int txclear, int rxclear)
12+
13+
.SH DESCRIPTION
14+
\fBhm2_pktuart_setup\fR
15+
16+
Please see the combined document hm2_pktuart.3hm2 for how to use this
17+
function.

0 commit comments

Comments
 (0)