jepler/linuxcnc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: re-branding

Browse source 
Signed-off-by: John Thornton <jthornton@gnipsel.com>
This commit is contained in:
John Thornton 2012-01-18 15:11:14 -06:00
parent 267f506872
commit 19d124647d
10 changed files with 69 additions and 69 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/INSTALL
View file

@ -4,7 +4,7 @@ From the top level directory, switch to the source directory:
cd src
In the source directory, build EMC2:
In the source directory, build LinuxCNC:
./autogen.sh (this builds the configure script)
./configure --enable-run-in-place
@ -27,7 +27,7 @@ The runtime script is called emc, thus allowing you on an installed to just type
'emc' and get it running.
On a run-in-place system (e.g. the one you just got out of git),
the runscript is emc2/scripts/emc.
When you just checked out a fresh copy of emc2, you'll see there is no
When you just checked out a fresh copy of LinuxCNC, you'll see there is no
'scripts/emc', just a 'scripts/emc.in'.
By running configure that one will get changed to 'scripts/emc'. configure will
also replace some default values for your system (folders, paths, etc).
@ -69,10 +69,10 @@ Optional Features
=================
EMC is a software that can operate hardware only if a real time system has
been installed. Either RTLinux or RTAI. If you don't have any installed, you
cannot run EMC2 to control any machines. Please install one of the RT patches
cannot run LinuxCNC to control any machines. Please install one of the RT patches
(refer to the documentation of the project on how to achieve that).
However, it is possible to test EMC2 without a realtime system. This is
However, it is possible to test LinuxCNC without a realtime system. This is
possible using a simulator mode, which doesn't allow hardware control. To
enable this mode there is a special option '--enable-simulator' you can use.
@ -81,7 +81,7 @@ the correct one can be declared as a command line argument:
./configure --with-rtai=/usr/src/rtai-24.1.12
If you want only to try emc2 in a local directory (without installing it),
If you want only to try LinuxCNC in a local directory (without installing it),
there is an option to configure to run-in-place
--enable-run-in-place Enables running in the local dir
(without installing)

6
docs/README
View file

@ -7,9 +7,9 @@ The submakefile, docs.xml and index.tmpl must be updated to add a file to the do
docs.xml is used to create the "previous" and "next" buttons at the top of each individual html document.
it should generally match the order of the index.tmpl
Notes on EMC2 documentation:
Notes on LinuxCNC documentation:
----------------------------
The main EMC2 makefile can optionally build the documentation and
The main LinuxCNC makefile can optionally build the documentation and
other files in this directory tree. Use --enable-build-documentation when
invoking emc2/src/configure, and run make from emc2/src
@ -27,7 +27,7 @@ ubuntu package (and I believe also available for debian).
Unfortunately, EasyCad (and AutoCad) support a number of entities
that Qcad does not import properly. Including some that were used
in the EMC2 drawings: filled circles, filled arrowheads, non-zero
in the LinuxCNC drawings: filled circles, filled arrowheads, non-zero
width lines, and dashed lines. Qcad renders filled circles as
hollow, it renders all lines the same width, and it renders dashed
lines as solid, unless you tell it to do otherwise. All of these

4
docs/rtfaults.txt
View file

@ -1,7 +1,7 @@
Finding line number information for faults in realtime components
1. Get a version of emc which prints the faulting instruction address
(that includes this version of emc)
1. Get a version of LinuxCNC which prints the faulting instruction address
(that includes this version of LinuxCNC)
2. Include debugging info in your modules. For built-in modules,
below the definition of EXTRA_CFLAGS in Makefile, add

24
docs/src/code/Code_Notes.txt
View file

