John Thornton
9dd801e290
Docs: fix typo, remove extra ] that made the formatting fail
...
Signed-off-by: John Thornton <bjt128@gmail.com>
2018-06-25 16:16:27 -05:00
Sebastian Kuzminsky
3f05545ef1
docs: pwmgen has all pins now, no params
...
Also update comments in pwmgen.c to reflect that HAL connections are
all via pins instead of params. No code changes.
2018-06-19 11:38:14 -06:00
Sebastian Kuzminsky
c2b378391e
docs: improve motion.requested-vel description
2018-06-12 20:06:25 -06:00
Sebastian Kuzminsky
310bbbf52e
docs: describe motion.program-line in motion manpage
2018-04-03 11:09:36 -06:00
Sebastian Kuzminsky
ade72db610
docs: add missing num_sserials info to hm2 manpage
2018-02-22 08:41:18 -07:00
Sebastian Kuzminsky
40ea6d31b7
docs: add missing .tool-prep-index parameter to io manpage
2018-02-21 17:38:10 -07:00
Sebastian Kuzminsky
359c417f93
fix paramater/parameter typos
2018-01-21 14:49:15 -07:00
Sebastian Kuzminsky
d297f0a622
fix infomation/information typo in mb2hal manpage
2018-01-21 14:49:15 -07:00
Sebastian Kuzminsky
0fded4f9ac
fix returnd/returned typo in linuxcncrsh manpage
2018-01-21 14:49:15 -07:00
Sebastian Kuzminsky
bdbc42e113
fix interpeter/interpreter typos
2018-01-21 14:49:15 -07:00
Sebastian Kuzminsky
4432321fa6
fix formated/formatted typos all over
2018-01-21 14:49:15 -07:00
Sebastian Kuzminsky
3241f6dbf1
fix specifed/specified typos all over
2018-01-21 14:49:14 -07:00
Sebastian Kuzminsky
2e02f5c785
fix intial/initial typos all over
2018-01-21 14:49:14 -07:00
Sebastian Kuzminsky
22fafd6198
fix paramter/parameter typos all over
2018-01-21 14:49:13 -07:00
Sebastian Kuzminsky
986e9c194e
docs: remove obsolete bug warning in rtapi_region manpage
2018-01-21 14:49:13 -07:00
Sebastian Kuzminsky
c69df759b3
docs: fix GPL name in rtapi_module_param manpage
2018-01-21 14:49:13 -07:00
Sebastian Kuzminsky
2506277876
fix usefull/useful typos all over
2018-01-21 14:49:12 -07:00
Sebastian Kuzminsky
fec7bf9a69
fix preceede/precede/proceed typos all over
2018-01-21 14:49:12 -07:00
Sebastian Kuzminsky
4a897203bc
docs: fix hyphen/minus confusion in manpages
...
groff treats '-' (the character you get when you hit the "minus" key on
the keyboard) as "hyphen", not as "minus". Thus it renders incorrectly
in some locales, and line-wraps strangely.
groff treats the two-character sequence "\-" as "minus", and the
four-character sequence "\(hy" as "hyphen".
Details here: https://lists.debian.org/debian-devel/2003/03/msg01481.html
This commit replaces every instance of "-" in our manpages where the
meaning is "minus" with "\-", so it works right.
This fixes many lintian warnings.
2018-01-18 08:12:31 -07:00
Sebastian Kuzminsky
714d85657b
mux_generic: fix a typo in the manpage
2017-12-11 11:32:02 -07:00
Sebastian Kuzminsky
de97fdd108
docs: improve .motion-type pin info in motion manpage
2017-12-05 22:19:58 -07:00
andy pugh
66a518e1f8
hostmot2:dpll: Fix a problem ( #211 ) where a positive offset in the odd timers
...
masked any use of the even timers.
Signed-off-by: andy pugh <andy@bodgesoc.org>
2017-10-18 22:32:42 +01:00
Dewey Garrett
51a8862018
milltask manpage expansion
2017-08-23 11:31:02 -07:00
Sebastian Kuzminsky
724f2c395d
docs: remove mention of ancient "bfloat" program from hm2_7i43 manpage
2017-08-23 09:40:05 -06:00
Dewey Garrett
ce6289c802
sim_pin: improve help for signals with no writers
2017-08-14 10:51:41 -07:00
Sebastian Kuzminsky
09fc042cab
Merge remote-tracking branch 'origin/2.7-hy-vfd-base-freq' into 2.7
2017-07-07 12:58:20 -06:00
Sebastian Kuzminsky
67490eca8f
hm2_eth: add support for Mesa 7i93 AnyIO ethernet board
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-06-18 10:59:03 -06:00
Jeff Epler
996d682947
docs: improve some hm2_bspi manpages
...
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2017-06-17 21:16:05 -05:00
Sebastian Kuzminsky
4e66ee1cd2
hy_vfd: add --motor-poles, to set PD143
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-06-16 13:56:48 -06:00
Sebastian Kuzminsky
0870733ae4
hy_vfd: document PD004/base-freq better in the manpage
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-06-16 13:56:48 -06:00
Sebastian Kuzminsky
26791f8d91
hy_vfd: add --base-frequency to set PD004 on the VFD
...
This register can be set from the face plate, but it's useful to be able
to set it from the command-line too.
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-06-16 12:12:28 -06:00
Sebastian Kuzminsky
40629a0360
add a driver for the Huanyang GT series VFD
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-06-13 23:26:27 -06:00
Sebastian Kuzminsky
4cacd7c4c2
docs: sort board list in hm2_eth manpage
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-27 21:38:08 -06:00
Sebastian Kuzminsky
ddfce26b74
hal_pin_new(3): clarify return value
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-22 09:11:09 -06:00
Joe Hildreth
fa0c172119
Add manpage for hal_parport realtime component.
...
Signed-off-by: Joe Hildreth <joeh@threerivershospital.com>
2017-04-12 21:07:46 -05:00
Sebastian Kuzminsky
a1f1aa42bf
docs: add units info to halui max-velocity pins in manpage
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-10 12:25:59 -06:00
Sebastian Kuzminsky
7183394aa0
docs: flesh out max-velocity pins in halui manpage
...
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-10 11:40:28 -06:00
Joe Hildreth
f70887545b
Update description of hal_manualtoolchange manpage
...
Signed-off-by: Joe Hildreth <joeh@threerivershospital.com>
2017-04-07 20:22:18 -05:00
Joe Hildreth
3b6c6bacdc
Add hal_manualtoolchange manpage.
...
Signed-off-by: Joe Hildreth <joeh@threerivershospital.com>
2017-04-05 21:29:41 -05: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
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
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
John Thornton
1489c87181
Docs: fix issue #143
...
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-08-16 11:09:36 -05:00
Jeff Epler
f581faef25
hm2_eth: doc updates
...
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:03 -05:00
Jeff Epler
52febb5f38
hm2_eth: improve docs
...
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:03 -05:00
Jeff Epler
ce80671f13
hm2_eth: detect lost reads and writes
...
.. with a pile of new tunables (yuck)
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:02 -05:00
Sebastian Kuzminsky
01e4bb6889
Merge remote-tracking branch 'origin/2.6' into 2.7
2016-06-08 11:19:03 -06:00
Sebastian Kuzminsky
7c21c70238
shuttlexpress: clean up the manpage & asciidocs
...
This fixes some wording problems, simplifies the flow of the text,
and updates the asciidoc documentation to be up-to-date with the manpage.
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2016-06-08 11:17:20 -06:00
Jeff Epler
01e82b2989
motion: remove overruns parameter
...
After the removal of heuristic overrun detection, this param's value
was never changed from 0.
As noted clearly in the documentation, this parameter was for debugging
and subject to removal at any time, so we don't need to wait to remove
it.
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-05-10 12:52:43 -05:00
Sam Sokolik
6ceba7a9bb
irq-coalesce requires ethtools
...
Signed-off-by: Sam Sokolik <samcoinc@gmail.com>
2016-05-10 10:53:05 -06:00