.\" Copyright (c) 2006 John Kasunich
.\"                (jmkasunich AT users DOT sourceforge DOT net)
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
.\" USA.
.\"
.\"
.\"
.TH HALMETER "1"  "2006-03-13" "LinuxCNC Documentation" "HAL User's Manual"
.SH NAME
halmeter \- observe HAL pins, signals, and parameters
.SH SYNOPSIS
.B halmeter
[\fB\-s\fR] [\fBpin\fR|\fBsig\fR|\fBparam\fR \fIname\fR] [\fB\-g\fR \fIX-position Y-position [Width]\fR]
.SH DESCRIPTION
\fBhalmeter\fR is used to observe HAL (Hardware Abstraction
Layer) pins, signals, or parameters.  It serves the same
purpose as a multimeter does when working on physical systems.
.SH OPTIONS
.TP
\fBpin\fR \fIname\fR
Display the HAL pin \fIname\fR.
.TP
\fBsig\fR \fIname\fR
Display the HAL signal \fIname\fR.
.TP
\fBparam\fR \fIname\fR
Display the HAL parameter \fIname\fR.
.TP
If neither \fBpin\fR, \fBsig\fR, or \fBparam\fR are specified, the window starts out blank and the user must select an item to observe.
.TP
\fB\-s\fR
Small window.  Non-interactive, must be used with \fBpin\fR, \fBsig\fR,
or \fBparam\fR to select the item to display.  The item name is displayed
in the title bar instead of the window, and there are no "Select" or "Exit"
buttons.  Handy when you want a lot of meters in a small space.
.TP
\fB\-g\fR
Geometry position.  Allows one to specify the initial starting position
and optionally the width of the meter. Referenced from top left of screen
in pixel units.
Handy when you want to load a lot of meters in a script with out them
displaying on top of each other.
.SH USAGE
Unless \fB\\-s\fR is specified, there are two buttons, "Select" and "Exit".
"Select" opens a dialog box to select the item (pin, signal, or parameter)
to be observed.  "Exit" does what you expect.

The selection dialog has "OK", "Apply", and "Cancel" buttons.  OK displays
the selected item and closes the dialog.  "Apply" displays the selected
item but keeps the selection dialog open.  "Cancel" closes the dialog
without changing the displayed item.

.SH EXAMPLES

.TP
\fBhalmeter\fR
Opens a meter window, with nothing initially displayed.  Use the "Select"
button to choose an item to observe.  Does not return until the window
is closed.
.TP
\fBhalmeter &\fR
Open a meter window, with nothing initially displayed.  Use the "Select"
button to choose an item.  Runs in the background leaving the shell
free for other commands.
.TP
\fBhalmeter pin\fR \fIparport.0.pin\-03\-out\fR \fB&\fR
Open a meter window, initially displaying HAL pin \fIparport.0.pin\-03\-out\fR.
The "Select" button can be used to display other items.  Runs in background.

.TP
\fBhalmeter \-s pin\fR \fIparport.0.pin\-03\-out\fR \fB&\fR
Open a small meter window, displaying HAL pin \fIparport.0.pin\-03\-out\fR.
The displayed item cannot be changed.  Runs in background.

.TP
\fBhalmeter \-s pin\fR \fIparport.0.pin\-03\-out\fR \fB\-g\fR \fI100 500\fR \fB&\fR
Open a small meter window, displaying HAL pin \fIparport.0.pin\-03\-out\fR.
places it 100 pixels to the left and 500 pixels down from top of screen.
The displayed item cannot be changed.  Runs in background.

.TP
\fBhalmeter \-s pin\fR \fIparport.0.pin\-03\-out\fR \fB\-g\fR \fI100 500 400\fR \fB&\fR
Open a small meter window, displaying HAL pin \fIparport.0.pin\-03\-out\fR.
places it 100 pixels to the left and 500 pixels down from top of screen.
The width will be 400 pixels (270 is default)
The displayed item cannot be changed.  Runs in background.

.SH AUTHOR
Original version by John Kasunich, as part of the LinuxCNC
project.  Improvements by several other members of
the LinuxCNC development team.
.SH REPORTING BUGS
Report bugs to jmkasunich AT users DOT sourceforge DOT net
.SH COPYRIGHT
Copyright \(co 2003 John Kasunich.
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.