Skip to content

Commit 33c749d

Browse files
committed
docs: Updated/extended halshow doc
1 parent cbd6a2f commit 33c749d

2 files changed

Lines changed: 16 additions & 6 deletions

File tree

docs/man/man1/halshow.1

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,35 @@
2424
.\"
2525
.TH HALSHOW "1" "2020-08-26" "LinuxCNC Documentation" "The Enhanced Machine Controller"
2626
.SH NAME
27-
halshow \- short description
27+
halshow \- Show HAL parameters, pins and signals
2828
.SH SYNOPSIS
29-
.B halshow
29+
.B halshow [Options] [watchfile]
3030

31+
.SH OPTIONS
32+
--help (help)
33+
--fformat format_string_for_float
34+
--iformat format_string_for_int
35+
36+
For format see
37+
.UR https://www.tcl.tk/man/tcl8.6.11/TclCmd/format.html
38+
.UE
39+
40+
Example:
41+
"%.5f" displays a float with 5 digits right of the decimal point
3142
.SH DESCRIPTION
3243
\fBhalshow\fR creates a GUI interface to view and interact with a running
3344
HAL session.
3445
It is documented in the PDF and HTML docs much more completely than is
3546
possible in a manpage:
36-
http://linuxcnc.org/docs/html/hal/halshow.html
37-
47+
.UR http://linuxcnc.org/docs/html/hal/halshow.html
48+
.UE
3849

3950
.SH "SEE ALSO"
4051
\fBLinuxCNC(1)\fR
4152

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

45-
.SH HISTORY
46-
4756
.SH BUGS
4857
None known at this time.
4958
.PP

docs/src/hal/halshow.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ and used a file named my.halshow in the current directory:
4242
----
4343
$ halshow --fformat ".5f" ./my.halshow
4444
----
45+
For more information regarding the format, please refer to https://www.tcl.tk/man/tcl8.6.11/TclCmd/format.html
4546

4647
== HAL Tree Area
4748

0 commit comments

Comments
 (0)