Skip to content

Commit eead947

Browse files
authored
Merge pull request #2183 from smoe/docs_29_mac_11
docs: getting started (Docs 29 mac 11)
2 parents 7fd104e + bfe7589 commit eead947

1 file changed

Lines changed: 44 additions & 61 deletions

File tree

docs/src/getting-started/getting-linuxcnc.adoc

Lines changed: 44 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -281,58 +281,50 @@ run on any 64-bit x86 system)
281281
NOTE: LinuxCNC v2.8 is not supported on Ubuntu Lucid or older.
282282

283283
.Preempt-RT kernels
284-
The Preempt-rt kernels are available for Debian from the regular
285-
debian.org archive. The preempt-rt kernel for RaspBerry Pi is available
286-
from the LinuxCNC repository. The package is called `linux-image-rt-*`
287-
Simply install the package in the same way as any other package from the
288-
Synaptic Package manager or with apt-get at the command-line.
284+
The Preempt-rt kernels are available for Debian from the regular debian.org archive.
285+
The preempt-rt kernel for RaspBerry Pi is available from the LinuxCNC repository.
286+
The package is called `linux-image-rt-*`.
287+
Simply install the package in the same way as any other package from the Synaptic Package manager or with `apt-get` at the command-line.
289288

290289
.RTAI Kernels
291-
The RTAI kernels are available for download from the linuxcnc.org
292-
debian archive. The apt source is:
290+
The RTAI kernels are available for download from the linuxcnc.org debian archive.
291+
The apt source is:
293292

294293
* Debian Buster: `deb https://linuxcnc.org buster base`
295294
* Debian Wheezy: `deb https://linuxcnc.org wheezy base`
296295
* Ubuntu Precise: `deb https://linuxcnc.org precise base`
297296

298297
[NOTE]
299-
Debian Wheezy and Ubuntu Precise are both extremely old, and
300-
are out of their support period. It is strongly advised not to use either
301-
for a new install, and to seriously consider upgrading an existing
302-
installation.
298+
Debian Wheezy and Ubuntu Precise are both extremely old, and are out of their support period.
299+
It is strongly advised not to use either for a new install, and to seriously consider upgrading an existing installation.
303300

304-
The Buster / RTAI package is only available on amd64, but there are very
305-
few surviving systems that can not run a 64-bit OS.
301+
The Buster / RTAI package is only available on amd64, but there are very few surviving systems that can not run a 64-bit OS.
306302

307303
[WARNING]
308-
There are known issues with the 64-bit RTAI 5.2 kernel with
309-
this version of LinuxCNC. The system will occasionally lock solid.
310-
However, this has, so far, been seen only during system exit. While
311-
running the system appears to be stable. But should nevertheless be
312-
considered experimental at this point.
304+
There are known issues with the 64-bit RTAI 5.2 kernel with this version of LinuxCNC.
305+
The system will occasionally lock solid.
306+
However, this has, so far, been seen only during system exit.
307+
While running the system appears to be stable.
308+
But should nevertheless be considered experimental at this point.
313309

314310
[NOTE]
315-
If you decide to use the RTAI 5.2 kernel and see a problem outside the
316-
circumstances described above then please report it immediately to the
317-
project developers.
311+
If you decide to use the RTAI 5.2 kernel and see a problem outside the circumstances described above,
312+
then please report it immediately to the project developers.
318313

319314
=== Installing on Debian Buster (with Preempt-RT kernel)
320315

321316
. Install Debian Buster (Debian 10), amd64 version. You can download the
322-
installer here: https://www.debian.org/releases/buster/
317+
installer here: https://www.debian.org/releases/buster/ .
323318

324-
. After burning the iso and booting up if you don't want Gnome desktop
325-
select 'Advanced Options' > 'Alternative desktop environments' and
326-
pick the one you like.
319+
. After burning the iso and booting up, if you don't want Gnome desktop,
320+
select 'Advanced Options' > 'Alternative desktop environments' and pick the one you like.
327321

328322
. Then select 'Install' or 'Graphical Install'.
329323

330324
[WARNING]
331-
Do not enter a root password, if you do sudo is disabled and you won't
332-
be able to complete the following steps.
325+
Do not enter a root password, if you do sudo is disabled and you won't be able to complete the following steps.
333326

334-
. Run the following in a <<faq:terminal,terminal>> to bring the machine
335-
up to date with the latest packages.
327+
. Run the following in a <<faq:terminal,terminal>> to bring the machine up to date with the latest packages.
336328
+
337329
----
338330
sudo apt-get update
@@ -345,23 +337,19 @@ sudo apt-get dist-upgrade
345337
sudo apt-get install linux-image-rt-amd64
346338
----
347339