@ -2,15 +2,15 @@
== Intended audience
This document is a collection of notes about the internals of EMC2. It
This document is a collection of notes about the internals of LinuxCNC. It
is primarily of interest to developers, however much of the information
here may also be of interest to system integrators and others who are
simply curious about how EMC2 works. Much of this information is now
simply curious about how LinuxCNC works. Much of this information is now
outdated and has never been reviewed for accuracy.
== Organization
There will be a chapter for each of the major components of EMC2, as
There will be a chapter for each of the major components of LinuxCNC, as
well as chapter(s) covering how they work together. This document is
very much a work in progress, and its layout may change in the future.
@ -35,7 +35,7 @@ very much a work in progress, and its layout may change in the future.
* 'JOINT' - A joint is one of the movable parts of the machine. Joints are
distinct from axes, although the two terms are sometimes (mis)used to
mean the same thing. In EMC2, a joint is a physical thing that can be
mean the same thing. In LinuxCNC, a joint is a physical thing that can be
moved, not a coordinate in space. For example, the quill, knee, saddle,
and table of a Bridgeport mill are all joints. The shoulder, elbow, and
wrist of a robot arm are joints, as are the linear actuators of a
@ -52,12 +52,12 @@ very much a work in progress, and its layout may change in the future.
be described as joint data, such as input and output scaling, etc.
* 'POSE' - A pose is a fully specified position in 3-D Cartesian space. In the
EMC2 motion controller, when we refer to a pose we mean an EmcPose
LinuxCNC motion controller, when we refer to a pose we mean an EmcPose
structure, containing three linear coordinates and three angular ones.
== Architecture overview
There are four components contained in the EMC2 Architecture: a motion
There are four components contained in the LinuxCNC Architecture: a motion
controller (EMCMOT), a discrete IO controller (EMCIO), a task executor
which coordinates them (EMCTASK) and several text-mode and graphical
User Interfaces. Each of them will be described in the current
@ -670,10 +670,10 @@ nearly identical for every parameter.
libnml is derived from the NIST rcslib without all the multi-platform
support. Many of the wrappers around platform specific code has been
removed along with much of the code that is not required by EMC2. It is
removed along with much of the code that is not required by LinuxCNC. It is
hoped that sufficient compatibility remains with rcslib so that
applications can be implemented on non-Linux platforms and still be
able to communicate with EMC2.
able to communicate with LinuxCNC.
This chapter is not intended to be a definitive guide to using libnml
(or rcslib), instead, it will eventually provide an overview of each
@ -848,7 +848,7 @@ whilst PHANTOM is only really useful in the testing stage of an
application, likewise for FILEMEM. LOCMEM is of little use for a
multi-process application, and only offers limited performance
advantages over SHMEM. This leaves SHMEM as the only buffer type to use
with EMC2.
with LinuxCNC.
The neut option is only of use in a multi-processor system where
different (and incompatible) architectures are sharing a block of
@ -882,9 +882,9 @@ does not implement NML.
UDP protocols have fewer checks on data and allows a percentage of
packets to be dropped. TCP is more reliable, but is marginally slower.
If EMC2 is to be connected to a network, one would hope that it is
If LinuxCNC is to be connected to a network, one would hope that it is
local and behind a firewall. About the only reason to allow access to
EMC2 via the Internet would be for remote diagnostics - This can be
LinuxCNC via the Internet would be for remote diagnostics - This can be
achieved far more securely using other means, perhaps by a web
interface.
@ -978,7 +978,7 @@ therefor which buffer is to be used.
== Adding custom NML commands
EMC2 is pretty awesome, but some parts need some tweaking. As you know
LinuxCNC is pretty awesome, but some parts need some tweaking. As you know
communication is done through NML channels, the data sent through such
a channel is one of the classes defined in emc.hh (implemented in
emc.cc). If somebody needs a message type that doesn't exist, he should

2
docs/src/code/Style_Guide.txt
View file

@ -1,6 +1,6 @@
= Coding Style
This chapter describes the source code style preferred by the EMC team.
This chapter describes the source code style preferred by the LinuxCNC team.
== Do no harm

22
docs/src/common/Glossary.txt
View file

