Merge pull request #1849 from smoe/docs_stupid_simple_stuff

Docs stupid simple stuff

Author: SebKuzminsky

docs/man/man3/hal_init.3hal

@@ -25,5 +25,5 @@ Call only from within user or init/cleanup code, not from relatime tasks.
 
 .SH RETURN VALUE
 On success, returns a positive integer module ID, which is
-used for subsequent calls to hal and rtapi APIs.
+used for subsequent calls to HAL and rtapi APIs.
 On failure, returns a HAL error code.

docs/man/man3/hal_malloc.3hal

@@ -9,7 +9,7 @@ hal_malloc \- Allocate space in the HAL shared memory area
 
 .SH  ARGUMENTS
 .IP \fIsize\fR
-Gives the size, in bytes, of the block
+Gives the size, in bytes, of the block.
 
 .SH DESCRIPTION
 \fBhal_malloc\fR allocates a block of memory from the main HAL shared memory area.

docs/src/gcode/o-code.adoc

@@ -44,9 +44,9 @@ change in the future.
 
 The behavior is undefined if:
 
-* The same number is used for more than one block
-* Other words are used on a line with an O- word
-* Comments are used on a line with an O-word
+* The same number is used for more than one block.
+* Other words are used on a line with an O- word.
+* Comments are used on a line with an O-word.
 
 [NOTE]
 Using the lower case 'o' makes it easier to distinguish from a 0