348-
. Re-boot, and select the Linux 4.19.0-9-rt-amd64 kernel (the exact
349-
kernel version might be different, look for the "-rt" suffix. This might be
350-
hidden in the "Advanced options for Debian Buster" sub-menu in Grub.
351-
When you log in, verify that `PREEMPT RT`is reported by the following
352-
command.
340+
. Re-boot, and select the Linux 4.19.0-9-rt-amd64 kernel (the exact kernel version might be different, look for the "-rt" suffix).
341+
This might be hidden in the "Advanced options for Debian Buster" sub-menu in Grub.
342+
When you log in, verify that `PREEMPT RT`is reported by the following command.
353343
+
354344
----
355345
uname -v
356346
----
357347

358-
. Open Applications Menu > System > Synaptic Package Manager search for
359-
'linux-image' and right click on the original non-rt and select
360-
'Mark for Complete Removal'. Reboot.
361-
This is to force the system to boot from the RT kernel. If you prefer
362-
to retain both kernels then the other kernels need not be deleted, but
363-
grub boot configuration changes will be needed beyond the scope of
364-
this document.
348+
. Open Applications Menu > System > Synaptic Package Manager,
349+
search for 'linux-image', right click on the original non-rt and select 'Mark for Complete Removal'.
350+
Reboot. This is to force the system to boot from the RT kernel.
351+
If you prefer to retain both kernels then the other kernels need not be deleted,
352+
but grub boot configuration changes will be needed beyond the scope of this document.
365353

366354
. Add the LinuxCNC Archive Signing Key to your apt keyring by running
367355
+
@@ -399,15 +387,13 @@ sudo apt install mesaflash
399387
=== Installing on Debian Buster (with experimental RTAI kernel)
400388

401389
[WARNING]
402-
This kernel has known stability problems. It appears to run
403-
reliably once LinuxCNC is loaded. However kernel panics have been seen
404-
at system shut-down.
390+
This kernel has known stability problems. It appears to run reliably once LinuxCNC is loaded.
391+
However, kernel panics have been seen at system shut-down.
405392

406-
. This kernel and LinuxCNC version can be installed on top of the LiveDVD
407-
install, or alternatively on a fresh Install of Debian Buster 64-bit
408-
as described above
409-
. Add the LinuxCNC Archive Signing Key to your apt keyring (Not
410-
necessary if switching the realtime mode of a LinuxCNC Live-CD image)
393+
. This kernel and LinuxCNC version can be installed on top of the LiveDVD install,
394+
or alternatively on a fresh Install of Debian Buster 64-bit as described above.
395+
. Add the LinuxCNC Archive Signing Key to your apt keyring
396+
(Not necessary if switching the realtime mode of a LinuxCNC Live-CD image).
411397
+
412398
----
413399
# Alternate keyserver: keyserver.ubuntu.com
@@ -450,9 +436,9 @@ Reboot the machine, ensuring that the system boots from the new 4.19.195-rtai ke
450436
=== Installing on Raspbian 10
451437

452438
. Download a stock Raspbian image to an SD card and install in the
453-
https://www.raspberrypi.org/documentation/installation/installing-images/README.md[usual way]
454-
. Boot the Pi and open a terminal
455-
. Add the LinuxCNC Archive Signing Key to your apt keyring
439+
https://www.raspberrypi.org/documentation/installation/installing-images/README.md[usual way].
440+
. Boot the Pi and open a terminal.
441+
. Add the LinuxCNC Archive Signing Key to your apt keyring.
456442
+
457443
----
458444
# Alternate keyserver: keyserver.ubuntu.com
@@ -485,15 +471,13 @@ sudo apt-get install linuxcnc-uspace
485471

486472
=== Installing on Ubuntu Precise
487473

488-
. Install Ubuntu Precise 12.04 x86 (32-bit). Any flavor should
489-
work (regular Ubuntu, Xubuntu, Lubuntu, etc). 64-bit (AMD64)
490-
is currently not supported. You can download the installer here:
474+
. Install Ubuntu Precise 12.04 x86 (32-bit). Any flavor should work (regular Ubuntu, Xubuntu, Lubuntu, etc).
475+
64-bit (AMD64) is currently not supported. You can download the installer here:
491476
http://releases.ubuntu.com/precise/
492-
Note the warnings that this release is out of support. But it is a way
493-
to install LinuxCNC with a well-tested RTAI kernel.
477+
Note the warnings that this release is out of support.
478+
But it is a way to install LinuxCNC with a well-tested RTAI kernel.
494479

495-
. Run the following to bring the machine up to date with the latest
496-
packages in Ubuntu Precise.
480+
. Run the following to bring the machine up to date with the latest packages in Ubuntu Precise.
497481
+
498482
----
499483
sudo apt-get update
@@ -525,8 +509,7 @@ sudo apt-get update
525509
sudo apt-get install linux-image-3.4-9-rtai-686-pae rtai-modules-3.4-9-rtai-686-pae
526510
----
527511

528-
. If you want to be able to build LinuxCNC from source using the git
529-
repo, also run
512+
. If you want to be able to build LinuxCNC from source using the git repo, also run
530513
+
531514
----
532515
sudo apt-get install linux-headers-3.4-9-rtai-686-pae

0 commit comments

Comments
 (0)