Skip to content

Commit 37b9a62

Browse files
Merge pull request #3501 from smoe/translations_20250705
Documentation: Indentation warnings by po4a, spellcheck (smoe:Translations:20250705)
2 parents e78cc0a + da46ab1 commit 37b9a62

7 files changed

Lines changed: 115 additions & 99 deletions

File tree

docs/src/gui/gmoccapy.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ If not set, half of 'MAX_LINEAR_VELOCITY' will be used.
170170
If that value is also not given, it will default to 180.
171171

172172
- _MAX_LINEAR_VELOCITY = 230.0_ - Sets the maximal velocity of the machine.
173-
This value will also be the maximum linear jog velocity.
173+
This value will also be the maximum linear jog velocity.
174174
+
175175
[NOTE]
176176
Defaults to 600 if not set.
@@ -685,18 +685,21 @@ In a future release it will be integrated in the settings page.
685685
- *gmoccapy.spc_jog_vel.scale* _(float IN)_ - A value to scale the output value (handy to change units/min to units/sec)
686686
- *gmoccapy.spc_jog_vel.value* _(float OUT)_ - Value of the widget
687687
- *gmoccapy.spc_jog_vel.scaled-value* _(float OUT)_ - Scaled value of the widget
688+
688689
.FEED
689690
- *gmoccapy.spc_feed.increase* _(bit IN)_ - As long as True the value of the slider will increase
690691
- *gmoccapy.spc_feed.decrease* _(bit IN)_ - As long as True the value of the slider will decrease
691692
- *gmoccapy.spc_feed.scale* _(float IN)_ - A value to scale the output value (handy to change units/min to units/sec)
692693
- *gmoccapy.spc_feed.value* _(float OUT)_ - Value of the widget
693694
- *gmoccapy.spc_feed.scaled-value* _(float OUT)_ - Scaled value of the widget
695+
694696
.SPINDLE
695697
- *gmoccapy.spc_spindle.increase* _(bit IN)_ - As long as True the value of the slider will increase
696698
- *gmoccapy.spc_spindle.decrease* _(bit IN)_ - As long as True the value of the slider will decrease
697699
- *gmoccapy.spc_spindle.scale* _(float IN)_ - A value to scale the output value (handy to change units/min to units/sec)
698700
- *gmoccapy.spc_spindle.value* _(float OUT)_ - Value of the widget
699701
- *gmoccapy.spc_spindle.scaled-value* _(float OUT)_ - Scaled value of the widget
702+
700703
.RAPIDS
701704
- *gmoccapy.spc_rapid.increase* _(bit IN)_ - As long as True the value of the slider will increase
702705
- *gmoccapy.spc_rapid.decrease* _(bit IN)_ - As long as True the value of the slider will decrease

docs/src/hal/components.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ man axis
1919

2020
The one or other setup of a UNIX system may require to explicitly specify the section of the man page.
2121
If you do not find the man page or the name of the man page is already taken by another UNIX tool with the LinuxCNC man page residing in another section,
22-
then try to explicitly specify the section, as in `man _sectionno_ axis`, with _sectionno_ = 1 for non-realtime and 9 for realtime components.
22+
then try to explicitly specify the section, as in `man _section-no_ axis`, with _section-no_ = 1 for non-realtime and 9 for realtime components.
2323