@@ -369,7 +369,7 @@ o[#101+2] call
 ----
 
 .Computing values in O-words
-For more information on computing values see the following sections
+For more information on computing values see the following sections:
 
 * <<sec:overview-parameters,Parameters>>
 * <<gcode:expressions,Expressions>>
@@ -381,7 +381,7 @@ For more information on computing values see the following sections
 
 To call a separate file with a subroutine name the file the same as
 your call and include a sub and endsub in the file. The file must be in the
-directory pointed to by 'PROGRAM_PREFIX' or 'SUBROUTINE_PATH' in the ini file.
+directory pointed to by 'PROGRAM_PREFIX' or 'SUBROUTINE_PATH' in the INI file.
 The file name can include *lowercase* letters, numbers, dash, and underscore
 only. A named subroutine file can contain only a single subroutine definition.
 

docs/src/gcode/other-code.adoc

@@ -13,14 +13,14 @@
 The application of the feed rate is as described in the
 <<sub:feed-rate,Feed Rate>> Section, unless 'inverse time feed rate mode'
 or 'feed per revolution mode' are in effect, in which case the feed rate
-is as described in the <<gcode:g93-g94-g95,G93 G94 G95>> Section.
+is as described in the <<gcode:g93-g94-g95,G93 G94 G95>> section.
 
 [[sec:set-spindle-speed]]
 == S: Set Spindle Speed(((S: Set Spindle Speed)))
 
 'Sx [$n]' - set the speed of the spindle to 'x' revolutions per minute (RPM)
 with the optional $ set the spindle speed for a specific spindle. Without the $
-the command will default to spindle.0
+the command will default to spindle.0.
 
 The spindle(s) or selected spindle will turn at that speed when a 'M3' or 'M4'
 is in effect. It is OK to program an S word whether the spindle is turning or

docs/src/gcode/overview.adoc

@@ -29,7 +29,7 @@ rate to the programmed end point', and 'X3' provides an argument
 value (the value of X should be 3 at the end of the move).
 Most LinuxCNC G-code commands start with either G or M (for
 General and Miscellaneous). The words for these commands are called 'G
-codes' and 'M-codes.'
+codes' and 'M-codes'.
 
 The LinuxCNC language has no indicator for the start of a program. The
 Interpreter, however, deals with files. A single program may be in a
@@ -273,7 +273,7 @@ value found in parameter 3. The '\#' character may be repeated; for
 example '##2'  means the value of the parameter whose index is the
 (integer) value of parameter 2.
 
-* '31-5000' - G code user parameters. These parameters are global in the G
+* '31-5000' - G-code user parameters. These parameters are global in the G
   code file, and available for general use. Volatile.
 * '5061-5069' - Coordinates of a <<gcode:g38,G38>> probe result (X, Y,
   Z, A, B, C, U, V & W).  Coordinates are in the coordinate system in
@@ -585,7 +585,7 @@ to the values of INI file entries and HAL pins.
 * '#<_ini[section]name>' Returns the value of the corresponding item in
   the INI file.
 
-For example, if the ini file looks like so:
+For example, if the INI file looks like so:
 
 [source,{ini}]
 ---------------------------------------------------------------------
@@ -597,7 +597,7 @@ YPOS = 2.718
 you may refer to the named parameters `#<_ini[setup]xpos>` and
 `#<_ini[setup]ypos>` within G-code.
 
-`EXISTS` can be used to test for presence of a given ini file
+`EXISTS` can be used to test for presence of a given INI file
 variable:
 
 [source,{ngc}]
@@ -609,10 +609,10 @@ o100 else
 o100 endif
 ---------------------------------------------------------------------
 
-The value is read from the inifile once, and cached in the
+The value is read from the INI file once, and cached in the
 interpreter. These parameters are read-only - assigning a value will
 cause a runtime error. The names are not case sensitive - they are
-converted to uppercase before consulting the ini file.
+converted to uppercase before consulting the INI file.
 
 * '#<_hal[Hal item]>'
   Allows G-code programs to read the values of HAL pins Variable access is
@@ -1222,11 +1222,11 @@ material removal rate.
 * 'G-code out of range' - A G-code greater than G99 was used, the scope of G
   codes in LinuxCNC is 0 - 99. Not every number between 0 and 99 is a valid
   G-code.
-* 'Unknown g code used' - A G-code was used that is not part of the LinuxCNC
+* 'Unknown G-code used' - A G-code was used that is not part of the LinuxCNC
   G-code language.
 * 'i,j,k word with no Gx to use it' - i, j and k words must be used on the same
   line as the G-code.
-* 'Cannot use axis values without a g code that uses them' - Axis values can
+* 'Cannot use axis values without a G-code that uses them' - Axis values can
   not be used on a line without either a modal G-code in effect or a G-code
   on the same line.
 * 'File ended with no percent sign or program end' - Every G-code file must

docs/src/gui/gmoccapy.adoc

@@ -286,10 +286,10 @@ will hide the chosen box.
 image::images/gmoccapy_embedded_tabs.png[align="left"]
 
 [NOTE]
-If you make any hal connections to your custom glade panel, you need to do that in the hal file
-specified in the EMBED_TAB_COMMAND line, otherwise you may get an error that the hal pin does not exist --
-this is because of race conditions loading the hal files. Connections to gmoccapy hal pins need to be made in the
-postgui hal file specified in your INI file, because these pins do not exist prior of realizing the GUI.
+If you make any HAL connections to your custom glade panel, you need to do that in the HAL file
+specified in the EMBED_TAB_COMMAND line, otherwise you may get an error that the HAL pin does not exist --
+this is because of race conditions loading the HAL files. Connections to gmoccapy HAL pins need to be made in the
+postgui HAL file specified in your INI file, because these pins do not exist prior of realizing the GUI.
 
 Here are some examples:
 
@@ -306,7 +306,7 @@ image::images/gmoccapy_with_left_box_in_edit_mode.png[align="left"]
 image::images/gmoccapy_with_right_panel_in_MDI_mode.png[align="left"]
 
 ==== Configuration of User Created Messages
-Gmoccapy has the ability to create hal driven user messages. To use them you
+Gmoccapy has the ability to create HAL driven user messages. To use them you
 need to introduce some lines in the [DISPLAY] section of the INI file.
 
 Here is how to set up 3 user pop up message dialogs the messages support pango
@@ -317,7 +317,7 @@ https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango Markup]
 ----
 MESSAGE_TEXT    = The text to be displayed, may be pango markup formatted
 MESSAGE_TYPE    = "status" , "okdialog" , "yesnodialog"
-MESSAGE_PINNAME = is the name of the hal pin group to be created
+MESSAGE_PINNAME = is the name of the HAL pin group to be created
 ----
 
 * 'status' : Will just display a message as pop up window, using the messaging
@@ -346,8 +346,8 @@ MESSAGE_TYPE = okdialog
 MESSAGE_PINNAME = okdialog
 ----
 
-The specific hal pin conventions for these can be found under the
-<<gmoccapy:user-created-message, User Messages>>  hal pin section.
+The specific HAL pin conventions for these can be found under the
+<<gmoccapy:user-created-message, User Messages>>  HAL pin section.
 
 [[gmocappy:rs274ngc]]
 === The RS274NGC Section
@@ -470,7 +470,7 @@ If MAX_VELOCITY is not given, it will default to 600
 
 == HAL Pins
 
-gmoccapy exports several hal pin to be able to react to hardware devices.
+gmoccapy exports several HAL pin to be able to react to hardware devices.
 The goal is to get a GUI that may be operated in a tool shop, completely/mostly
 without mouse or keyboard.
 
