Merge pull request #1553 from hansu/docs-2.8

Some work on docs (2.8)

Author: c-morley

docs/man/man1/halshow.1

@@ -24,26 +24,35 @@
 .\"
 .TH HALSHOW "1"  "2020-08-26" "LinuxCNC Documentation" "The Enhanced Machine Controller"
 .SH NAME
-halshow \- short description
+halshow \- Show HAL parameters, pins and signals
 .SH SYNOPSIS
-.B halshow
+.B halshow [Options] [watchfile]
 
+.SH OPTIONS
+           --help    (help)
+           --fformat format_string_for_float
+           --iformat format_string_for_int
+
+For format see 
+.UR https://www.tcl.tk/man/tcl8.6.11/TclCmd/format.html
+.UE
+
+Example: 
+"%.5f" displays a float with 5 digits right of the decimal point
 .SH DESCRIPTION
 \fBhalshow\fR creates a GUI interface to view and interact with a running
 HAL session. 
 It is documented in the PDF and HTML docs much more completely than is
 possible in a manpage:
-http://linuxcnc.org/docs/html/hal/halshow.html
-
+.UR http://linuxcnc.org/docs/html/hal/halshow.html
+.UE
 
 .SH "SEE ALSO"
 \fBLinuxCNC(1)\fR
 
 Much more information about LinuxCNC and HAL is available in the LinuxCNC
 and HAL User Manuals, found at /usr/share/doc/LinuxCNC/.
 
-.SH HISTORY
-
 .SH BUGS
 None known at this time. 
 .PP

docs/src/config/python-interface.txt

@@ -259,10 +259,10 @@ machine linear units per mm, reflects [TRAJ]LINEAR_UNITS ini value.
 reflects 'iocontrol.0.lube_level'.
 
 *max_acceleration*:: '(returns float)' -
-maximum  acceleration. reflects [TRAJ]MAX_ACCELERATION.
+maximum  acceleration. Reflects [TRAJ]MAX_ACCELERATION.
 
 *max_velocity*:: '(returns float)' -
-maximum  velocity. reflects [TRAJ]MAX_VELOCITY.
+maximum  velocity. Reflects the current maximum velocity. If not modified by halui.max-velocity or similar it should reflect [TRAJ]MAX_VELOCITY.
 
 *mcodes*:: '(returns tuple of 10 integers)' -
 currently active M-codes.

docs/src/hal/halshow.txt

@@ -42,6 +42,7 @@ and used a file named my.halshow in the current directory:
 ----
 $ halshow  --fformat ".5f" ./my.halshow
 ----
+For more information regarding the format, please refer to https://www.tcl.tk/man/tcl8.6.11/TclCmd/format.html
 
 == HAL Tree Area
 

src/hal/components/and2.comp

@@ -13,6 +13,16 @@ Otherwise,
 .RE"""
 ;
 function _ nofp;
+see_also """
+.ie '\\*[.T]'html' \\{\\
+.UR logic.9.html
+\\fBlogic\\fR(9)
+.UE
+\\}
+.el \\{\\
+\\fBlogic\\fR(9)
+\\}
+""";
 license "GPL";
 ;;
 FUNCTION(_) { out = in0 && in1; }

src/hal/components/or2.comp

@@ -14,6 +14,16 @@ Otherwise,
 .RE"""
 ;
 function _ nofp;
+see_also """
+.ie '\\*[.T]'html' \\{\\
+.UR logic.9.html
+\\fBlogic\\fR(9)
+.UE
+\\}
+.el \\{\\
+\\fBlogic\\fR(9)
+\\}
+""";
 license "GPL";
 ;;
 FUNCTION(_) { out = in0 || in1; }

src/hal/components/xor2.comp

@@ -14,6 +14,16 @@ to the following rule:
 Otherwise,
 \\fBout=FALSE\\fR""";
 function _ nofp;
+see_also """
+.ie '\\*[.T]'html' \\{\\
+.UR logic.9.html
+\\fBlogic\\fR(9)
+.UE
+\\}
+.el \\{\\
+\\fBlogic\\fR(9)
+\\}
+""";
 license "GPL";
 ;;
 FUNCTION(_) {