2424
[NOTE]
2525
See also the 'Man Pages' section of the link:../index.html[docs main page] or the link:../man/[directory listing].
@@ -47,7 +47,7 @@ To search in the man pages, use the UNIX tool `apropos`.
4747
[{tab_options}]
4848
|===
4949
| link:../man/man1/gladevcp.1.html[gladevcp] |Virtual Control Panel for LinuxCNC based on Glade, Gtk and HAL widgets ||
50-
| link:../man/man1/gladevcp_demo.1.html[gladevcp_demo] |GladeVCP - used by sample configs to deonstrate Glade Virtual_demo ||
50+
| link:../man/man1/gladevcp_demo.1.html[gladevcp_demo] |GladeVCP - used by sample configs to demonstrate Glade Virtual_demo ||
5151
| link:../man/man1/gremlin_view.1.html[gremlin_view] |G-code graphical preview ||
5252
| link:../man/man1/moveoff_gui.1.html[moveoff_gui] |GUI for the moveoff component ||
5353
| link:../man/man1/pyui.1.html[pyui] |Utility for panelui ||
@@ -88,7 +88,7 @@ To search in the man pages, use the UNIX tool `apropos`.
8888
==== VFD & Communication Interfaces (non-realtime)
8989
[{tab_options}]
9090
|===
91-
| link:../man/man1/elbpcom.1.html[elbpcom] |Communicate with Mesa ethernet cards ||
91+
| link:../man/man1/elbpcom.1.html[elbpcom] |Communicate with Mesa Ethernet cards ||
9292
| link:../man/man1/gs2_vfd.1.html[gs2_vfd] |HAL non-realtime component for Automation Direct GS2 VFDs ||
9393
| link:../man/man1/hy_gt_vfd.1.html[hy_gt_vfd] |HAL non-realtime component for Huanyang GT-series VFDs ||
9494
| link:../man/man1/hy_vfd.1.html[hy_vfd] |HAL non-realtime component for Huanyang VFDs ||
@@ -102,7 +102,7 @@ To search in the man pages, use the UNIX tool `apropos`.
102102
| link:../man/man1/svd-ps_vfd.1.html[svd-ps_vfd] |HAL non-realtime component for SVD-P(S) VFDs ||
103103
| link:../man/man1/vfdb_vfd.1.html[vfdb_vfd] |HAL non-realtime component for Delta VFD-B Variable Frequency Drives ||
104104
| link:../man/man1/vfs11_vfd.1.html[vfs11_vfd] |HAL non-realtime component for Toshiba-Schneider VF-S11 Variable Frequency Drives ||
105-
| link:../man/man1/wj200_vfd.1.html[wj200_vfd] |Hitachi wj200 modbus driver ||
105+
| link:../man/man1/wj200_vfd.1.html[wj200_vfd] |Hitachi wj200 Modbus driver ||
106106
| link:../man/man1/xhc-hb04.1.html[xhc-hb04] |Non-realtime HAL component for the xhc-hb04 pendant ||
107107
| link:../man/man1/xhc-hb04-accels.1.html[xhc-hb04-accels] |Obsolete script for jogging wheel ||
108108
| link:../man/man1/xhc-whb04b-6.1.html[xhc-whb04b-6] |Non-realtime jog dial HAL component for the wireless XHC WHB04B-6 USB device ||
@@ -112,7 +112,7 @@ To search in the man pages, use the UNIX tool `apropos`.
112112
[{tab_options}]
113113
|===
114114
| hal_ppmc | Pico Systems <<cha:pico-drivers,driver>> for analog servo, PWM and Stepper controller ||
115-
| link:../man/man9/hal_bb_gpio.9.html[hal_bb_gpio] |Driver for beaglebone GPIO pins ||
115+
| link:../man/man9/hal_bb_gpio.9.html[hal_bb_gpio] |Driver for BeagleBone GPIO pins ||
116116
| link:../man/man9/hal_parport.9.html[hal_parport] |Realtime HAL component to communicate with one or more PC parallel ports ||
117117
| link:../man/man9/hm2_7i43.9.html[hm2_7i43] |Mesa Electronics driver for the 7I43 EPP Anything IO board with HostMot2. (See the man page for more information) ||
118118
| link:../man/man9/hm2_7i90.9.html[hm2_7i90] |LinuxCNC HAL driver for the Mesa Electronics 7I90 EPP Anything IO board with HostMot2 firmware ||
@@ -176,11 +176,11 @@ To search in the man pages, use the UNIX tool `apropos`.
176176
| link:../man/man1/linuxcnctop.1.html[linuxcnctop] |Live LinuxCNC status description||
177177
| link:../man/man1/rs274.1.html[rs274] |Standalone G-code interpreter||
178178
| link:../man/man1/schedrmt.1.html[schedrmt] |Telnet based scheduler for LinuxCNC||
179-
| link:../man/man1/setup_designer.1.html[setup_designer] |A script to configure the system for use of QTdesigner||
179+
| link:../man/man1/setup_designer.1.html[setup_designer] |A script to configure the system for use of Qt Designer||
180180
| link:../man/man1/teach-in.1.html[teach-in] |Jog the machine to a position, and record the state||
181181
| link:../man/man1/tool_mmap_read.1.html[tool_mmap_read] |A component of the tool database system (an alternative to the classic tooltable)||
182182
| link:../man/man1/tool_watch.1.html[tool_watch] |A component of the tool database system (an alternative to the classic tooltable)||
183-
| link:../man/man1/tooledit.1.html[tooledit] |Tool table editor||
183+
| link:../man/man1/tooledit.1.html[tooledit] |Tooltable editor||
184184
|===
185185

186186
=== Signal processing (Realtime)
@@ -361,7 +361,7 @@ the input is a position, this means that 'position', 'velocity', and 'accelerati
361361
| link:../man/man9/at_pid.9.html[at_pid] | Proportional/integral/derivative controller with auto tuning. ||
362362
| link:../man/man9/bldc.9.html[bldc] |BLDC and AC-servo control component ||
363363
| link:../man/man9/clarke2.9.html[clarke2] | Two input version of Clarke transform ||
364-
| link:../man/man9/clarke3.9.html[clarke3] | Clarke (3 phase to cartesian) transform ||
364+
| link:../man/man9/clarke3.9.html[clarke3] | Clarke (3 phase to Cartesian) transform ||
365365
| link:../man/man9/clarkeinv.9.html[clarkeinv] | Inverse Clarke transform ||
366366
| link:../man/man9/encoder.9.html[encoder] | Software counting of quadrature encoder signals, see <<sec:encoder,description>>. ||
367367
| link:../man/man9/pid.9.html[pid] | Proportional/integral/derivative controller, <<sec:pid,description>>. ||
@@ -373,12 +373,12 @@ the input is a position, this means that 'position', 'velocity', and 'accelerati
373373
=== Simulation/Testing
374374
[{tab_options}]
375375
|===
376-
| link:../man/man9/axistest.9.html[axistest] |Used to allow testing of an axis. Used In PnCconf.||
376+
| link:../man/man9/axistest.9.html[axistest] |Used to allow testing of an axis. Used In PnCConf.||
377377
| link:../man/man1/rtapi_app.1.html[rtapi_app] |creates a simulated real time environment||
378378
| link:../man/man1/sim-torch.1.html[sim-torch] |A simulated plasma torch||
379379
| link:../man/man9/sim_axis_hardware.9.html[sim_axis_hardware] |A component to simulate home and limit switches||
380380
| link:../man/man9/sim_home_switch.9.html[sim_home_switch] |Home switch simulator||
381-
| link:../man/man9/sim_matrix_kb.9.html[sim_matrix_kb] |convert HAL pin inputs to keycodes||
381+
| link:../man/man9/sim_matrix_kb.9.html[sim_matrix_kb] |convert HAL pin inputs to key codes||
382382
| link:../man/man9/sim_parport.9.html[sim_parport] |A component to simulate the pins of the hal_parport component||
383383
| link:../man/man9/sim_spindle.9.html[sim_spindle] |Simulated spindle with index pulse||
384384
| link:../man/man1/simulate_probe.1.html[simulate_probe] |simulate a probe input||

docs/src/man/man1/halcompile.1.adoc

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -83,30 +83,29 @@ Extra arguments passed to the linker.
8383
*halcompile* performs many different functions:
8484

8585
* Compile *.comp* and *.c* files into *.so* or *.ko* HAL realtime
86-
components (the *--compile* flag)
87-
* Compile *.comp* and *.c* files into HAL non-realtime components (the
88-
*--compile --userspace* flag)
86+
components (the *--compile* flag)
87+
* Compile *.comp* and *.c* files into HAL non-realtime components
88+
(the *--compile --userspace* flag)
8989
* Preprocess *.comp* files into *.c* files (the *--preprocess* flag)
9090
* Extract documentation from *.comp* files into asciidoc or manpage
91-
section *1* or *9* files (the *--adoc* and *--document* flags)
92-
* Display documentation from *.comp* files onscreen (the *--view-doc*
93-
flag)
91+
section *1* or *9* files (the *--adoc* and *--document* flags)
92+
* Display documentation from *.comp* files onscreen (the *--view-doc* flag)
9493
* Compile and install *.comp* and *.c* files into the proper directory
95-
for HAL realtime components (the *--install* flag), which may require
96-
_sudo_ to write to system directories.
94+
for HAL realtime components (the *--install* flag),
95+
which may require _sudo_ to write to system directories.
9796
* Install *.c* and *.py* files into the proper directory for HAL
98-
non-realtime components (the *--install* *--userspace* flag), which may
99-
require _sudo_ to write to system directories.
97+
non-realtime components (the *--install* *--userspace* flag), which may
98+
require _sudo_ to write to system directories.
10099
* Extract documentation from *.comp* files into *.1* or *.9* manpage
101-
files in the proper system directory (the *--install* flag), which may
102-
require _sudo_ to write to system directories.
100+
files in the proper system directory (the *--install* flag), which may
101+
require _sudo_ to write to system directories.
103102
* Preprocess *.comp* files into *.c* files (the *--preprocess* flag)
104103

105104
== SEE ALSO
106105

107-
_Halcompile HAL Component Generator_ in the LinuxCNC documentation for a
108-
full description of the *.comp* syntax, along with examples
106+
* _Halcompile HAL Component Generator_ in the LinuxCNC documentation for a
107+
full description of the *.comp* syntax, along with examples
109108

110-
*pydoc, HAL* and _Creating Non-realtime Python Components_ in the
111-
LinuxCNC documentation for documentation on the Python interface to HAL
112-
components
109+
* *pydoc, HAL* and _Creating Non-realtime Python Components_ in the
110+
LinuxCNC documentation for documentation on the Python interface to HAL
111+
components

