Skip to content

Commit 319f60b

Browse files
Improve io(1) and iov2(1) manual pages
Remove duplicate entries under "Additional IO v2 pins" in iov2 and add missing periods at the end of sentences in both io(1) and iov2(1) to make sure the identical strings stay the same to save translators duplicate work.
1 parent 3ca43ad commit 319f60b

2 files changed

Lines changed: 17 additions & 65 deletions

File tree

docs/man/man1/io.1

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ unless an absolute path is specified.
2626

2727
.TP
2828
\fBiocontrol.0.coolant\-flood
29-
(Bit, Out) TRUE when flood coolant is requested
29+
(Bit, Out) TRUE when flood coolant is requested.
3030

3131
.TP
3232
\fBiocontrol.0.coolant\-mist
33-
(Bit, Out) TRUE when mist coolant is requested
33+
(Bit, Out) TRUE when mist coolant is requested.
3434

3535
.TP
3636
\fBiocontrol.0.emc\-enable\-in
@@ -49,19 +49,19 @@ into E-stop, and when the "Lube Off" command gets sent to the controller.
4949

5050
.TP
5151
\fBiocontrol.0.tool\-change
52-
(Bit, Out) TRUE when a tool change is requested
52+
(Bit, Out) TRUE when a tool change is requested.
5353

5454
.TP
5555
\fBiocontrol.0.tool\-changed
5656
(Bit, In) Should be driven TRUE when a tool change is completed.
5757

5858
.TP
5959
\fBiocontrol.0.tool\-number
60-
(s32, Out) Current tool number
60+
(s32, Out) Current tool number.
6161

6262
.TP
6363
\fBiocontrol.0.tool\-prep\-number
64-
(s32, Out) The number of the next tool, from the RS274NGC T-word
64+
(s32, Out) The number of the next tool, from the RS274NGC T-word.
6565

6666
.TP
6767
\fBiocontrol.0.tool\-prep\-pocket
@@ -70,19 +70,19 @@ mechanism) of the tool requested by the most recent T-word.
7070

7171
.TP
7272
\fBiocontrol.0.tool\-prepare
73-
(Bit, Out) TRUE when a T\fIn\fR tool prepare is requested
73+
(Bit, Out) TRUE when a T\fIn\fR tool prepare is requested.
7474

7575
.TP
7676
\fBiocontrol.0.tool\-prepared
7777
(Bit, In) Should be driven TRUE when a tool prepare is completed.
7878

7979
.TP
8080
\fBiocontrol.0.user\-enable\-out
81-
(Bit, Out) FALSE when an internal estop condition exists
81+
(Bit, Out) FALSE when an internal estop condition exists.
8282

8383
.TP
8484
\fBiocontrol.0.user\-request\-enable
85-
(Bit, Out) TRUE when the user has requested that estop be cleared
85+
(Bit, Out) TRUE when the user has requested that estop be cleared.
8686

8787
.TP
8888
\fBiocontrol.0.tool\-prep\-index

docs/man/man1/iov2.1

Lines changed: 9 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,11 @@ Whether \fBio\fR or \fBiov2\fR is used can be chosen in the [EMCIO] section of t
4444

4545
.TP
4646
\fBiocontrol.0.coolant\-flood
47-
(Bit, Out) TRUE when flood coolant is requested
48-
47+
(Bit, Out) TRUE when flood coolant is requested.
4948

5049
.TP
5150
\fBiocontrol.0.coolant\-mist
52-
(Bit, Out) TRUE when mist coolant is requested
51+
(Bit, Out) TRUE when mist coolant is requested.
5352

5453
.TP
5554
\fBiocontrol.0.emc\-enable\-in
@@ -68,19 +67,19 @@ into E-stop, and when the "Lube Off" command gets sent to the controller.
6867

6968
.TP
7069
\fBiocontrol.0.tool\-change
71-
(Bit, Out) TRUE when a tool change is requested
70+
(Bit, Out) TRUE when a tool change is requested.
7271

7372
.TP
7473
\fBiocontrol.0.tool\-changed
7574
(Bit, In) Should be driven TRUE when a tool change is completed.
7675

7776
.TP
7877
\fBiocontrol.0.tool\-number
79-
(s32, Out) Current tool number
78+
(s32, Out) Current tool number.
8079

