Commit graph

42 commits

Author SHA1 Message Date
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
Sebastian Kuzminsky
ffb3a15043 halcmd: manage prompt better
Only display a prompt if run in interactive mode, ie if the input is
a terminal.  As always, the prompt is "halcmd: " in normal mode and "%"
in script mode.

If the input is not a terminal, do not display a prompt.  This is new
behavior, prompted (heh) by ugly output (lots of "%" lines") from stepconf
running halcmd.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-01-28 18:10:25 -07:00
Sebastian Kuzminsky
e03f459ec8 use easier-to-type bugtracker URL in some manpages 2014-07-29 10:18:27 -06:00
Michael Haberler
7f4d56b01c halcmd: update man page on link/unlink semantic change 2014-03-27 17:51:18 +01:00
Sebastian Kuzminsky
fb4969630b docs: fix a typo in the halcmd manpage 2013-05-17 09:42:39 -04:00
Jeff Epler
e3a7438be5 Merge remote branch 'origin/v2.5_branch'
Conflicts:
	docs/man/man1/halcmd.1
2013-04-22 09:27:49 -05:00
Sebastian Kuzminsky
48fcae18d8 docs: clarify usage of -I for halrun 2013-04-18 13:46:42 -06:00
Sebastian Kuzminsky
8cb7ccbe6d docs: rebranding 2013-04-18 13:43:03 -06:00
Dewey Garrett
72cb5b818f halcmd.1 manpage update
flag obsolete commands
add some info for unmentioned commands
    alias, unalias, list, lock, unlock, status, help
2012-02-01 21:09:03 -06:00
Dewey Garrett
f10b9312aa halcmd,halrun man pages
Make an independent man page for halrun, update halcmd.1
2012-02-01 21:09:03 -06:00
John Thornton
fa2918115b Docs: re-branding
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2012-01-26 07:42:29 -06:00
Jeff Epler
f34124af79 manpages: say "LinuxCNC" 2012-01-19 18:31:23 -06:00
Jeff Epler
51fc09fd2d Rename many user visible parts to "linuxcnc"
this includes the main script, some of the GUIs, the Python module,
the Tcl package, some image fies.

On a sim system, axis, tkemc, xemc all start.  runtests pass.

a system with realtime wasn't yet tested.

packaging probably requires additional changes and was not yet tested.
2012-01-18 11:25:09 -06:00
Jeff Epler
485835bee5 Document environment and ini variable subsitution 2007-04-30 19:56:19 +00:00
Jeff Epler
440c075880 document new commands 'ptype' and 'stype' 2007-03-24 23:59:51 +00:00
Jeff Epler
55e2a44bff document getp, gets 2007-03-13 22:21:13 +00:00
Chris Radek
a2c4e56ba8 typo 2007-03-06 15:00:06 +00:00
John Kasunich
99785aedc7 mark linkpp as obsolete 2007-03-05 22:57:44 +00:00
Jeff Epler
9fd1faefa3 document new hal command 2007-02-20 21:06:01 +00:00
Jeff Epler
d7b5cf6128 add -U (unload realtime system) to halrun 2007-02-20 21:03:05 +00:00
John Kasunich
d31d526636 added 'waitusr' command, handy for standalone HAL applications using pyvcp as the user interface - backport candidate 2007-01-20 07:28:43 +00:00
Jeff Epler
16dc082abd document that commandline completion may be available
document that "=" can be used to set pin values
2007-01-06 03:10:49 +00:00
Jeff Epler
f5f2657e10 remove x8 and x16 types from newsig 2007-01-06 03:03:45 +00:00
Jeff Epler
97918f2b29 add 'net' command to halcmd, used by default in 'save'. update 'save.0'
testcase accordingly.
2006-12-27 19:38:27 +00:00
Jeff Epler
2e423d7165 remove mention of HAL_RTMOD_DIR which is no longer used. Slightly explain rtapi_app. Ask that bugs be reported on sourceforge, not directly to jmk 2006-12-27 13:56:44 +00:00
Jeff Epler
b991dcc2b3 document halrun in a manpage 2006-10-21 13:39:47 +00:00
Jeff Epler
decc0dddb6 markup fix 2006-10-09 13:33:37 +00:00
Jeff Epler
9b891c44eb document loadusr and its flags 2006-10-08 03:06:49 +00:00
Jeff Epler
905e1fa7eb update setp documentation. remove warning about using '=' syntax from shell 2006-09-22 02:18:59 +00:00
Jeff Epler
94c0c5006b document unloadusr and unload 2006-09-18 13:27:23 +00:00
Chris Radek
7f05718026 document the new way loadrt/unloadrt work, which allows the removal of
a paragraph from the BUGS section
2006-02-19 05:48:46 +00:00
Ray Henry
e0ba14d09b Added EMC to title to clarify withLinux HAL 2006-02-18 19:47:53 +00:00
Stephen Wille Padnos
b4d2c2ef10 Added default "show all" description. Added "all" to show description 2006-01-19 19:20:32 +00:00
John Kasunich
880fce549a Added 'save comp' command, which generates a 'loadrt' line for each loaded RT component. It also preserves the arguments that were passed to insmod when the component was loaded (only if it was originally loaded with 'loadrt'). 2006-01-08 19:33:48 +00:00
Stephen Wille Padnos
ae71471dea Added description of -s option description to manpage. Left out -R, so it's somewhat secret. 2005-12-07 21:01:17 +00:00
Stephen Wille Padnos
3c856dda83 added command specific help to -h command line option 2005-11-13 00:55:14 +00:00
Alex Joni
76a963fbed added info for linkpp, thanks to fenn & swp 2005-11-12 16:05:46 +00:00
Paul Corner
d21500c65e Repair the damage to the gif & pdf files - Note: Unwise to run dos2unix on these files cd /tmp/emc2.. 2005-05-23 01:10:42 +00:00
Paul Corner
b30ec7c872 Remove any last trace of those M$ line terminators 2005-05-23 00:29:01 +00:00
John Kasunich
ae08bdcea0 updated halcmd man page to reflect changes made over the last few months 2004-12-07 04:55:19 +00:00
Paul Corner
c8b3ea88db Typo correction 2003-12-19 23:33:28 +00:00
John Kasunich
943b71d4c2 added man page for halcmd command line utility 2003-12-19 23:17:51 +00:00