docs/src/man/man1/haltcl.1.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ be set up with a single command.
2323
If specified, the INI file is read and used to create Tcl global variable arrays.
2424
An array is created for each SECTION of the INI file with elements for each ITEM in the section.
2525
+
26-
For example, if the INI file contains:
26+
For example, if the INI file contains:
2727
+
2828
----
2929
[SECTION_A]
@@ -34,7 +34,7 @@ ITEM_2 = 2
3434
ITEM_1 = 10
3535
----
3636
+
37-
The corresponding Tcl variables are:
37+
The corresponding Tcl variables are:
3838
+
3939
----
4040
SECTION_A(ITEM_1) = 1

docs/src/man/man1/setup_designer.1.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
== NAME
44

5-
setup_designer - A script to configure the system for use of QTdesigner
5+
setup_designer - A script to configure the system for use of Qt Designer
66

77
== DESCRIPTION
88

9-
*setup_designer* Run this script to prepare your system for custom GUI
10-
creatiuon using the QT toolset.
9+
Run the script *setup_designer* to prepare your system for custom GUI
10+
creation using the Qt toolset.
1111

12-
See the QTVCP documentation for more details.
12+
See the QtVCP documentation for more details.
1313

1414
== SEE ALSO
1515

16-
linuxcnc(1)*
16+
linuxcnc(1)
1717

1818
Much more information about LinuxCNC and HAL is available in the
1919
LinuxCNC and HAL User Manuals, found at /usr/share/doc/LinuxCNC/.

docs/src/man/man9/hm2_rpspi.9.adoc

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,33 @@ TBD.
9797
== SPI CLOCK RATES
9898

9999
The maximum SPI clock of the BCM2835-SPI driver and the 7i90 is
100-
documented over 32MHz. The SPI driver can provide frequencies well
100+
documented over 32&#9239;MHz. The SPI driver can provide frequencies well
101101
beyond what is acceptable for the 7i90. A safe value to start with would
102-
be 12.5 MHz (spiclk_rate=12500) and then work your way up from there.
102+
be 12.5&#8239;MHz (spiclk_rate=12500) and then work your way up from there.
103103

104104
The SPI driver generates (very) discrete clock frequency values,
105105
especially in the MHz range because of a simple clock divider structure.
106-
The base frequency is 250 MHz and the divider for SPI0/SPI1 scales using
106+
The base frequency is 250&#8239;MHz and the divider for SPI0/SPI1 scales using
107107
discrete factors. The following list specifies the *spiclk_rate* setting
108-
and the discrete SPI clock frequency (250 MHz / (2n) for n > 1): - 62500
109-
- 62.500 MHz, - 41667 - 41.667 MHz, - 31250 - 31.250 MHz, - 25000 -
110-
25.000 MHz, - 20834 - 20.833 MHz, - 17858 - 17.857 MHz, - 15625 - 15.625
111-
MHz, - 13889 - 13.889 MHz, - 12500 - 12.500 MHz, - 11364 - 11.364 MHz, -
112-
10417 - 10.417 MHz, - 9616 - 9.615 MHz, - ....
108+
and the discrete SPI clock frequency (250&#8239;MHz / (2__n__) for _n_ > 1):
109+
110+
[cols=">,>"]
111+
|===
112+
| _n_ | Frequency range |
113+
| 2 | 62500 - 62.500&#8239;MHz, |
114+
| 3 | 41667 - 41.667&#8239;MHz, |
115+
| 4 | 31250 - 31.250&#8239;MHz, |
116+
| 5 | 25000 - 25.000&#8239;MHz, |
117+
| 6 | 20834 - 20.833&#8239;MHz, |
118+
| 7 | 17858 - 17.857&#8239;MHz, |
119+
| 8 | 15625 - 15.625&#8239;MHz, |
120+
| 9 | 13889 - 13.889&#8239;MHz, |
121+
| 10 | 12500 - 12.500&#8239;MHz, |
122+
| 11 | 11364 - 11.364&#8239;MHz, |
123+
| 12 | 10417 - 10.417&#8239;MHz, |
124+
| 13 | 9616 - 9.615&#8239;MHz, |
125+
| 14+ | .... |
126+
|===
113127

114128
The lowest selectable SPI clock frequency is 30 kHz (spiclk_rate=30) for
115129
SPI0 and SPI1. Theoretically, the SPI0 port could go slower, but there
@@ -129,8 +143,8 @@ Writing to the 7i90 may be done faster than reading. This is especially
129143
important if you have "long" wires or any buffers on the SPI-bus path.
130144
You can set the read clock frequency to a lower value (using
131145
*spiclk_rate_rd*) to counter the effects of the SPI-bus round-trip
132-
needed for read actions. For example, you can write at 41.67 MHz and
133-
read at 25.00 MHz.
146+
needed for read actions. For example, you can write at 41.67&#9239;MHz and
147+
read at 25.00&#9239;MHz.
134148

135149
It should be noted that the Rpi3 *must* have an adequate 5V power supply
136150
and the power should be properly decoupled right on the 40-pin I/O

0 commit comments

Comments
 (0)