summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/.cvsignore1
-rw-r--r--Doc/.distfiles1
-rw-r--r--Doc/Makefile.in38
-rw-r--r--Doc/Zsh/contrib.yo6
-rw-r--r--Doc/Zsh/zle.yo11
-rw-r--r--Doc/help/.cvsignore1
-rw-r--r--Doc/help/.distfiles5
7 files changed, 55 insertions, 8 deletions
diff --git a/Doc/.cvsignore b/Doc/.cvsignore
index 0ef3b52f5..606228be7 100644
--- a/Doc/.cvsignore
+++ b/Doc/.cvsignore
@@ -1,4 +1,5 @@
Makefile
+help.txt
version.yo
zsh*.1
zsh.texi
diff --git a/Doc/.distfiles b/Doc/.distfiles
index 85dc15781..6c2b2119f 100644
--- a/Doc/.distfiles
+++ b/Doc/.distfiles
@@ -11,6 +11,7 @@ DISTFILES_SRC='
zshcompctl.1 zshcompsys.1 zshcompwid.1 zshexpn.1
zshmisc.1 zshmodules.1 zshoptions.1 zshparam.1 zshroadmap.1
zshzle.1 zshall.1 zshzftpsys.1 zshcontrib.1 zshtcpsys.1
+ help.txt
'
DISTFILES_DOC='
diff --git a/Doc/Makefile.in b/Doc/Makefile.in
index dacbd5170..50e210fcf 100644
--- a/Doc/Makefile.in
+++ b/Doc/Makefile.in
@@ -34,6 +34,7 @@ VPATH = @srcdir@
sdir = @srcdir@
sdir_top = @top_srcdir@
INSTALL = @INSTALL@
+LN_S = @LN_S@
@DEFS_MK@
@@ -82,7 +83,7 @@ Zsh/seealso.yo Zsh/tcpsys.yo Zsh/zftpsys.yo Zsh/zle.yo
# ========== DEPENDENCIES FOR BUILDING ==========
-all: man texi ../META-FAQ
+all: man $(runhelp) texi ../META-FAQ
.PHONY: all
everything: all dvi html pdf info
@@ -183,6 +184,15 @@ $(sdir)/zsh.texi: $(YODLSRC)
man: $(MAN)
.PHONY: man
+runhelp: help.txt
+.PHONY: runhelp
+
+help.txt: zshbuiltins.1
+ @-rm -f $(sdir)/help.txt $(sdir)/help/*
+ perl $(sdir_top)/Util/helpfiles \
+ $(sdir)/zshbuiltins.1 $(sdir)/help $(sdir)/help.txt \
+ || { rm -f $(sdir)/help.txt $(sdir)/help/*; false; }
+
$(MAN): zmacros.yo zman.yo
zsh.1 zshall.1: Zsh/intro.yo Zsh/metafaq.yo Zsh/invoke.yo Zsh/files.yo \
@@ -285,12 +295,12 @@ Zsh/manmodmenu.yo: $(MODDOCSRC)
# ========== DEPENDENCIES FOR INSTALLING ==========
-# install just installs the manual pages
-install: install.man
+# install just installs the manual and runhelp pages
+install: install.man install.runhelp
.PHONY: install
-# uninstall just unistalls the manual pages
-uninstall: uninstall.man
+# uninstall just uninstalls the manual and runhelp pages
+uninstall: uninstall.man uninstall.runhelp
.PHONY: uninstall
# install man pages, creating install directory if necessary
@@ -302,6 +312,18 @@ install.man: man
done
.PHONY: install.man
+# install runhelp pages, creating install directory if necessary
+install.runhelp: $(runhelp)
+ if test x"$(runhelpdir)" != x""; then \
+ ${SHELL} $(sdir_top)/mkinstalldirs $(DESTDIR)$(runhelpdir); \
+ $(INSTALL_DATA) $(sdir)/help/* $(DESTDIR)$(runhelpdir); \
+ while read from to; do \
+ rm -f $(DESTDIR)$(runhelpdir)/$$to || : ; \
+ $(LN_S) $$from $(DESTDIR)$(runhelpdir)/$$to; \
+ done < $(sdir)/help.txt; \
+ fi
+.PHONY: install.runhelp
+
# install info pages, creating install directory if necessary
install.info: texi
${SHELL} $(sdir_top)/mkinstalldirs $(DESTDIR)$(infodir)
@@ -334,6 +356,11 @@ uninstall.man:
done
.PHONY: uninstall.man
+# uninstall runhelp pages
+uninstall.runhelp:
+ test x"$(runhelpdir)" = x"" || rm -rf -- $(DESTDIR)$(runhelpdir)
+.PHONY: uninstall.runhelp
+
# uninstall info pages
uninstall.info:
rm -f $(DESTDIR)$(infodir)/$(tzsh).info
@@ -369,6 +396,7 @@ distclean-here: clean-here
realclean-here: distclean-here
cd $(sdir) && rm -f Zsh/modlist.yo Zsh/modmenu.yo Zsh/manmodmenu.yo
cd $(sdir) && rm -f version.yo ../META-FAQ zsh.texi $(MAN)
+ cd $(sdir) && rm -f help.txt help/*
.PHONY: realclean-here
@CLEAN_MK@
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 9d3fc7562..bb6613ece 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -3155,7 +3155,7 @@ sect(Mathematical Functions)
startitem()
findex(zcalc)
-item(tt(zcalc) [ var(expression) ... ])(
+item(tt(zcalc) [ tt(-ef) ] [ var(expression) ... ])(
A reasonably powerful calculator based on zsh's arithmetic evaluation
facility. The syntax is similar to that of formulae in most programming
languages; see
@@ -3195,6 +3195,10 @@ The output base can be initialised by passing the option `tt(-#)var(base)',
for example `tt(zcalc -#16)' (the `tt(#)' may have to be quoted, depending
on the globbing options set).
+If the option `tt(-e)' is set, the function runs non-interactively:
+the arguments are treated as expressions to be evaluated as if entered
+interactively line by line.
+
If the option `tt(-f)' is set, all numbers are treated as floating
point, hence for example the expression `tt(3/4)' evaluates to 0.75
rather than 0. Options must appear in separate words.
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index 614924bfb..2d7756859 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -373,7 +373,7 @@ xitem(tt(zle) tt(-R) [ tt(-c) ] [ var(display-string) ] [ var(string) ... ])
xitem(tt(zle) tt(-M) var(string))
xitem(tt(zle) tt(-U) var(string))
xitem(tt(zle) tt(-K) var(keymap))
-xitem(tt(zle) tt(-F) [ tt(-L) ] [ var(fd) [ var(handler) ] ])
+xitem(tt(zle) tt(-F) [ tt(-L) | tt(-w) ] [ var(fd) [ var(handler) ] ])
xitem(tt(zle) tt(-I))
xitem(tt(zle) tt(-T) [ tt(tc) var(function) | tt(-r) tt(tc) | tt(-L) ] )
item(tt(zle) var(widget) tt([ -n) var(num) tt(]) tt([ -Nw ] [ -K) var(keymap) tt(]) var(args) ...)(
@@ -487,7 +487,7 @@ This keymap selection affects the interpretation of following keystrokes
within this invocation of ZLE. Any following invocation (e.g., the next
command line) will start as usual with the `tt(main)' keymap selected.
)
-item(tt(-F) [ tt(-L) ] [ var(fd) [ var(handler) ] ])(
+item(tt(-F) [ tt(-L) | tt(-w) ] [ var(fd) [ var(handler) ] ])(
Only available if your system supports one of the `poll' or `select' system
calls; most modern systems do.
@@ -502,6 +502,13 @@ Note that zle makes no attempt to check whether this fd is actually
readable when installing the handler. The user must make their own
arrangements for handling the file descriptor when zle is not active.
+If the option tt(-w) is also given, the var(handler) is instead a
+line editor widget, typically a shell function made into a widget using
+tt(zle -N). In that case var(handler) can use all the facilities of
+zle to update the current editing line. Note, however, that as handling
+var(fd) takes place at a low level changes to the display will not
+automatically appear; the widget should call tt(zle -R) to force redisplay.
+
Any number of handlers for any number of readable file descriptors may be
installed. Installing a handler for an var(fd) which is already handled
causes the existing handler to be replaced.
diff --git a/Doc/help/.cvsignore b/Doc/help/.cvsignore
new file mode 100644
index 000000000..0751b2579
--- /dev/null
+++ b/Doc/help/.cvsignore
@@ -0,0 +1 @@
+[_a-zA-Z0-9]*
diff --git a/Doc/help/.distfiles b/Doc/help/.distfiles
new file mode 100644
index 000000000..60962adf4
--- /dev/null
+++ b/Doc/help/.distfiles
@@ -0,0 +1,5 @@
+DISTFILES_SRC='
+ .cvsignore
+ .distfiles
+ [_a-zA-Z0-9]*
+'