Skip to content

Commit

Permalink
docs: More changes while translating (smoe:docs_man_adoc_20240918) (#…
Browse files Browse the repository at this point in the history
…3153)

* docs: changes while translating

A bit more while translating

* docs: Syntax fix, as found by Petter

* More changes while translating.

* docs: More translation-associated observations.

* docs: More changes triggered while translating.
  • Loading branch information
smoe authored Oct 22, 2024
1 parent 5ec17ac commit 125a11d
Show file tree
Hide file tree
Showing 39 changed files with 1,576 additions and 1,773 deletions.
2 changes: 1 addition & 1 deletion docs/src/code/building-linuxcnc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Non-realtime::
but it is useful for simulating the execution of G-code and for testing the non-realtime parts of the system
(such as the user interfaces, and some kinds of components and device drivers). +
To make use of the realtime capabilities of LinuxCNC, certain parts of LinuxCNC need to run with root privileges.
To enable root for these parts, run this extra command after the `make` that builds LinuxCNC: +
To enable root for these parts, run this extra command after the `make` that builds LinuxCNC:
-----
$ sudo make setuid
-----
Expand Down
17 changes: 7 additions & 10 deletions docs/src/common/linux-faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Most OS's have the terminal as a menu item, usually in Accessories.
== Man Pages(((Man Pages)))

A man page (short for manual page) is a form of software documentation
usually found on a Unix or Unix-like operating system like Linux.
usually found on a UNIX or UNIX-like operating system like Linux.

To view a man page open up a terminal to find out something about the
find command in the terminal window type:
Expand Down Expand Up @@ -115,8 +115,7 @@ it will be named mymod.txt or what ever you named it.
When you open the file browser and you see the owner of the file is
root you must do extra steps to edit that file. Editing some root files
can have bad results. Be careful when editing root files. Generally, you
can open and view most root files, but they will open in 'read only'
mode.
can open and view most root files, but they will open in 'read only' mode.

=== The Command Line Way

Expand All @@ -130,11 +129,10 @@ Open the file with File > Open > Edit

=== The GUI Way

. Right click on the desktop and select Create Launcher
. Type a name in like sudo edit
. Type 'gksudo "gnome-open %u"' as the command and save the launcher to
your desktop
. Drag a file onto your launcher to open and edit
. Right click on the desktop and select Create Launcher.
. Type a name in like sudo edit.
. Type 'gksudo "gnome-open %u"' as the command and save the launcher to your desktop.
. Drag a file onto your launcher to open and edit.

=== Root Access

Expand All @@ -146,8 +144,7 @@ foul things up as root if you don't know what you're doing.

=== Working Directory

To find out the path to the present working directory in the terminal
window type:
To find out the path to the present working directory in the terminal window, type:

----
pwd
Expand Down
5 changes: 4 additions & 1 deletion docs/src/config/ini-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,10 @@ Descriptions of the interfaces are in the Interfaces section of the User Manual.
* `HOMING_PROMPT = TRUE` - Show prompt message with homing request, when the Power On button is pressed in AXIS GUI. Pressing the "Ok" button in prompt message is equivalent to pressing the "Home All" button(or the Ctrl-HOME key).
* `FOAM_W = 1.5` sets the foam W height.
* `FOAM_Z = 0` sets the foam Z height.
* `GRAPHICAL_MAX_FILE_SIZE = 20` largest size (in mega bytes) that will be displayed graphically. If the program is bigger then this setting, a bounding box will be displayed. By default this setting is 20 MB or 1/4 of the system memory, which ever is smaller. Setting negative will set no limit.
* `GRAPHICAL_MAX_FILE_SIZE = 20` largest size (in mega bytes) that will be displayed graphically.
If the program is bigger than this setting, a bounding box will be displayed.
By default, this setting is at 20 MB or 1/4 of the system memory, which ever is smaller.
A negative value is interpreted as unlimited.

[NOTE]
The following [DISPLAY] items are used by GladeVCP and PyVCP,
Expand Down
3 changes: 1 addition & 2 deletions docs/src/config/lathe-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ COORDINATES = X Z
----

With joints_axes incorporation, a simpler configuration can be made with just
the two required joints by specifying trivkins with the 'coordinates='
parameter:
the two required joints by specifying trivkins with the 'coordinates=' parameter:

[source,{ini}]
----
Expand Down
45 changes: 21 additions & 24 deletions docs/src/config/moveoff.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@
:hal: {basebackend@docbook:'':hal}
:ngc: {basebackend@docbook:'':ngc}

The moveoff HAL component is a HAL-only method
for implementing offsets. See the manpage ('$ man moveoff')
for the IMPORTANT limitations and warnings.
The moveoff HAL component is a HAL-only method for implementing offsets.
See the manpage ('$ man moveoff') for the IMPORTANT limitations and warnings.

The moveoff component is used to offset joint positions using custom HAL
connections. Implementing an offset-while-program-is-paused functionality is
supported with appropriate connections for the input pins. Nine joints are
supported.
The moveoff component is used to offset joint positions using custom HAL connections.
Implementing an offset-while-program-is-paused functionality is supported
with appropriate connections for the input pins. Nine joints are supported.

The axis offset pin values (offset-in-M) are continuously applied (respecting
limits on value, velocity, and acceleration) to the output pins
Expand All @@ -44,12 +42,12 @@ regardless of the state of the backtrack-enable pin. An enabling pin must be
deasserted to allow a return to the original (non-offset position).

Backtracking through waypoints results in 'slower' movement rates as the
moves are point-to-point respecting velocity and acceleration settings. The
velocity and acceleration limit pins can be managed dynamically to control
offsets at all times.
moves are point-to-point respecting velocity and acceleration settings.
The velocity and acceleration limit pins can be managed dynamically to
control offsets at all times.

When backtrack-enable is FALSE, the auto-return move is *NOT*
coordinated, each axis returns to zero at its own rate. If a controlled path
When backtrack-enable is FALSE, the auto-return move is *NOT* coordinated,
each axis returns to zero at its own rate. If a controlled path
is wanted in this condition, each axis should be manually returned to zero
before deasserting an enabling pin.

Expand All @@ -63,10 +61,9 @@ when offsetting during a pause), offsets are returned to zero (respecting
limits) and an 'Error' message is issued.

[CAUTION]
If offsets are enabled and applied and the machine is turned off for any
reason, any 'external' HAL logic that manages the enabling pins and the
offset-in-M inputs is responsible for their state when the machine is
subsequently turned on again.
If offsets are enabled and applied and the machine is turned off for any reason,
any 'external' HAL logic that manages the enabling pins and the offset-in-M inputs
is responsible for their state when the machine is subsequently turned on again.

This HAL-only means of offsetting is typically not known to LinuxCNC
nor available in GUI preview displays. *No protection is provided* for
Expand Down Expand Up @@ -123,12 +120,12 @@ to the corresponding joint.

Modify an existing configuration as follows:

Make sure there is an INI file entry for [HAL]HALUI and create a new
[HAL]HALFILE entry for LIB:hookup_moveoff.tcl.
The entry for LIB:hookup_moveoff.tcl should follow all HALFILE= entries
for HAL files that connect the pins for joint.N.motor-pos-cmd,
joint.N.motor-pos-fb, and any components connected to these pins (pid
and encoder components in a servo system for instance).
Make sure there is an INI file entry for `[HAL]HALUI` and create a new
`[HAL]HALFILE` entry for LIB:hookup_moveoff.tcl.
The entry for LIB:hookup_moveoff.tcl should follow all `HALFILE=` entries
for HAL files that connect the pins for `joint.N.motor-pos-cmd`,
`joint.N.motor-pos-fb`, and any components connected to these pins
(pid and encoder components in a servo system for instance).

[source,{ini}]
----
Expand Down Expand Up @@ -250,8 +247,8 @@ be managed by subsequent HALFILES (including POSTGUI_HALFILEs) to provide
customized control of the component while using the moveoff_gui display
for current offset values and offset status.

The moveoff_gui is configured with command line options. For details
on the operation of moveoff_gui, see the man page:
The moveoff_gui is configured with command line options.
For details on the operation of moveoff_gui, see the man page:

----
$ man moveoff_gui
Expand Down
Loading

0 comments on commit 125a11d

Please sign in to comment.