@@ -522,10 +522,10 @@ and the bottom (horizontal) buttons are:
 
 As the buttons in the bottom list will change according the mode and other
 influences, the hardware buttons will activate different functions, and you
-don't have to take care about switching functions around in hal, because that
+don't have to take care about switching functions around in HAL, because that
 is done completely by gmoccapy!
 
-for a 3 axis XYZ machine the hal pin will react as follows:
+for a 3 axis XYZ machine the HAL pin will react as follows:
 
 in manual mode:
 
@@ -573,11 +573,11 @@ in settings mode:
 * gmoccapy.h-button.button-2 ==
 * gmoccapy.h-button.button-3 ==
 * gmoccapy.h-button.button-4 == open classic ladder
-* gmoccapy.h-button.button-5 == open hal scope
-* gmoccapy.h-button.button-6 == open hal status
-* gmoccapy.h-button.button-7 == open hal meter
-* gmoccapy.h-button.button-8 == open hal calibration
-* gmoccapy.h-button.button-9 == open hal show
+* gmoccapy.h-button.button-5 == open HAL scope
+* gmoccapy.h-button.button-6 == open HAL status
+* gmoccapy.h-button.button-7 == open HAL meter
+* gmoccapy.h-button.button-8 == open HAL calibration
+* gmoccapy.h-button.button-9 == open HAL show
 
 in homing mode:
 
@@ -644,7 +644,7 @@ in select file mode:
 * gmoccapy.h-button.button-8 ==
 * gmoccapy.h-button.button-9 == back
 
-*So we have 67 reactions with only 10 hal pin!*
+*So we have 67 reactions with only 10 HAL pin!*
 
 These pins are made available to be able to use the screen without an touch
 panel, or protect it from excessive use by placing hardware buttons around
@@ -657,7 +657,7 @@ image::images/gmoccapy_0_9_7_sim_hardware_button.png[align="left"]
 All sliders from gmoccapy can be connected to hardware encoder or hardware potentiometers.
 
 [NOTE]
-for gmoccapy 3 the hal pin name has changed, as new controls has been implemented,
+for gmoccapy 3 the HAL pin name has changed, as new controls has been implemented,
 max velocity does not exist any more, as rapid override has been implemented.
 This change has been done as many user ask for that.
 
@@ -678,7 +678,7 @@ To connect 'encoders' the following pin are exported:
 | gmoccapy.rapid.rapid-override.count-enable      | HAL_BIT | Must be True, to enable counts
 |====
 
-To connect 'potentiometers', use the following hal pin:
+To connect 'potentiometers', use the following HAL pin:
 
 [{pin_tab_options}]
 |====
@@ -693,7 +693,7 @@ To connect 'potentiometers', use the following hal pin:
 | gmoccapy.rapid.rapid-override.analog-enable     | HAL_BIT   | Must be True, to allow analog inputs
 |====
 
-In addition gmoccapy 3 offers additional hal pin to control the new slider widgets with momentary switches.
+In addition gmoccapy 3 offers additional HAL pin to control the new slider widgets with momentary switches.
 The values how fast the increase or decrease will be, must be set in the glade file.
 In a future release it will be integrated in the settings page.
 
@@ -732,13 +732,13 @@ you want to set the slider value.
 [WARNING]
 If you use both connection types, do not connect the same slider to
 both pin, as the influences between the two has not been tested! Different
-sliders may be connected to the one or other hal connection type.
+sliders may be connected to the one or other HAL connection type.
 
 [IMPORTANT]
 Please be aware, jog velocity depends on the turtle button state,
 it will lead to different slider scales depending on the mode
 (turtle or rabbit). Please take also a look to
-<<gmoccapy:jog-velocity,jog velocities and turtle-jog hal pin>> for more
+<<gmoccapy:jog-velocity,jog velocities and turtle-jog HAL pin>> for more
 details.
 
 .Example
@@ -759,9 +759,9 @@ All axis given in the INI File have a jog-plus and a jog-minus pin, so
 hardware momentary switches can be used to jog the axis.
 
 [NOTE]
-naming of this hal pin has changed for gmoccapy2
+naming of this HAL pin has changed for gmoccapy2
 
-For the standard XYZ config following hal Pin will be available:
+For the standard XYZ config following HAL Pin will be available:
 
 * gmoccapy.jog.axis.jog-x-plus
 * gmoccapy.jog.axis.jog-x-minus
@@ -793,19 +793,19 @@ divider can be set on the <<gmoccapy:turtle-jog,settings page>>.
 
 So using a touch screen it is much easier to select smaller velocities.
 