@ -20,8 +20,8 @@ Axis::
Axis(GUI)::
(((GUI))) One of the Graphical User Interfaces available to users of
EMC2. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional EMC2 controls. It is
LinuxCNC. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional LinuxCNC controls. It is
the only open-source interface that displays the entire tool path as
soon as a file is opened.
@ -65,7 +65,7 @@ CNC::
to move the tool, based on a part program.
Comp::
(((comp)))[[glo:comp]] A tool used to build, compile and install EMC2 HAL
(((comp)))[[glo:comp]] A tool used to build, compile and install LinuxCNC HAL
components.
Configuration(n)::
@ -76,7 +76,7 @@ Configuration(n)::
describe tools, parameters, and NML connections.
Configuration(v)::
The task of setting up EMC2 so that it matches the hardware on a
The task of setting up LinuxCNC so that it matches the hardware on a
machine tool.
Coordinate Measuring Machine::
@ -130,7 +130,7 @@ Encoder::
(((encoder)))[[glo:Encoder]] A device to measure position. Usually a
mechanical-optical device, which outputs a quadrature signal. The
signal can be counted by special hardware, or directly by the parport
with EMC2.
with LinuxCNC.
Feed::
(((feed)))[[glo:Feed]] Relatively slow, controlled motion of the tool used
@ -143,7 +143,7 @@ Feed rate::
Feedback::
(((feedback)))[[glo:Feedback]] A method (e.g., quadrature encoder signals)
by which EMC2 receives information about the position of motors
by which LinuxCNC receives information about the position of motors
Feedrate Override::
(((feedrate override)))[[glo:FeedrateOveride]] A manual, operator controlled
@ -263,7 +263,7 @@ Program Units::
measured in degrees.
Python::
General-purpose, very high-level programming language. Used in EMC2
General-purpose, very high-level programming language. Used in LinuxCNC
for the Axis GUI, the Stepconf configuration tool, and several G-code
programming scripts.
@ -327,13 +327,13 @@ Spindle Speed Override::
A manual, operator controlled change in the rate at which the tool
rotates while cutting. Often used to allow the operator to adjust for
chatter caused by the cutter's teeth. Spindle Speed Override assumes
that the EMC2 software has been configured to control spindle speed.
that the LinuxCNC software has been configured to control spindle speed.
Stepconf::
An EMC2 configuration wizard. It is able to handle many
An LinuxCNC configuration wizard. It is able to handle many
step-and-direction motion command based machines. It writes a full
configuration after the user answers a few questions about the computer
and machine that EMC2 is to run on.
and machine that LinuxCNC is to run on.
Stepper Motor::
(((stepper motor)))[[glo:StepperMotor]] A type of motor that turns in
@ -347,7 +347,7 @@ TASK::
Tcl/Tk::
(((Tk)))[[glo:Tcl/Tk]] A scripting language and graphical widget toolkit
with which several of EMC2s GUIs and selection wizards were
with which several of LinuxCNCs GUIs and selection wizards were
written.
Traverse Move::

22
docs/src/common/Glossary_de.txt
View file

@ -20,8 +20,8 @@ Axis::
Axis(GUI)::
(((GUI))) One of the Graphical User Interfaces available to users of
EMC2. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional EMC2 controls. It is
LinuxCNC. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional LinuxCNC controls. It is
the only open-source interface that displays the entire tool path as
soon as a file is opened.
@ -65,7 +65,7 @@ CNC::
to move the tool, based on a part program.
Comp::
(((comp)))[[glo:comp]] A tool used to build, compile and install EMC2 HAL
(((comp)))[[glo:comp]] A tool used to build, compile and install LinuxCNC HAL
components.
Configuration(n)::
@ -76,7 +76,7 @@ Configuration(n)::
describe tools, parameters, and NML connections.
Configuration(v)::
The task of setting up EMC2 so that it matches the hardware on a
The task of setting up LinuxCNC so that it matches the hardware on a
machine tool.
Coordinate Measuring Machine::
@ -130,7 +130,7 @@ Encoder::
(((encoder)))[[glo:Encoder]] A device to measure position. Usually a
mechanical-optical device, which outputs a quadrature signal. The
signal can be counted by special hardware, or directly by the parport
with EMC2.
with LinuxCNC.
Feed::
(((feed)))[[glo:Feed]] Relatively slow, controlled motion of the tool used
@ -143,7 +143,7 @@ Feed rate::
Feedback::
(((feedback)))[[glo:Feedback]] A method (e.g., quadrature encoder signals)
by which EMC2 receives information about the position of motors
by which LinuxCNC receives information about the position of motors
Feedrate Override::
(((feedrate override)))[[glo:FeedrateOveride]] A manual, operator controlled
@ -263,7 +263,7 @@ Program Units::
measured in degrees.
Python::
General-purpose, very high-level programming language. Used in EMC2
General-purpose, very high-level programming language. Used in LinuxCNC
for the Axis GUI, the Stepconf configuration tool, and several G-code
programming scripts.
@ -327,13 +327,13 @@ Spindle Speed Override::
A manual, operator controlled change in the rate at which the tool
rotates while cutting. Often used to allow the operator to adjust for
chatter caused by the cutter's teeth. Spindle Speed Override assumes
that the EMC2 software has been configured to control spindle speed.
that the LinuxCNC software has been configured to control spindle speed.
Stepconf::
An EMC2 configuration wizard. It is able to handle many
An LinuxCNC configuration wizard. It is able to handle many
step-and-direction motion command based machines. It writes a full
configuration after the user answers a few questions about the computer
and machine that EMC2 is to run on.
and machine that LinuxCNC is to run on.
Stepper Motor::
(((stepper motor)))[[glo:StepperMotor]] A type of motor that turns in
@ -347,7 +347,7 @@ TASK::
Tcl/Tk::
(((Tk)))[[glo:Tcl/Tk]] A scripting language and graphical widget toolkit
with which several of EMC2s GUIs and selection wizards were
with which several of LinuxCNCs GUIs and selection wizards were
written.
Traverse Move::

22
docs/src/common/Glossary_es.txt
View file

@ -20,8 +20,8 @@ Axis::
Axis(GUI)::
(((GUI))) One of the Graphical User Interfaces available to users of
EMC2. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional EMC2 controls. It is
LinuxCNC. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional LinuxCNC controls. It is
the only open-source interface that displays the entire tool path as
soon as a file is opened.
@ -65,7 +65,7 @@ CNC::
to move the tool, based on a part program.
Comp::
(((comp)))[[glo:comp]] A tool used to build, compile and install EMC2 HAL
(((comp)))[[glo:comp]] A tool used to build, compile and install LinuxCNC HAL
components.
Configuration(n)::
@ -76,7 +76,7 @@ Configuration(n)::
describe tools, parameters, and NML connections.
Configuration(v)::
The task of setting up EMC2 so that it matches the hardware on a
The task of setting up LinuxCNC so that it matches the hardware on a
machine tool.
Coordinate Measuring Machine::
@ -130,7 +130,7 @@ Encoder::
(((encoder)))[[glo:Encoder]] A device to measure position. Usually a
mechanical-optical device, which outputs a quadrature signal. The
signal can be counted by special hardware, or directly by the parport
with EMC2.
with LinuxCNC.
Feed::
(((feed)))[[glo:Feed]] Relatively slow, controlled motion of the tool used
@ -143,7 +143,7 @@ Feed rate::
Feedback::
(((feedback)))[[glo:Feedback]] A method (e.g., quadrature encoder signals)
by which EMC2 receives information about the position of motors
by which LinuxCNC receives information about the position of motors
Feedrate Override::
(((feedrate override)))[[glo:FeedrateOveride]] A manual, operator controlled
@ -263,7 +263,7 @@ Program Units::
measured in degrees.
Python::
General-purpose, very high-level programming language. Used in EMC2
General-purpose, very high-level programming language. Used in LinuxCNC
for the Axis GUI, the Stepconf configuration tool, and several G-code
programming scripts.
@ -327,13 +327,13 @@ Spindle Speed Override::
A manual, operator controlled change in the rate at which the tool
rotates while cutting. Often used to allow the operator to adjust for
chatter caused by the cutter's teeth. Spindle Speed Override assumes
that the EMC2 software has been configured to control spindle speed.
that the LinuxCNC software has been configured to control spindle speed.
Stepconf::
An EMC2 configuration wizard. It is able to handle many
An LinuxCNC configuration wizard. It is able to handle many
step-and-direction motion command based machines. It writes a full
configuration after the user answers a few questions about the computer
and machine that EMC2 is to run on.
and machine that LinuxCNC is to run on.
Stepper Motor::
(((stepper motor)))[[glo:StepperMotor]] A type of motor that turns in
@ -347,7 +347,7 @@ TASK::
Tcl/Tk::
(((Tk)))[[glo:Tcl/Tk]] A scripting language and graphical widget toolkit
with which several of EMC2s GUIs and selection wizards were
with which several of LinuxCNCs GUIs and selection wizards were
written.
Traverse Move::

