Skip to content

Commit 43106f2

Browse files
authored
Merge pull request #2005 from smoe/docs_man_asccidoc
docs: man asciidoc - series of small changes
2 parents f1dbc08 + d1aadf7 commit 43106f2

91 files changed

Lines changed: 415 additions & 356 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/man/man1/gladevcp.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ one can move the panel to a second monitor and force it to use all of the screen
7070

7171
.TP
7272
\fB\-R\fR
73-
explicitly deactivate workaround for a gtk bug which makes matches of widget and widget_class
74-
matches in gtk theme and gtkrc files fail. Normally not needed.
73+
explicitly deactivate workaround for a GTK bug which makes matches of widget and widget_class
74+
matches in GTK theme and gtkrc files fail. Normally not needed.
7575

7676
.SH "SEE ALSO"
7777
\fIGladeVCP\fR in the LinuxCNC documentation for a description of GladeVCP's capabilities

docs/man/man1/gmoccapy.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@
2727
gmoccapy \- TOUCHY LinuxCNC Graphical User Interface
2828
.SH SYNOPSIS
2929
.B gmoccapy
30-
\fI\-ini\fR \fIINIFILE\fR
30+
\fI\-ini\fR \fI<INI file>\fR
3131
.SH DESCRIPTION
3232
\fBgmoccapy\fR is one of the Graphical User Interfaces (GUI) for LinuxCNC
3333
It gets run by the runscript usually.
3434
.SH OPTIONS
3535
.TP
36-
\fBINIFILE\fR
37-
The ini file is the main piece of an LinuxCNC configuration. It is not the
36+
\fBINI file\fR
37+
The \fIINI file\fR is the main piece of an LinuxCNC configuration. It is not the
3838
entire configuration; there are various other files that go with it
3939
(NML files, HAL files, TBL files, VAR files). It is, however, the most
4040
important one, because it is the file that holds the configuration

docs/man/man1/gremlin_view.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ gremlin_view \- G-code graphical preview
2929
.B gremlin_view
3030

3131
.SH DESCRIPTION
32-
\fBgremlin_view\fR is a python wrapper for the gremlin G-code graphical
32+
\fBgremlin_view\fR is a Python wrapper for the gremlin G-code graphical
3333
preview
3434

3535
PGremlinView for gremlin with buttons for simpler embedding
@@ -47,15 +47,15 @@ Optional radiobutton group names:
4747
'select_y_view'
4848
'select_z_view'
4949
'select_z2_view'
50-
Optional Checkbuttons names:
50+
Optional checkbuttons names:
5151
'enable_dro'
5252
'show_machine_speed
5353
'show_distance_to_go'
5454
'show_limits'
5555
'show_extents'
5656
'show_tool'
5757
'show_metric'
58-
Callbacks are provided for the following buttons actions
58+
Callbacks are provided for the following button actions
5959
on_clear_live_plotter_clicked
6060
on_enable_dro_clicked
6161
on_zoomin_pressed

docs/man/man1/gs2_vfd.1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ become annoying. Debug mode will cause all modbus messages to be printed
5757
in hex on the terminal.
5858
.B
5959
.IP \-n,\ \-\-name\ <string>
60-
(default gs2_vfd) Set the name of the HAL module. The HAL comp name will be set to <string>, and all pin and parameter names will begin with <string>.
60+
(default gs2_vfd) Set the name of the HAL module.
61+
The HAL comp name will be set to <string>, and all pin and parameter names will begin with <string>.
6162
.B
6263
.IP \-p,\ \-\-parity\ [even,odd,none]
6364
(default odd) Set serial parity to even, odd, or none.

docs/man/man1/hal-histogram.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ hal-histogram \- plots the value of a HAL pin as a histogram
2929
.B hal-histogram
3030

3131
.SH DESCRIPTION
32-
\fBhal-histogram\fR represents the values of a hal pin graphically.
32+
\fBhal-histogram\fR represents the values of a HAL pin graphically.
3333

3434
Details:
3535
.nf http://linuxcnc.org/docs/html/hal/tools.html#_hal_histogram