8180
.TP
8281
\fBiocontrol.0.tool\-prep\-number
83-
(s32, Out) The number of the next tool, from the RS274NGC T-word
82+
(s32, Out) The number of the next tool, from the RS274NGC T-word.
8483

8584
.TP
8685
\fBiocontrol.0.tool\-prep\-pocket
@@ -89,66 +88,22 @@ mechanism) of the tool requested by the most recent T-word.
8988

9089
.TP
9190
\fBiocontrol.0.tool\-prepare
92-
(Bit, Out) TRUE when a T\fIn\fR tool prepare is requested
91+
(Bit, Out) TRUE when a T\fIn\fR tool prepare is requested.
9392

9493
.TP
9594
\fBiocontrol.0.tool\-prepared
9695
(Bit, In) Should be driven TRUE when a tool prepare is completed.
9796

9897
.TP
9998
\fBiocontrol.0.user\-enable\-out
100-
(Bit, Out) FALSE when an internal estop condition exists
99+
(Bit, Out) FALSE when an internal estop condition exists.
101100

102101
.TP
103102
\fBiocontrol.0.user\-request\-enable
104-
(Bit, Out) TRUE when the user has requested that estop be cleared
103+
(Bit, Out) TRUE when the user has requested that estop be cleared.
105104

106105

107106
.SS Additional IO v2 pins
108-
.TP
109-
\fBiocontrol.0.coolant\-flood
110-
(Bit, Out) TRUE when flood coolant is requested
111-
.TP
112-
\fBiocontrol.0.coolant\-mist
113-
(Bit, Out) TRUE when mist coolant is requested
114-
.TP
115-
\fBiocontrol.0.emc\-enable\-in
116-
(Bit, In) Should be driven FALSE when an external estop condition exists.
117-
.TP
118-
\fBiocontrol.0.lube
119-
(Bit, Out) TRUE when lube is requested. This pin gets driven True when
120-
the controller comes out of E-stop, and when the "Lube On" command gets
121-
sent to the controller. It gets driven False when the controller goes
122-
into E-stop, and when the "Lube Off" command gets sent to the controller.
123-
.TP
124-
\fBiocontrol.0.lube_level
125-
(Bit, In) Should be driven FALSE when lubrication tank is empty.
126-
.TP
127-
\fBiocontrol.0.tool\-change
128-
(Bit, Out) TRUE when a tool change is requested
129-
.TP
130-
\fBiocontrol.0.tool\-changed
131-
(Bit, In) Should be driven TRUE when a tool change is completed.
132-
.TP
133-
\fBiocontrol.0.tool\-number
134-
(s32, Out) Current tool number
135-
.TP
136-
\fBiocontrol.0.tool\-prep\-number
137-
(s32, Out) The number of the next tool, from the RS274NGC T-word
138-
.TP
139-
\fBiocontrol.0.tool\-prep\-pocket
140-
(s32, Out) This is the pocket number (location in the tool storage
141-
mechanism) of the tool requested by the most recent T-word.
142-
.TP
143-
\fBiocontrol.0.tool\-prepare
144-
(Bit, Out) TRUE when a T\fIn\fR tool prepare is requested
145-
.TP
146-
\fBiocontrol.0.tool\-prepared
147-
(Bit, In) Should be driven TRUE when a tool prepare is completed.
148-
.TP
149-
\fBiocontrol.0.user\-enable\-out
150-
(Bit, Out) FALSE when an internal estop condition exists
151-
.TP
152107
\fBiocontrol.0.emc\-abort
153108
(BIT,OUT) Signals emc\-originated abort to toolchanger.
154109
.TP
@@ -179,11 +134,8 @@ mechanism) of the tool requested by the most recent T-word.
179134
\fBiocontrol.0.toolchanger\-clear\-fault
180135
(BIT,IN) Resets TC fault condition. Deasserts toolchanger\-faulted if toolchanger\-notify is line False. Usage. UI \- e.g. clear fault condition button.
181136
.TP
182-
\fBiocontrol.0.user\-request\-enable
183-
(Bit, Out) TRUE when the user has requested that estop be cleared
184-
.TP
185137
\fBiocontrol.0.state
186-
(S32,OUT) Debugging pin reflecting internal state
138+
(S32,OUT) Debugging pin reflecting internal state.
187139

188140
.PP
189141
See

0 commit comments

Comments
 (0)