22
docs/src/common/Glossary_pl.txt
View file

@ -20,8 +20,8 @@ Axis::
Axis(GUI)::
(((GUI))) One of the Graphical User Interfaces available to users of
EMC2. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional EMC2 controls. It is
LinuxCNC. It features the modern use of menus and mouse buttons while
automating and hiding some of the more traditional LinuxCNC controls. It is
the only open-source interface that displays the entire tool path as
soon as a file is opened.
@ -65,7 +65,7 @@ CNC::
to move the tool, based on a part program.
Comp::
(((comp)))[[glo:comp]] A tool used to build, compile and install EMC2 HAL
(((comp)))[[glo:comp]] A tool used to build, compile and install LinuxCNC HAL
components.
Configuration(n)::
@ -76,7 +76,7 @@ Configuration(n)::
describe tools, parameters, and NML connections.
Configuration(v)::
The task of setting up EMC2 so that it matches the hardware on a
The task of setting up LinuxCNC so that it matches the hardware on a
machine tool.
Coordinate Measuring Machine::
@ -130,7 +130,7 @@ Encoder::
(((encoder)))[[glo:Encoder]] A device to measure position. Usually a
mechanical-optical device, which outputs a quadrature signal. The
signal can be counted by special hardware, or directly by the parport
with EMC2.
with LinuxCNC.
Feed::
(((feed)))[[glo:Feed]] Relatively slow, controlled motion of the tool used
@ -143,7 +143,7 @@ Feed rate::
Feedback::
(((feedback)))[[glo:Feedback]] A method (e.g., quadrature encoder signals)
by which EMC2 receives information about the position of motors
by which LinuxCNC receives information about the position of motors
Feedrate Override::
(((feedrate override)))[[glo:FeedrateOveride]] A manual, operator controlled
@ -263,7 +263,7 @@ Program Units::
measured in degrees.
Python::
General-purpose, very high-level programming language. Used in EMC2
General-purpose, very high-level programming language. Used in LinuxCNC
for the Axis GUI, the Stepconf configuration tool, and several G-code
programming scripts.
@ -327,13 +327,13 @@ Spindle Speed Override::
A manual, operator controlled change in the rate at which the tool
rotates while cutting. Often used to allow the operator to adjust for
chatter caused by the cutter's teeth. Spindle Speed Override assumes
that the EMC2 software has been configured to control spindle speed.
that the LinuxCNC software has been configured to control spindle speed.
Stepconf::
An EMC2 configuration wizard. It is able to handle many
An LinuxCNC configuration wizard. It is able to handle many
step-and-direction motion command based machines. It writes a full
configuration after the user answers a few questions about the computer
and machine that EMC2 is to run on.
and machine that LinuxCNC is to run on.
Stepper Motor::
(((stepper motor)))[[glo:StepperMotor]] A type of motor that turns in
@ -347,7 +347,7 @@ TASK::
Tcl/Tk::
(((Tk)))[[glo:Tcl/Tk]] A scripting language and graphical widget toolkit
with which several of EMC2s GUIs and selection wizards were
with which several of LinuxCNCs GUIs and selection wizards were
written.
Traverse Move::

4
docs/src/common/emc-history.txt
View file

@ -1,6 +1,6 @@
= EMC History
= LinuxCNC History
[[cha:emc-history]] (((EMC History)))
[[cha:linuxcnc-history]] (((LinuxCNC History)))
EMC (the Enhanced Machine Controller) was created by
http://www.nist.gov/index.html/[NIST] , the National Institute of Standards