some further man page fixes (using asciidoctor)

hansu · Nov 25, 2024 · 90df48d · 90df48d
1 parent 38ad143
commit 90df48d
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 47 deletions.
diff --git a/docs/src/man/man1/axis-remote.1.adoc b/docs/src/man/man1/axis-remote.1.adoc
@@ -12,7 +12,7 @@ axis-remote - AXIS Remote Interface
 
 *axis-remote* is a small script that triggers commands in a running AXIS GUI.
 
-Use *axis-remote --help* for further information.::
+Use *axis-remote --help* for further information.
 
 == OPTIONS
 

diff --git a/docs/src/man/man1/debuglevel.1.adoc b/docs/src/man/man1/debuglevel.1.adoc
@@ -15,7 +15,7 @@ of some parts of LinuxCNC.
 
 == SEE ALSO
 
-halcmd(1) - debug subcommand linuxcnc(1)*
+halcmd(1) - debug subcommand *linuxcnc(1)*
 
 Much more information about LinuxCNC and HAL is available in the
 LinuxCNC and HAL User Manuals, found at /usr/share/doc/LinuxCNC/.

diff --git a/docs/src/man/man1/elbpcom.1.adoc b/docs/src/man/man1/elbpcom.1.adoc
@@ -52,39 +52,39 @@ tool.
 If not specified, the default values are
 
 ____
-*--ip=*_192.168.1.121_ *--port=*_27181_ *--timeout=*_.2_ *--space=*_0_ *--size=*_0_
-____
-
-If the *--size* argument _TRANSFER_SIZE_ is 0, elbpcom will look up the
-preferred transfer size of the space in the space's info area.
-
-This example demonstrates reading the HOSTMOT2 identifying string from
-the IDROM in space 0:
-
-____
-....
-$ elbpcom --address 0x104 --read 8
-> 82420401
-< 484f53544d4f5432
-      HOSTMOT2
-....
-____
-
-First the request is shown in hex. Then the response (if any) is shown
-in hex. Finally, the response is shown in ASCII, with "." replacing any
-non-ASCII characters. This is similar to the following invocations of
-mesaflash:
-
-____
-....
-$ ./mesaflash  --device 7i80 --rpo 0x104
-54534F48
-$ ./mesaflash  --device 7i80 --rpo 0x108
-32544F4D
-....
-____
-
-but notice its different treatment of byte order.
+**--ip=**_192.168.1.121_ **--port=**_27181_ **--timeout=**_.2_ **--space=**_0_ **--size=**_0_
+____
+
+// If the *--size* argument _TRANSFER_SIZE_ is 0, elbpcom will look up the
+// preferred transfer size of the space in the space's info area.
+
+// This example demonstrates reading the HOSTMOT2 identifying string from
+// the IDROM in space 0:
+
+// ____
+// ....
+// $ elbpcom --address 0x104 --read 8
+// > 82420401
+// < 484f53544d4f5432
+//       HOSTMOT2
+// ....
+// ____
+
+// First the request is shown in hex. Then the response (if any) is shown
+// in hex. Finally, the response is shown in ASCII, with "." replacing any
+// non-ASCII characters. This is similar to the following invocations of
+// mesaflash:
+
+// ____
+// ....
+// $ ./mesaflash  --device 7i80 --rpo 0x104
+// 54534F48
+// $ ./mesaflash  --device 7i80 --rpo 0x108
+// 32544F4D
+// ....
+// ____
+
+// but notice its different treatment of byte order.
 
 == SEE ALSO
 

diff --git a/docs/src/man/man1/emccalib.1.adoc b/docs/src/man/man1/emccalib.1.adoc
@@ -12,7 +12,7 @@ emccalib - Adjust ini tuning variables on the fly with save option
 == DESCRIPTION
 
 The Calibration assistant.  This tool Reads the HAL file and for every
-'setp' that uses a variable from the INI file that is in an [AXIS_L],
+`setp` that uses a variable from the INI file that is in an [AXIS_L],
 [JOINT_N], [SPINDLE_S], or [TUNE] section it creates an entry that can
 be edited and tested.
 
@@ -27,12 +27,10 @@ _L_ is an axis coordinate letter (X,Y,Z,A,B,C,U,V,W),
 and _S_ is a spindle number (0 .. 9).
 
 [NOTE]
-
 The number of allowed spindles is 8 but legacy configurations
 may include a stanza [SPINDLE_9] unrelated to an actual spindle number.
 
 [NOTE]
-
 The [TUNE] stanza may be used for specifying tunable items
 not relevant to the other supported stanzas.
 

diff --git a/docs/src/man/man1/gremlin_view.1.adoc b/docs/src/man/man1/gremlin_view.1.adoc
@@ -27,14 +27,25 @@ Optional checkbuttons names:: 'enable_dro' 'show_machine_speed
 'show_distance_to_go' 'show_limits' 'show_extents' 'show_tool'
 'show_metric'
 Callbacks are provided for the following button actions::
-on_clear_live_plotter_clicked on_enable_dro_clicked on_zoomin_pressed
-on_zoomout_pressed on_pan_x_minus_pressed on_pan_x_plus_pressed
-on_pan_y_minus_pressed on_pan_y_plus_pressed on_show_tool_clicked
-on_show_metric_clicked on_show_extents_clicked on_select_p_view_clicked
-on_select_x_view_clicked on_select_y_view_clicked
-on_select_z_view_clicked on_select_z2_view_clicked
-on_show_distance_to_go_clicked on_show_machine_speed_clicked
-on_show_limits_clicked
+on_clear_live_plotter_clicked +
+on_enable_dro_clicked +
+on_zoomin_pressed +
+on_zoomout_pressed +
+on_pan_x_minus_pressed +
+on_pan_x_plus_pressed +
+on_pan_y_minus_pressed +
+on_pan_y_plus_pressed +
+on_show_tool_clicked +
+on_show_metric_clicked +
+on_show_extents_clicked +
+on_select_p_view_clicked +
+on_select_x_view_clicked +
+on_select_y_view_clicked +
+on_select_z_view_clicked +
+on_select_z2_view_clicked +
+on_show_distance_to_go_clicked +
+on_show_machine_speed_clicked +
+on_show_limits_clicked +
 
 == SEE ALSO
 

diff --git a/docs/src/man/man3/hal_set_lock.3.adoc b/docs/src/man/man3/hal_set_lock.3.adoc
@@ -5,7 +5,7 @@
 == NAME
 
 // hal_set_lock - Set or get the HAL lock level
-hal_set_lock, hal_get_lock - Set or get the HAL lock level
+hal_set_lock - Set or get the HAL lock level
 
 // Problem: hal_get_lock.3 is generated like:
 // .so hal_set_lock.3