Skip to content

Commit 675058f

Browse files
smoehansu
authored andcommitted
docs: small changes revisiting translations
1 parent b04f53f commit 675058f

3 files changed

Lines changed: 31 additions & 46 deletions

File tree

docs/man/man1/mitsub_vfd.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,6 @@ net estop-out coolant.estop
222222

223223
.SH ISSUES
224224

225-
Some models (eg E500) cannot monitor status, so set the monitor pin to false.
225+
Some models, e.g. E500, cannot monitor status, so set the monitor pin to false.
226226
In this case, pins such as up-to-speed, amps, alarm and status bits are not useful.
227227

docs/man/man1/qtvcp.1

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ qtvcp \- Qt-based virtual control panels
3030
[\fIOPTIONS\fR] myfile.ui
3131

3232
.SH DESCRIPTION
33-
\fBqtvcp\fR is a system for creating user interfaces for LinuxCNC.
33+
\fBQtVCP\fR is a system for creating user interfaces for LinuxCNC.
3434

3535
Full documentation at http://linuxcnc.org/docs/html/gui/qtvcp.html
3636

@@ -62,8 +62,7 @@ Use -g WIDTHxHEIGHT for just setting size or -g +XOFFSET+YOFFSET for just positi
6262
Example: -g 200x400+0+100.
6363
.TP
6464
\fB\-H\fR [\fI<FILE>\fR]
65-
Execute HAL statements from FILE with halcmd after the
66-
component is set up and ready.
65+
Execute HAL statements from FILE with halcmd after the component is set up and ready.
6766
.TP
6867
\fB\-i\fR
6968
Enable info output.
@@ -78,25 +77,21 @@ Force panel window to fullscreen.
7877
Set Qt style. Default is system theme.
7978
.TP
8079
\fB\-x\fR [\fI<XID>\fR]
81-
Reparent Qtvcp into an existing window XID instead of creating
82-
a new top level window.
80+
Reparent QtVCP into an existing window XID instead of creating a new top level window.
8381
.TP
8482
\fB\--push_xid\fR
85-
Reparent window into a plug add push the plug xid number to
86-
standardout.
83+
Reparent window into a plug add push the plug xid number to standardout.
8784
.TP
8885
\fB\-u\fR [\fI<USERMOD>\fR]
8986
File path of user defined handler file.
9087
.TP
9188
\fB\-o\fR [\fI<USEROPTS>\fR]
92-
Pass USEROPTS strings to handler under self.w.USEROPTIONS_ list
93-
variable.
89+
Pass USEROPTS strings to handler under self.w.USEROPTIONS_ list variable.
9490

9591
.SH "SEE ALSO"
9692
\fBLinuxCNC(1)\fR
9793

98-
Much more information about LinuxCNC and HAL is available in the LinuxCNC
99-
and HAL User Manuals, found at /usr/share/doc/LinuxCNC/.
94+
Much more information about LinuxCNC and HAL is available in the LinuxCNC and HAL User Manuals, found at /usr/share/doc/LinuxCNC/.
10095

