Commit graph

4334 commits

Author SHA1 Message Date
Sebastian Kuzminsky
d5647b581a docs: remove a footnote about the behavior of emc2 v2.4
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-03-02 22:48:21 -07:00
chris morley
d4ea4749dd mitsub_vfd -add docs for the VFD driver
Signed-off-by: chris morley <chrisinnanaimo@hotmail.com>
2017-02-18 00:38:05 -08:00
Jeff Epler
82660317e6 Revert "Docs: add info about multi-line comments and add info for the --install option"
This reverts commit d82230b167.

Requested via IRC after discussion of what triple-quoted strings
mean in halcompile.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2017-02-14 07:07:43 -06:00
John Thornton
d82230b167 Docs: add info about multi-line comments and add info for the --install option
Signed-off-by: John Thornton <bjt128@gmail.com>
2017-02-14 07:01:38 -06:00
John Thornton
5e827af588 Docs: fix markup
Signed-off-by: John Thornton <bjt128@gmail.com>
2017-01-09 06:31:34 -06:00
John Thornton
1bae692336 Docs: add or2 example
Signed-off-by: John Thornton <bjt128@gmail.com>
2017-01-09 05:01:09 -06:00
Dewey Garrett
e94efeb12a ini-config.txt: USER_DEFINED_FUNCTION_MAX_DIRS
clarify that it is a compile-time item
not an ini [RS274NGC] setting

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2017-01-01 19:52:31 -07:00
John Thornton
1aa0dba552 Docs: clarify g28/30 description
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-12-26 13:33:07 -06:00
John Thornton
82cb639271 Docs: add link
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-12-26 13:32:26 -06:00
John Thornton
2040cb1dd4 Docs: remove g code description and add link to g code
g code descriptions should be only in one place gcode.txt

Signed-off-by: John Thornton <bjt128@gmail.com>
2016-12-26 13:32:02 -06:00
John Thornton
4fc1bd6aaa Docs: remove m6 from modal group description
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-12-26 13:30:45 -06:00
John Thornton
fa35ae024d Docs: add link to machine origin
this may be a term that does not make sense to everyone

Signed-off-by: John Thornton <bjt128@gmail.com>
2016-12-26 13:29:32 -06:00
John Thornton
a380981975 Docs: fix a typo
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-12-16 09:28:25 -06:00
John Thornton
b706123a22 Docs: add more information to the addf command
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-12-16 09:27:15 -06:00
Norbert Schechner
090a9d0df2 Merge branch '2.6' into 2.7
Conflicts:
	docs/src/gui/gmoccapy.txt

Signed-off-by: Norbert Schechner <nieson@web.de>
2016-12-13 21:21:59 +01:00
Norbert Schechner
904c31200a Merge branch '2.7' of ssh://norbert@git.linuxcnc.org/git/linuxcnc.git into 2.7 2016-12-13 21:19:48 +01:00
Norbert Schechner
ae7a6e93e3 docs - gmoccapy - sorted video links with headlines
Signed-off-by: Norbert Schechner <nieson@web.de>
2016-12-13 21:19:05 +01:00
Norbert Schechner
7c1f1affb4 docs - gmoccapy - added a known problem with macros
Signed-off-by: Norbert Schechner <nieson@web.de>
2016-12-13 21:01:29 +01:00
Sebastian Kuzminsky
f4c9802365 docs: fix cut-n-paste bug in mb2hal manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-12-11 14:24:05 -07:00
John Thornton
8a172f63ec Docs: some corrections thanks to dewey
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-11-12 07:02:57 -06:00
John Thornton
97d3c5dc52 Docs: fix spelling error
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-11-12 07:02:57 -06:00
Dewey Garrett
f93a447cd4 Docs axis gui: document two unmentioned items
[DISPLAY]USER_COMMAND_FILE
user_live_update()

use backticks to render ~/.axisrc literally
"Word phrases `enclosed in backtick characters` (grave accents) are also
rendered in a monospaced font but in this case the enclosed text is
rendered literally and is not subject to further expansion"

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-11-11 10:22:30 -07:00
John Thornton
9708593fc1 Docs: add info about the basic directory structure
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-11-10 13:16:43 -06:00
John Thornton
c28692e5c4 Docs: correct misleading descriptions
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-11-10 07:52:21 -06:00
Dewey Garrett
3c9b549eae halcmd manpage & help: update for 'save' command
updates some undocumented details

manpage:
1) add info for 'save' command for the "alias" type
2) note that 'save all' includes the "alias" type
3) list all types available for the 'save' command
   (some are redundant)
3) note equivalence of 'save' types:
     sig   signal
     param parameter
     netla netal

help save text:
1) include "alias"
2) list all available save types
2) refer to man page for details

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2016-11-09 13:57:50 -07:00
John Thornton
5524071e26 Docs: remove apostrophe from section title.
punctuation in a title causes weird links

Signed-off-by: John Thornton <bjt128@gmail.com>
2016-11-09 07:17:45 -06:00
John Thornton
d0b5fd91a1 Docs: fix pdf duplicate history listing
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-11-06 06:04:09 -06:00
Sebastian Kuzminsky
808a8b0d30 docs: use out-of-date French translation of Updating LinuxCNC
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-30 11:24:46 -06:00
tseufl
80f2999620 docs 2.7: index_es.tmpl 8 broken links fixed
Signed-off-by: Thoren Seufl <t_seufl@gmx.de>
(cherry picked from commit 94b6caa54e2f77a48811ee733e60c5724d280f5a)
2016-10-30 11:15:18 -06:00
tseufl
5109cedc01 docs 2.7: index_fr.tmpl 4 links fixed / 2 deleted
Signed-off-by: Thoren Seufl <t_seufl@gmx.de>
(cherry picked from commit 9a91e45d5c06b220ffdd65b89c745a2334a44000)
2016-10-30 11:15:18 -06:00
Norbert Schechner
c0af9a9a98 GladeVCP - CombiDRO - new property cycle time
with 6 axis machine and not very fast PC the CombiDRO slowed down the main
application too much. Now we can set the poll time for each DRO separately.
At the same time i reduced the hard coded cycle time form 100 to 150.

Signed-off-by: Norbert Schechner <nieson@web.de>
2016-10-30 11:57:11 +01:00
Norbert Schechner
153a66ecb4 Merge branch '2.7' of ssh://norbert@git.linuxcnc.org/git/linuxcnc.git into 2.7 2016-10-28 18:27:47 +02:00
Norbert Schechner
65ebb59098 documentation - INI File settings added some gmoccapy stuff
Signed-off-by: Norbert Schechner <nieson@web.de>
2016-10-28 18:27:07 +02:00
Sebastian Kuzminsky
0076e5654c docs: punctuation fixes in Updating LinuxCNC
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-28 10:17:21 -06:00
John Thornton
f923072361 Docs: fix cut and paste error
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-10-26 09:56:38 -05:00
John Thornton
4c714f9c6d Docs: add more info about program extensions
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-10-26 08:34:18 -05:00
Sebastian Kuzminsky
6a3be13ae9 docs: fix asciidoc markup
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-23 10:46:04 -05:00
Sebastian Kuzminsky
9fff492225 docs: add links to both NIST papers
Link both to the originals on the NIST site, and to the copies I just
put in www.linuxcnc.org/files.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-20 15:57:46 -05:00
Sebastian Kuzminsky
cc3ac7ec1b docs: clarify feed rate info
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-19 20:29:25 -05:00
John Thornton
7377360085 Docs: update g61 for the new trajectory planner
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-10-19 16:17:39 -05:00
Sebastian Kuzminsky
cddff7518b docs: work around a pile of asciidoc wrinkles
In asciidoc:

    * A [[BlockId]] normally applies to the immediately following part
      of the document.

    * An (((IndexTerm))) is used in the docbook backend, but not in the
      html or pdf backends that we use.

Before this commit, the leading [[cha:basic-hal-reference]] applied to
the (((Basic HAL Reference))).

However, a bug or wrinkle in asciidoc made the (((indexterm))) mess up
the html backend, and the cleanest fix seems to be to just remove it
(since it doesn't do anything useful for us).

However, another wrinkle/bug in asciidoc means that a [[BlockId]] before
the document title gets applied not to the title header but to the part
of the document *following* the title.

In this particular document, the document title is followed immediately
by a second-level header with its own [[BlockId]], so the first BlockID
gets lost.  That's not ok, because other files in our docs link to both
the top-level BlockID and the second-level BlockID.

So this commit adds a decoy document element for the top-level BlockID
to apply to.  I am not proud.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 20:53:13 -06:00
Sebastian Kuzminsky
2f0d47b4dc docs: remove unused (((indexterm))) that break html
In asciidoc, (((IndexTerm))) is used in the docbook backend, but not
in the html or pdf backends that we use.  A bug in asciidoc results in
messed-up html when (((indexterm))) is used, empty <title>.

Since we don't use docbook, (((indexterm))) does nothing useful for us,
so it seems simplest to just remove it.

Thanks to tseufl for figuring this one out.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 20:53:13 -06:00
Sebastian Kuzminsky
dd0755d2f8 docs build system: accept id tags in more elements
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 20:53:12 -06:00
Sebastian Kuzminsky
7cc2253de9 docs: remove byte-order-mark from linux-faq-es.txt
It's not useful on utf-8 encoded files, and can cause problems on older
editors & browsers.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 20:53:12 -06:00
Sebastian Kuzminsky
d6e1fe4824 docs build system: add missing dependency
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 20:27:28 -06:00
Sebastian Kuzminsky
391ba0c17f docs build system: remove obsolete makefile rules
xref.py was removed in 2011, don't try to call it.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 20:27:28 -06:00
Sebastian Kuzminsky
270fc7f11e docs: fix g-code.html title finally
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 20:27:28 -06:00
Sebastian Kuzminsky
c25d34c447 docs: fixup asciidoc markup again
This anchor is not used, so just remove it.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-08 11:07:27 -06:00
Sebastian Kuzminsky
ebc38ef480 docs: fix gcode asciidoc markup
Before this commit, the g-code.html document lacks a document <title>.
Looks like asciidoc needs the document title on the first line of the
txt input.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-10-06 10:20:59 -06:00
Moses McKnight
98d06f0c3e elbpcom manpage fix: default address is 192.168.1.121
Signed-off-by: Moses McKnight <moses@texband.net>
2016-09-28 13:07:56 -05:00