-gmoccapy offers a hal pin to toggle between turtle and rabbit jogging
+gmoccapy offers a HAL pin to toggle between turtle and rabbit jogging
 
 * gmoccapy.jog.turtle-jog   (Hal Bit In)
 
 === Jog Increment Hal Pins
 
-The jog increments are selectable through hal pins, so a selection hardware
+The jog increments are selectable through HAL pins, so a selection hardware
 switch can be used to select the increment to use. There will be a maximum
-of 10 hal pin for the increments given in the INI File, if you give more
+of 10 HAL pin for the increments given in the INI File, if you give more
 increments in your INI File, they will be not reachable from the GUI as they
 will not be displayed.
 
-If you have 6 increments in your hal you will get *7* pins:
+If you have 6 increments in your HAL you will get *7* pins:
 jog-inc-0 is unchangeable and will represent continuous jogging.
 
 * gmoccapy.jog.jog-inc-0
@@ -816,7 +816,7 @@ jog-inc-0 is unchangeable and will represent continuous jogging.
 * gmoccapy.jog.jog-inc-5
 * gmoccapy.jog.jog-inc-6
 
-gmoccapy offers also a hal pint to output the selected jog invrement
+gmoccapy offers also a HAL pint to output the selected jog invrement
 
 * gmoccapy.jog.jog-increment
 
@@ -944,7 +944,7 @@ net tool-prep-loop iocontrol.0.tool-prepare <= iocontrol.0.tool-prepared
 ----
 
 [NOTE]
-Please take care, that this connections have to be done in the postgui hal file!
+Please take care, that this connections have to be done in the postgui HAL file!
 
 .Tool Offset Pins
 These pins allow you to show the active tool offset values for X and Z in the
@@ -956,7 +956,7 @@ image::images/gmoccapy_0_9_7_tool_info.png["Tool information",align="left"]
 * gmoccapy.tooloffset-z
 
 [NOTE]
-Please take care, that this connections have to be done in the postgui hal file!
+Please take care, that this connections have to be done in the postgui HAL file!
 
 [NOTE]
 the tooloffset-x line is not needed on a mill,
@@ -979,7 +979,7 @@ each tool change!
 
 Gmoccapy offers an integrated auto tool measurement. To use this feature, you
 will need to do some additional settings and you may want to use the
-offered hal pin to get values in your own ngc remap procedure.
+offered HAL pin to get values in your own ngc remap procedure.
 
 [IMPORTANT]
 Before starting the first test, do not forget to enter the probe
@@ -1113,7 +1113,7 @@ You may want to modify this file to fit more your needs.
 
 === Needed Hal Connections
 
-Connect the tool probe in your hal file like so:
+Connect the tool probe in your HAL file like so:
 
 [source,{hal}]
 ----
@@ -1356,8 +1356,8 @@ image::images/gmoccapy_settings_hardware.png["Hardware settings",align="left"]
 ==== Hardware MPG Scales
 
 For the different Hal Pin to connect MPG Wheels to, you may select individual scales to be applied.
-The main reason for this was my own test to solve this through hal connections, resulting in a very
-complex hal file. Imagine a user having an MPG Wheel with 100 ipr and he wants to slow down the max
+The main reason for this was my own test to solve this through HAL connections, resulting in a very
+complex HAL file. Imagine a user having an MPG Wheel with 100 ipr and he wants to slow down the max
 vel from 14000 to 2000 mm/min, that needs 12000 impulses, resulting in 120 turns of the wheel!
 Or an other user having a MPG Wheel with 500 ipr and he wants to set the spindle override witch has
 limits from 50 to 120 % so he goes from min to max within 70 impulses, meaning not even 1/4 turn.
@@ -1411,7 +1411,7 @@ There are three options to unlock the settings page:
 
 * use unlock code (the user must give a code to get in)
 * Do not use unlock code (There will be no security check)
-* Use hal pin to unlock  (hardware pin must be high to unlock the settings,
+* Use HAL pin to unlock  (hardware pin must be high to unlock the settings,
   see <<gmoccapy:hardware-unlock, hardware unlock pin>>
 
 Default is use unlock code (default = *123*)
@@ -1450,7 +1450,7 @@ This settings will have influence on the jog velocities.
   if in turtle mode (button pressed, showing the turtle)
 
 [NOTE]
-This button can be activated using the <<gmoccapy:jog-velocity,turtle-jog>> hal pin.
+This button can be activated using the <<gmoccapy:jog-velocity,turtle-jog>> HAL pin.
 
 [[gmoccapy:tool-measurement]]
 === Advanced Settings