docs/man/man1/hal_manualtoolchange.1

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,15 @@ hal_manualtoolchange \- HAL userspace component to enable manual tool changes.
2626
.SH SYNOPSIS
2727
loadusr hal_manualtoolchange
2828
.SH DESCRIPTION
29-
hal_manualtoolchange is a LinuxCNC userspace component that allows users with machines lacking automatic tool changers to make manual tool changes. In use when a M6 tool change is encountered, the motion component will stop the spindle and pause the program. The hal_manualtoolchange component will then receive a signal from the motion component causing it to display a tool change window prompting the user which tool number to load based on the last T\- number programmed. The dialog will stay active until the "continue" button is pressed. When the "continue" button is pressed, hal_manualtoolchange will then signal the motion component that the tool change is complete thus allowing motion to turn the spindle back on and resume program execution.
29+
hal_manualtoolchange is a LinuxCNC userspace component that allows users with machines lacking automatic tool changers to make manual tool changes.
30+
In use when a M6 tool change is encountered, the motion component will stop the spindle and pause the program.
31+
The hal_manualtoolchange component will then receive a signal from the motion component causing it to display a tool change window prompting the user which tool number to load based on the last T\- number programmed.
32+
The dialog will stay active until the "continue" button is pressed. When the "continue" button is pressed, hal_manualtoolchange will then signal the motion component that the tool change is complete thus allowing motion to turn the spindle back on and resume program execution.
3033
.PP
31-
Additionally, The hal_manualtoolchange component includes a hal pin for a button that can be connected to a physical button to complete the tool change and remove the window prompt (hal_manualtoolchange.change_button).
34+
Additionally, the hal_manualtoolchange component includes a hal pin for a button that can be connected to a physical button to complete the tool change and remove the window prompt (hal_manualtoolchange.change_button).
3235
.PP
33-
hal_manualtoolchange can be used even when AXIS is not used as the GUI. This component is most useful if you have presettable tools and you use the tool table.
36+
hal_manualtoolchange can be used even when AXIS is not used as the GUI.
37+
This component is most useful if you have presettable tools and you use the tool table.
3438
.SH PINS
3539
.TP
3640
.B hal_manualtoolchange.number\fR s32 in\fR
@@ -45,13 +49,16 @@ Signifies that the tool change is complete.
4549
.B hal_manualtoolchange.change_button\fR bit in\fR
4650
Pin to allow an external switch to signify that the tool change is complete.
4751
.SH USAGE
48-
Normal usage is to load the component in your HAL file and net the appropriate pins from the\fI motion\fR and\fI io\fR components. The following lines are typical in a HAL file when using the hal_manualtoolchange userspace component.
52+
Normal usage is to load the component in your HAL file and net the appropriate pins from the\fI motion\fR and\fI io\fR components.
53+
The following lines are typical in a HAL file when using the hal_manualtoolchange userspace component.
4954
.TP
5055
.B loadusr \-W hal_manualtoolchange
5156
This will load the hal_manualtoolchange userspace component waiting for the component to be ready before continuing.
5257
.TP
5358
.B net tool\-change iocontrol.0.tool\-change => hal_manualtoolchange.change
54-
When an M6 code is run, motion sets \fI iocontrol.0.tool\-change \fR to high indicating a tool change. This pin should be netted to \fI hal_manualtoolchange.change\fR. This causes the Tool change dialog to be displayed on screen and wait for the user to either click the continue button on the dialog or press an externally connected button.
59+
When an M6 code is run, motion sets \fI iocontrol.0.tool\-change \fR to high indicating a tool change.
60+
This pin should be netted to \fI hal_manualtoolchange.change\fR.
61+
This causes the Tool change dialog to be displayed on screen and wait for the user to either click the continue button on the dialog or press an externally connected button.
5562
.TP
5663
.B net tool\-changed iocontrol.0.tool\-changed <= hal_manualtoolchange.changed
5764
When the Tool change dialog's continue button is pressed, it will set the
@@ -65,12 +72,14 @@ When a T\- command is executed in a G-code program, the tool number will held in
6572
.I iocontrol.0.tool\-prep\-number\fR. \fR
6673
This pin should be netted to
6774
.I hal_manualtoolchange.number\fR. \fR
68-
The value of this pin, the tool number is displayed in the Tool change dialog to let the user know which tool should be loaded.
75+
The value of this pin, the tool number is displayed in the tool change dialog to let the user know which tool should be loaded.
6976
.TP
7077
.B net tool\-prepare\-loopback iocontrol.0.tool\-prepare => iocontrol.0.tool\-prepared
71-
The \fI iocontrol.0.tool\-prepare \fR pin will go true when a Tn tool prepare is requested. Since there is not automated tool changer this pin should be netted to \fI iocontrol.0.tool\-prepared \fR to indocate that the tool has been prepared.
78+
The \fI iocontrol.0.tool\-prepare \fR pin will go true when a T\fIn\fR tool prepare is requested.
79+
Since there is not automated tool changer this pin should be netted to \fI iocontrol.0.tool\-prepared \fR to indocate that the tool has been prepared.
7280
.PP
73-
If you wish to use an external button to signal the hal_manualtoolchange component that the tool change is complete simply bring the button into HAL (via a parport input pin or a hostmot2 gpio input or similar), and wire it directly to the \fI hal_manualtoolchange.change_button \fR pin. For Example:
81+
If you wish to use an external button to signal the hal_manualtoolchange component that the tool change is complete simply bring the button into HAL (via a parport input pin or a hostmot2 gpio input or similar), and wire it directly to the \fI hal_manualtoolchange.change_button \fR pin.
82+
For Example:
7483
.PP
7584
.B net tool\-changed\-btn hal_manualtoolchange.change_button <= parport.0.pin\-15\-in
7685
.SH SEE ALSO

0 commit comments

Comments
 (0)