10196
.SH BUGS
10297
None known at this time.
@@ -108,5 +103,5 @@ Report bugs at https://github.com/LinuxCNC/linuxcnc/issues
108103
.SH COPYRIGHT
109104
Copyright \(co 2020 andypugh.
110105
.br
111-
This is free software; see the source for copying conditions. There is NO
112-
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
106+
This is free software; see the source for copying conditions.
107+
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

docs/man/man9/pwmgen.9

Lines changed: 22 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,49 +6,40 @@ pwmgen \- software PWM/PDM generation
66
\fBloadrt pwmgen output_type=\fItype0\fR[,\fItype1\fR...]
77

88
.SH DESCRIPTION
9-
\fBpwmgen\fR is used to generate PWM (pulse width modulation) or
10-
PDM (pulse density modulation) signals. The maximum PWM frequency
11-
and the resolution is quite limited compared to hardware-based
12-
approaches, but in many cases software PWM can be very useful.
13-
If better performance is needed, a hardware PWM generator is a
14-
better choice.
9+
\fBpwmgen\fR is used to generate PWM (pulse width modulation) or PDM (pulse density modulation) signals.
10+
The maximum PWM frequency and the resolution is quite limited compared to hardware-based approaches, but in many cases software PWM can be very useful.
11+
If better performance is needed, a hardware PWM generator is a better choice.
1512
.P
16-
\fBpwmgen\fR supports a maximum of eight channels. The number of
17-
channels actually loaded depends on the number of \fItype\fR values
18-
given. The value of each \fItype\fR determines the outputs for that
19-
channel.
13+
\fBpwmgen\fR supports a maximum of eight channels.
14+
The number of channels actually loaded depends on the number of \fItype\fR values given.
15+
The value of each \fItype\fR determines the outputs for that channel.
2016
.P
2117
.TP
22-
type 0: single output
23-
A single output pin, \fBpwm\fR, whose duty cycle is determined by the
24-
input value for positive inputs, and which is off (or at \fBmin\-dc\fR)
25-
for negative inputs. Suitable for single ended circuits.
18+
type 0: single output A single output pin, \fBpwm\fR, whose duty cycle is determined by the input value for positive inputs,
19+
and which is off (or at \fBmin\-dc\fR) for negative inputs.
20+
Suitable for single ended circuits.
2621
.TP
2722
type 1: pwm/direction
28-
Two output pins, \fBpwm\fR and \fBdir\fR. The duty cycle on \fBpwm\fR
29-
varies as a function of the input value. \fBdir\fR is low for positive
30-
inputs and high for negative inputs.
23+
Two output pins, \fBpwm\fR and \fBdir\fR. The duty cycle on \fBpwm\fR varies as a function of the input value.
24+
\fBdir\fR is low for positive inputs and high for negative inputs.
3125
.TP
3226
type 2: up/down
33-
Two output pins, \fBup\fR and \fBdown\fR. For positive inputs, the
34-
PWM/PDM waveform appears on \fBup\fR, while \fBdown\fR is low. For
35-
negative inputs, the waveform appears on \fBdown\fR, while \fBup\fR
36-
is low. Suitable for driving the two sides of an H-bridge to generate
37-
a bipolar output.
27+
Two output pins, \fBup\fR and \fBdown\fR.
28+
For positive inputs, the PWM/PDM waveform appears on \fBup\fR, while \fBdown\fR is low.
29+
For negative inputs, the waveform appears on \fBdown\fR, while \fBup\fR is low.
30+
Suitable for driving the two sides of an H-bridge to generate a bipolar output.
3831

3932
.SH FUNCTIONS
4033
.TP
4134
\fBpwmgen.make\-pulses\fR (no floating-point)
42-
Generates the actual PWM waveforms, using information computed by
43-
\fBupdate\fR. Must be called as frequently as possible, to maximize
44-
the attainable PWM frequency and resolution, and minimize jitter.
35+
Generates the actual PWM waveforms, using information computed by \fBupdate\fR.
36+
Must be called as frequently as possible, to maximize the attainable PWM frequency and resolution, and minimize jitter.
4537
Operates on all channels at once.
4638
.TP
4739
\fBpwmgen.update\fR (uses floating point)
48-
Accepts an input value, performs scaling and limit checks, and converts
49-
it into a form usable by \fBmake\-pulses\fR for PWM/PDM generation. Can
50-
(and should) be called less frequently than \fBmake\-pulses\fR. Operates
51-
on all channels at once.
40+
Accepts an input value, performs scaling and limit checks, and converts it into a form usable by \fBmake\-pulses\fR for PWM/PDM generation.
41+
Can (and should) be called less frequently than \fBmake\-pulses\fR.
42+
Operates on all channels at once.
5243

5344
.SH PINS
5445
.TP
@@ -91,12 +82,11 @@ regardless of the setting of \fBmin\-dc\fR.
9182
.ns
9283
.TP
9384
\fBpwmgen.\fIN\fB.offset\fR float in/out
94-
These parameters provide a scale and offset from the \fBvalue\fR pin to thewactual duty cycle.
85+
These parameters provide a scale and offset from the \fBvalue\fR pin to the actual duty cycle.
9586
The duty cycle is calculated according to \fIdc = (value/scale) + offset\fR, with 1.0 meaning 100%.
9687
.TP
9788
\fBpwmgen.\fIN\fB.pwm\-freq\fR float in/out
98-
PWM frequency in Hz. The upper limit is half of the frequency at which \fBmake\-pulses\fR is invoked,
99-
and values above that limit will be changed to the limit.
89+
PWM frequency in Hz. The upper limit is half of the frequency at which \fBmake\-pulses\fR is invoked, and values above that limit will be changed to the limit.
10090
If \fBdither\-pwm\fR is false, the value will be changed to the nearest integer submultiple of the \fBmake\-pulses\fR frequency.
10191
A value of zero produces Pulse Density Modulation instead of Pulse Width Modulation.
10292
.TP

0 commit comments

Comments
 (0)