docs: fix formatting of man(1) pages i-z (#3032)

Author: hansu

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

@@ -6,15 +6,11 @@ halcompile - Build, compile and install LinuxCNC HAL components
 
 == SYNOPSIS
 
-____
 *halcompile* [*--compile*|*--preprocess*|*--document*|*--adoc*|*--view-doc*] compfile...
-____
 
 _sudo_ *halcompile* [*--install*|*--install-doc*] compfile...
 
-____
 *halcompile* *--compile* *--userspace* cfile...
-____
 
 _sudo_ *halcompile* *--install* *--userspace* cfile...
 
@@ -103,7 +99,7 @@ Extra arguments passed to the linker.
 
 == SEE ALSO
 
-* _Halcompile HAL Component Generator_ in the LinuxCNC documentation for a
+* _Halcompile_ / _HAL Component Generator_ in the LinuxCNC documentation for a
   full description of the *.comp* syntax, along with examples
 
 * *pydoc, HAL* and _Creating Non-realtime Python Components_ in the

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

@@ -6,7 +6,8 @@ io, iocontrol - interacts with HAL or G-code in non-realtime
 
 == SYNOPSIS
 
-*[EMCIO]* +
+*[EMCIO]*
+
 *EMCIO = io*
 
 == DESCRIPTION

docs/src/man/man1/latency-histogram.1.adoc

@@ -27,21 +27,21 @@ More details: https://linuxcnc.org/docs/html/install/latency-test.html
 
 *-?*, *--help*::
   Show options and exit.
-*--base*_ ns_::
+*--base* _ns_::
   base thread interval, default: 25000, min: 5000
-*--servo*_ ns_::
+*--servo* _ns_::
   servo thread interval, default: 1000000, min: 25000
-*--bbinsize*_ ns_::
+*--bbinsize* _ns_::
   base bin size, default: 100
-*--sbinsize*_ ns_::
+*--sbinsize* _ns_::
   servo bin size, default: 100
-*--bbins*_ ns_::
+*--bbins* _ns_::
   base bins, default: 200
-*--sbins*_ ns_::
+*--sbins* _ns_::
   servo bins, default: 200
-*--logscale*_ 0|1_::
+*--logscale* _0|1_::
   y axis log scale, default: 1
-*--text*_ note_::
+*--text* _note_::
   additional note, default: ""
 *--show*::
   show count of undisplayed bins

docs/src/man/man1/latency-test.1.adoc

@@ -6,7 +6,7 @@ latency-test - test the realtime system latency
 
 == SYNOPSIS
 
-*latency-test* [*--help*] [_base-period_ [_servo-period_]]
+*latency-test* [*-h | --help*] [_base-period_ [_servo-period_]]
 
 == DESCRIPTION
 

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

@@ -16,8 +16,14 @@ FIXME: missing
 
 Option 'all' returns varname=value for all supported varnames
 
-Varnames supported: LINUXCNCVERSION LINUXCNC_AUX_GLADEVCP
-LINUXCNC_AUX_EXAMPLES REALTIME RTS HALLIB_DIR
+Varnames supported:
+
+- LINUXCNCVERSION
+- LINUXCNC_AUX_GLADEVCP
+- LINUXCNC_AUX_EXAMPLES
+- REALTIME
+- RTS
+- HALLIB_DIR
 
 == SEE ALSO
 

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

@@ -479,40 +479,48 @@ machine out of E-stop (set estop off) and turns it on (set machine on),
 homes all the axes, switches the machine to mdi mode, sends an MDI
 G-code command, then disconnects and shuts down LinuxCNC.
 
- > *telnet localhost 5007* +
- Trying 127.0.0.1... +
- Connected to 127.0.0.1 +
- Escape character is '^]'. +
- *hello EMC user-typing-at-telnet 1.0* +
- HELLO ACK EMCNETSVR 1.1 +
- *set enable EMCTOO* +
- set enable EMCTOO +
- *set mode manual* +
- set mode manual +
- *set estop off* +
- set estop off +
- *set machine on* +
- set machine on +
- *set home 0* +
- set home 0 +
- *set home 1* +
- set home 1 +
- *set home 2* +
- set home 2 +
- *set mode mdi* +
- set mode mdi +
- *set mdi g0x1* +
- set mdi g0x1 +
- *help* +
- help +
- Available commands: Hello <password> <client name> <protocol version>
- Get <emc command> Set <emc command> Shutdown Help <command> +
- *help get* +
- help get +
- Usage: Get <emc command> Get commands require that a hello has been
- successfully negotiated. Emc command may be one of: Abs_act_pos
- Abs_cmd_pos +
- * ... * +
- *shutdown* +
- shutdown +
- Connection closed by foreign host.
+*> telnet localhost 5007* +
+Trying 127.0.0.1... +
+Connected to 127.0.0.1 +
+Escape character is '^]'. +
+*hello EMC user-typing-at-telnet 1.0* +
+HELLO ACK EMCNETSVR 1.1 +
+*set enable EMCTOO* +
+set enable EMCTOO +
+*set mode manual* +
+set mode manual +
+*set estop off* +
+set estop off +
+*set machine on* +
+set machine on +
+*set home 0* +
+set home 0 +
+*set home 1* +
+set home 1 +
+*set home 2* +
+set home 2 +
+*set mode mdi* +
+set mode mdi +
+*set mdi g0x1* +
+set mdi g0x1 +
+*help* +
+  help +
+    Available commands: +
+    Hello <password> <client name> <protocol version> +
+    Get <emc command> +
+    Set <emc command> +
+    Shutdown Help <command> +
+
+*help get* +
+help get +
+  Usage: Get <emc command> +
+    Get commands require that a hello has been +
+    successfully negotiated. +
+    Emc command may be one of: +
+      Abs_act_pos +
+      Abs_cmd_pos +
+
+*...* +
+*shutdown* +
+shutdown +
+  Connection closed by foreign host.

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

@@ -23,21 +23,25 @@ See https://linuxcnc.org/docs/html/drivers/mb2hal.html[] for more information.
 === fnct_01_read_coils:
 
 *mb2hal.m.n.bit* bit out +
+
 *mb2hal.m.n.bit-inv* bit out
 
 === fnct_02_read_discrete_inputs:
 
 *mb2hal.m.n.bit* bit out +
+
 *mb2hal.m.n.bit-inv* bit out
 
 === fnct_03_read_holding_registers:
 
 *mb2hal.m.n.float* float out +
+
 *mb2hal.m.n.int* s32 out
 
 === fnct_04_read_input_registers:
 
 *mb2hal.m.n.float* float out +
+
 *mb2hal.m.n.int* s32 out
 
 === fnct_05_write_single_coil:

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

@@ -26,7 +26,7 @@ interactive session
 $mdi
 MDI> m3 s1000
 MDI> G0 X100
-MDI>` ^Z
+MDI> ^Z
 $stopped
 ....
 

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

@@ -82,8 +82,14 @@ _MM_ = _1_::
 Using an example of "XYZA" for an _axes_ argument, these pins will be
 created when *mdro* starts:
 
-mdro.axis.0 mdro.axis.1 mdro.axis.2 mdro.axis.3 mdro.index-enable.0
-mdro.index-enable.1 mdro.index-enable.2 mdro.index-enable.3
+- mdro.axis.0 +
+- mdro.axis.1 +
+- mdro.axis.2 +
+- mdro.axis.3 +
+- mdro.index-enable.0 +
+- mdro.index-enable.1 +
+- mdro.index-enable.2 +
+- mdro.index-enable.3 +
 
 In this example, the first row will be labeled "X" and will show the
 data associated with pin mdro.axis.0. In many configurations,
@@ -94,8 +100,10 @@ index-enable pins from the DRO.
 *mdro* can also be started via a "loadusr" command in a HAL file for a
 trial. Here's an example of a sim setup:
 
-loadusr -W mdro -l sim.var XYZ net x-pos-fb => mdro.axis.0 net y-pos-fb
-=> mdro.axis.1 net z-pos-fb => mdro.axis.2
+  loadusr -W mdro -l sim.var XYZ
+  net x-pos-fb => mdro.axis.0
+  net y-pos-fb => mdro.axis.1
+  net z-pos-fb => mdro.axis.2
 
 == AUTHOR
 

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

@@ -9,7 +9,7 @@ milltask - Non-realtime task controller for LinuxCNC
 The internal process *milltask* of LinuxCNC is generally not
 invoked directly but by an INI file setting:
 `[TASK]TASK=milltask``.
-The *milltask* process creates the `ini.\*` HAL pins listed below and owned by the *inihal* component.
+The *milltask* process creates the `ini.*` HAL pins listed below and owned by the *inihal* component.
 These pins may be modified while LinuxCNC is running to alter values
 that are typically specified statically in an INI file.