summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2001-06-28 17:02:57 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2001-06-28 17:02:57 +0000
commit6ee1839f207eb681622d85522ace722feb96a200 (patch)
tree6aaa74af393603a24af6da7db392b1fd6cb0ef3d
parenta25c40c6a06425d99b4816c62ccb33cfa76cd397 (diff)
downloadzsh-6ee1839f207eb681622d85522ace722feb96a200.tar.gz
zsh-6ee1839f207eb681622d85522ace722feb96a200.zip
15160, 15169: Doc formatting changes for texinfo and .html files
-rw-r--r--Doc/Makefile.in6
-rw-r--r--Doc/Zsh/manual.yo4
-rw-r--r--Doc/zman.yo14
-rw-r--r--Doc/ztexi.yo5
-rw-r--r--README3
5 files changed, 24 insertions, 8 deletions
diff --git a/Doc/Makefile.in b/Doc/Makefile.in
index 57b77b59e..cc2fbab38 100644
--- a/Doc/Makefile.in
+++ b/Doc/Makefile.in
@@ -40,7 +40,7 @@ INSTALL = @INSTALL@
MAKEINFO = makeinfo
TEXI2DVI = texi2dvi
DVIPS = dvips
-TEXI2HTML = texi2html -expandinfo -split_chapter
+TEXI2HTML = texi2html -expand info -split chapter
.SUFFIXES: .yo .1
@@ -297,14 +297,14 @@ uninstall.info:
# install HTML manual
install.html: html
${SHELL} $(sdir_top)/mkinstalldirs $(DESTDIR)$(htmldir)
- for file in zsh_*.html; do \
+ for file in zsh*.html; do \
$(INSTALL_DATA) $$file $(DESTDIR)$(htmldir) || exit 1; \
done
.PHONY: install.html
# uninstall HTML manual
uninstall.html:
- rm -f $(DESTDIR)$(htmldir)/zsh_*.html
+ rm -f $(DESTDIR)$(htmldir)/zsh*.html
.PHONY: uninstall.html
# ========== DEPENDENCIES FOR CLEANUP ==========
diff --git a/Doc/Zsh/manual.yo b/Doc/Zsh/manual.yo
index 761c5159c..b9284e728 100644
--- a/Doc/Zsh/manual.yo
+++ b/Doc/Zsh/manual.yo
@@ -1,6 +1,8 @@
-texiifinfo(\
+texiifnottex(\
texinode(Top)(The Z Shell Manual)((dir))((dir))
texitop(The Z Shell Manual)
+)\
+texiifinfo(\
This Info file documents Zsh, a freely available UNIX command interpreter
(shell), which of the standard shells most closely resembles the Korn shell
(ksh), although it is not completely compatible.
diff --git a/Doc/zman.yo b/Doc/zman.yo
index 7d7fc120e..468decd6b 100644
--- a/Doc/zman.yo
+++ b/Doc/zman.yo
@@ -46,6 +46,7 @@ def(texinfo)(2)(CMT())
def(texiifinfo)(1)()
def(texiiftex)(1)()
+def(texiifnottex)(1)()
def(texipage)(0)(CMT())
def(texititlepage)(0)(CMT())
@@ -61,8 +62,9 @@ COMMENT(--- section divisions ---)
def(chapter)(1)(CMT())
+COMMENT(--- the "" works around a yodl bug ---)
def(sect)(1)(\
- NOTRANS(.SH ")UPPERCASE(ARG1)(0)"NL()\
+ NOTRANS(.SH )UPPERCASE(ARG1)(0)""NL()\
STDPAR()\
CMT()\
)
@@ -162,6 +164,12 @@ def(itemiz)(1)(\
COMMENT(--- special effects ---)
+def(example)(1)(\
+ NOTRANS(.RS)NL()NOTRANS(.nf)NL()\
+ NOTRANS(\fB)ARG1NOTRANS(\fP)\
+ NL()NOTRANS(.fi)NL()NOTRANS(.RE)\
+)
+
def(nofill)(1)(\
NOTRANS(.nf)NL()\
ARG1\
@@ -169,9 +177,9 @@ def(nofill)(1)(\
)
def(indent)(1)(\
- NOTRANS(.RS)\
+ NOTRANS(.RS)NL()NOTRANS(.nf)NL()\
ARG1\
- NOTRANS(.RE)\
+ NL()NOTRANS(.fi)NL()NOTRANS(.RE)\
)
COMMENT(--- hyperlink menus ---)
diff --git a/Doc/ztexi.yo b/Doc/ztexi.yo
index a89605ff9..efb1d5e15 100644
--- a/Doc/ztexi.yo
+++ b/Doc/ztexi.yo
@@ -81,6 +81,11 @@ def(texiiftex)(1)(\
ARG1\
NOTRANS(@end iftex)NL()\
)
+def(texiifnottex)(1)(\
+ NOTRANS(@ifnottex)NL()\
+ ARG1\
+ NOTRANS(@end ifnottex)NL()\
+)
def(texipage)(0)(\
NOTRANS(@page)\
diff --git a/README b/README
index a5bfeac9b..dfe1a2b00 100644
--- a/README
+++ b/README
@@ -81,7 +81,8 @@ Doc/zsh.texi Everything the man pages have, but in texinfo format. These
By default, these will be installed in /usr/local/info,
although you can change this with the --infodir option to
configure or editing the user configuration section of the
- top level Makefile.
+ top level Makefile. Version 4.0 or above of the
+ Texinfo tools are recommended for processing this file.
Also include in the distribution are: